SearchResultVendor resource

Methods

  • get - Search vendors

Resource

{
    "limit": "int32",
    "skip": "int32",
    "total": "int64",
    "values": [
        {
            "accountOwnerId": "string",
            "active": "boolean",
            "additionalAddressList": [
                {
                    "address": "string",
                    "addressLine2": "string",
                    "city": "string",
                    "companyId": "string",
                    "country": "string",
                    "created": "int64",
                    "deleted": "boolean",
                    "id": "string",
                    "latitude": "number",
                    "longitude": "number",
                    "modified": "int64",
                    "state": "string",
                    "updated": "boolean",
                    "zipCode": "string"
                }
            ],
            "address": {
                "address": "string",
                "addressLine2": "string",
                "city": "string",
                "companyId": "string",
                "country": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "latitude": "number",
                "longitude": "number",
                "modified": "int64",
                "state": "string",
                "updated": "boolean",
                "zipCode": "string"
            },
            "armsLengthType": "string",
            "assets": [
                {
                    "active": "boolean",
                    "assetType": "string",
                    "companyId": "string",
                    "created": "int64",
                    "deleted": "boolean",
                    "id": "string",
                    "key": "string",
                    "largeURL": "string",
                    "largeX2URL": "string",
                    "mediumURL": "string",
                    "modified": "int64",
                    "name": "string",
                    "origURL": "string",
                    "priority": "int32",
                    "publicURL": "string",
                    "secured": "boolean",
                    "thumbURL": "string",
                    "type": "string",
                    "updated": "boolean"
                }
            ],
            "backOrderEnabled": "boolean",
            "brands": [
                "string"
            ],
            "companyId": "string",
            "companyLicenses": [
                {
                    "companyType": "string",
                    "created": "int64",
                    "deleted": "boolean",
                    "id": "string",
                    "licenseExpirationDate": "int64",
                    "licenseNumber": "string",
                    "licenseType": "string",
                    "modified": "int64",
                    "toDefault": "boolean",
                    "updated": "boolean"
                }
            ],
            "companyType": "string",
            "connectedShop": "string",
            "contactPerson": "string",
            "created": "int64",
            "createdBy": "string",
            "credits": "number",
            "dbaName": "string",
            "defaultContactId": "string",
            "defaultPaymentTerm": "string",
            "deleted": "boolean",
            "description": "string",
            "email": "string",
            "externalId": "string",
            "fax": "string",
            "firstName": "string",
            "id": "string",
            "importId": "string",
            "lastName": "string",
            "licenceType": "string",
            "licenseExpirationDate": "int64",
            "licenseNumber": "string",
            "mobileNumber": "string",
            "modified": "int64",
            "name": "string",
            "notes": [
                {
                    "created": "int64",
                    "deleted": "boolean",
                    "enableOnFleet": "boolean",
                    "id": "string",
                    "message": "string",
                    "modified": "int64",
                    "updated": "boolean",
                    "writerId": "string",
                    "writerName": "string"
                }
            ],
            "phone": "string",
            "qbVendorRef": [
                {
                    "<key>": "string"
                }
            ],
            "relatedEntity": "boolean",
            "salesPerson": "string",
            "toDefault": "boolean",
            "updated": "boolean",
            "vendorKey": "string",
            "vendorType": "string",
            "website": "string"
        }
    ]
}

Properties

Name Type Description Additional
limit int32 Optional
skip int32 Optional
total int64 Optional
values[] array Optional
values[].accountOwnerId string Optional
values[].active boolean Optional
values[].additionalAddressList[] array Optional
values[].additionalAddressList[].address string Optional
values[].additionalAddressList[].addressLine2 string Optional
values[].additionalAddressList[].city string Optional
values[].additionalAddressList[].companyId string Optional
values[].additionalAddressList[].country string Optional
values[].additionalAddressList[].created int64 Optional
values[].additionalAddressList[].deleted boolean Optional
values[].additionalAddressList[].id string Optional
values[].additionalAddressList[].latitude number Optional
values[].additionalAddressList[].longitude number Optional
values[].additionalAddressList[].modified int64 Optional
values[].additionalAddressList[].state string Optional
values[].additionalAddressList[].updated boolean Optional
values[].additionalAddressList[].zipCode string Optional
values[].address object Address Optional
values[].address.address string Optional
values[].address.addressLine2 string Optional
values[].address.city string Optional
values[].address.companyId string Optional
values[].address.country string Optional
values[].address.created int64 Optional
values[].address.deleted boolean Optional
values[].address.id string Optional
values[].address.latitude number Optional
values[].address.longitude number Optional
values[].address.modified int64 Optional
values[].address.state string Optional
values[].address.updated boolean Optional
values[].address.zipCode string Optional
values[].armsLengthType string

Possible values are:

  • ARMS_LENGTH
  • NON_ARMS_LENGTH
 Optional
values[].assets[] array Optional
values[].assets[].active boolean Optional
values[].assets[].assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
values[].assets[].companyId string Optional
values[].assets[].created int64 Optional
values[].assets[].deleted boolean Optional
values[].assets[].id string Optional
values[].assets[].key string Optional
values[].assets[].largeURL string Optional
values[].assets[].largeX2URL string Optional
values[].assets[].mediumURL string Optional
values[].assets[].modified int64 Optional
values[].assets[].name string Optional
values[].assets[].origURL string Optional
values[].assets[].priority int32 Optional
values[].assets[].publicURL string Optional
values[].assets[].secured boolean Optional
values[].assets[].thumbURL string Optional
values[].assets[].type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
values[].assets[].updated boolean Optional
values[].backOrderEnabled boolean Optional
values[].brands[] array of string Optional
values[].companyId string Optional
values[].companyLicenses[] array Optional
values[].companyLicenses[].companyType string

Possible values are:

  • DISTRIBUTOR
  • CULTIVATOR
  • RETAILER
  • MANUFACTURER
  • TRANSPORTER
  • OTHER
  • TESTING_FACILITY
 Optional
values[].companyLicenses[].created int64 Optional
values[].companyLicenses[].deleted boolean Optional
values[].companyLicenses[].id string Optional
values[].companyLicenses[].licenseExpirationDate int64 Optional
values[].companyLicenses[].licenseNumber string Optional
values[].companyLicenses[].licenseType string

Possible values are:

  • RECREATIONAL
  • MEDICINAL
  • BOTH
 Optional
values[].companyLicenses[].modified int64 Optional
values[].companyLicenses[].toDefault boolean Optional
values[].companyLicenses[].updated boolean Optional
values[].companyType string

Possible values are:

  • DISTRIBUTOR
  • CULTIVATOR
  • RETAILER
  • MANUFACTURER
  • TRANSPORTER
  • OTHER
  • TESTING_FACILITY
 Optional
values[].connectedShop string Optional
values[].contactPerson string Optional
values[].created int64 Optional
values[].createdBy string Optional
values[].credits number Optional
values[].dbaName string Optional
values[].defaultContactId string Optional
values[].defaultPaymentTerm string Optional
values[].deleted boolean Optional
values[].description string Optional
values[].email string Optional
values[].externalId string Optional
values[].fax string Optional
values[].firstName string Optional
values[].id string Optional
values[].importId string Optional
values[].lastName string Optional
values[].licenceType string

Possible values are:

  • RECREATIONAL
  • MEDICINAL
  • BOTH
 Optional
values[].licenseExpirationDate int64 Optional
values[].licenseNumber string Optional
values[].mobileNumber string Optional
values[].modified int64 Optional
values[].name string Optional
values[].notes[] array Optional
values[].notes[].created int64 Optional
values[].notes[].deleted boolean Optional
values[].notes[].enableOnFleet boolean Optional
values[].notes[].id string Optional
values[].notes[].message string Optional
values[].notes[].modified int64 Optional
values[].notes[].updated boolean Optional
values[].notes[].writerId string Optional
values[].notes[].writerName string Optional
values[].phone string Optional
values[].qbVendorRef[] array of object Optional
values[].qbVendorRef[].<key> map of string Optional
values[].relatedEntity boolean Optional
values[].salesPerson string Optional
values[].toDefault boolean Optional
values[].updated boolean Optional
values[].vendorKey string Optional, read only.
values[].vendorType string

Possible values are:

  • CUSTOMER
  • VENDOR
  • BOTH
 Optional
values[].website string Optional