Vendors

Manage vendor records for supply chain management.

Base URL: /api/v1/partner/vendors

Endpoints Overview

Method	Endpoint	Description
GET	`/{vendorId}`	Get vendor by id
GET	`/`	Search vendors
POST	`/`	Create Vendor
PUT	`/{vendorId}`	Update Vendor

Get vendor by id

GET /api/v1/partner/vendors/{vendorId}

Retrieve a single vendor by ID, including the vendor's associated brand list.

Path Parameters

Parameter	Type	Description
`vendorId`	string	The vendor i d

Response

Returns a VendorResult object.

Fields
JSON

Field	Type	Required	Description
`id`	string	No	Unique identifier
`companyId`	string	No	Company identifier
`created`	long	No	Created timestamp (epoch ms)
`modified`	long	No	Last modified timestamp (epoch ms)
`deleted`	boolean	No	Whether the record is deleted
`updated`	boolean	No	Whether the record has been updated
`importId`	string	No	Import identifier
`active`	boolean	No	Whether active (default: `true`)
`name`	string	Yes	Name
`phone`	string	No	Phone number
`email`	string	No	Email address
`fax`	string	No	Fax
`address`	Address	No	Address
`description`	string	No	Description
`website`	string	No	Website URL
`firstName`	string	No	First name
`lastName`	string	No	Last name
`notes`	Note[]	No	Notes
`licenseNumber`	string	No	License Number
`assets`	CompanyAsset[]	No	Assets
`backOrderEnabled`	boolean	No	Back Order Enabled (default: `false`)
`licenseExpirationDate`	long	No	License Expiration timestamp (epoch ms)
`armsLengthType`	string	No	Arms Length Type. One of: `ARMS_LENGTH`, `NON_ARMS_LENGTH` (default: `NON_ARMS_LENGTH`)
`brands`	string[]	No	Brands
`additionalAddressList`	Address[]	No	Additional Address List
`credits`	number	No	Credits
`mobileNumber`	string	No	Mobile number
`relatedEntity`	boolean	No	Related Entity
`vendorType`	string	No	Vendor Type. One of: `CUSTOMER`, `VENDOR`, `BOTH` (default: `VENDOR`)
`dbaName`	string	No	Dba Name
`companyLicenses`	CompanyLicense[]	No	Company Licenses
`createdBy`	string	No	Created By
`accountOwnerId`	string	No	Account Owner identifier
`defaultPaymentTerm`	string	No	Default Payment Term
`salesPerson`	string	No	Sales Person
`contactPerson`	string	No	Contact Person
`defaultContactId`	string	No	Default Contact identifier
`externalId`	string	No	External system identifier
`toDefault`	boolean	No	To Default
`connectedShop`	string	No	Connected Shop
`isGiftCard`	boolean	No	Is Gift Card
`platformVendorId`	string	No	Platform Vendor identifier
`brandList`	Brand[]	No	Brand List

{
  "id": "abc123",
  "companyId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "importId": "abc123",
  "active": true,
  "name": "string",
  "phone": "555-0100",
  "email": "user@example.com",
  "fax": "string",
  "address": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "address": "",
    "city": "",
    "state": "",
    "zipCode": "",
    "addressLine2": "",
    "country": "DEFAULT_COUNTRY",
    "latitude": 0,
    "longitude": 0
  },
  "description": "string",
  "website": "https://example.com",
  "firstName": "John",
  "lastName": "Doe",
  "notes": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "writerId": "abc123",
      "writerName": "string",
      "message": "string",
      "enableOnFleet": false
    }
  ],
  "licenseNumber": "string",
  "assets": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "name": "string",
      "key": "string",
      "type": {},
      "publicURL": "string",
      "active": false,
      "priority": 0,
      "secured": true,
      "thumbURL": "string",
      "mediumURL": "string",
      "largeURL": "string",
      "largeX2URL": "string",
      "origURL": "string",
      "platformFileUrl": "string"
    }
  ],
  "backOrderEnabled": false,
  "licenseExpirationDate": 1704067200000,
  "armsLengthType": "NON_ARMS_LENGTH",
  "brands": [],
  "additionalAddressList": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "address": "",
      "city": "",
      "state": "",
      "zipCode": "",
      "addressLine2": "",
      "country": "DEFAULT_COUNTRY",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "credits": 0,
  "mobileNumber": "555-0100",
  "relatedEntity": false,
  "vendorType": "VENDOR",
  "dbaName": "string",
  "companyLicenses": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "licenseNumber": "string",
      "licenseExpirationDate": 1704067200000,
      "toDefault": false
    }
  ],
  "createdBy": "string",
  "accountOwnerId": "abc123",
  "defaultPaymentTerm": "string",
  "salesPerson": "string",
  "contactPerson": "string",
  "defaultContactId": "abc123",
  "externalId": "abc123",
  "toDefault": false,
  "connectedShop": "string",
  "isGiftCard": false,
  "platformVendorId": "abc123",
  "brandList": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "name": "string",
      "active": false,
      "website": "https://example.com",
      "phoneNo": "555-0100",
      "brandLogo": {},
      "vendorList": [],
      "isDefault": false,
      "externalId": "abc123",
      "platformBrandId": "abc123",
      "globalBrandId": "abc123",
      "leadTime": 1704067200000,
      "minDaysOnHand": 0,
      "maxDaysOnHand": 0
    }
  ]
}

Search vendors

GET /api/v1/partner/vendors

Retrieve a paginated list of vendors. Supports optional startDate and endDate filters and pagination with skip and limit.

Query Parameters

Parameter	Type	Required	Description
`startDate`	string	No	Start date filter
`endDate`	string	No	End date filter
`skip`	integer	No	Number of records to skip
`limit`	integer	No	Maximum records to return

Response

Returns a paginated SearchResult of Vendor objects.

Fields
JSON

Field	Type	Required	Description
`id`	string	No	Unique identifier
`companyId`	string	No	Company identifier
`created`	long	No	Created timestamp (epoch ms)
`modified`	long	No	Last modified timestamp (epoch ms)
`deleted`	boolean	No	Whether the record is deleted
`updated`	boolean	No	Whether the record has been updated
`importId`	string	No	Import identifier
`active`	boolean	No	Whether active (default: `true`)
`name`	string	Yes	Name
`phone`	string	No	Phone number
`email`	string	No	Email address
`fax`	string	No	Fax
`address`	Address	No	Address
`description`	string	No	Description
`website`	string	No	Website URL
`firstName`	string	No	First name
`lastName`	string	No	Last name
`notes`	Note[]	No	Notes
`licenseNumber`	string	No	License Number
`assets`	CompanyAsset[]	No	Assets
`backOrderEnabled`	boolean	No	Back Order Enabled (default: `false`)
`licenseExpirationDate`	long	No	License Expiration timestamp (epoch ms)
`armsLengthType`	string	No	Arms Length Type. One of: `ARMS_LENGTH`, `NON_ARMS_LENGTH` (default: `NON_ARMS_LENGTH`)
`brands`	string[]	No	Brands
`additionalAddressList`	Address[]	No	Additional Address List
`credits`	number	No	Credits
`mobileNumber`	string	No	Mobile number
`relatedEntity`	boolean	No	Related Entity
`vendorType`	string	No	Vendor Type. One of: `CUSTOMER`, `VENDOR`, `BOTH` (default: `VENDOR`)
`dbaName`	string	No	Dba Name
`companyLicenses`	CompanyLicense[]	No	Company Licenses
`createdBy`	string	No	Created By
`accountOwnerId`	string	No	Account Owner identifier
`defaultPaymentTerm`	string	No	Default Payment Term
`salesPerson`	string	No	Sales Person
`contactPerson`	string	No	Contact Person
`defaultContactId`	string	No	Default Contact identifier
`externalId`	string	No	External system identifier
`toDefault`	boolean	No	To Default
`connectedShop`	string	No	Connected Shop
`isGiftCard`	boolean	No	Is Gift Card
`platformVendorId`	string	No	Platform Vendor identifier

{
  "id": "abc123",
  "companyId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "importId": "abc123",
  "active": true,
  "name": "string",
  "phone": "555-0100",
  "email": "user@example.com",
  "fax": "string",
  "address": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "address": "",
    "city": "",
    "state": "",
    "zipCode": "",
    "addressLine2": "",
    "country": "DEFAULT_COUNTRY",
    "latitude": 0,
    "longitude": 0
  },
  "description": "string",
  "website": "https://example.com",
  "firstName": "John",
  "lastName": "Doe",
  "notes": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "writerId": "abc123",
      "writerName": "string",
      "message": "string",
      "enableOnFleet": false
    }
  ],
  "licenseNumber": "string",
  "assets": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "name": "string",
      "key": "string",
      "type": {},
      "publicURL": "string",
      "active": false,
      "priority": 0,
      "secured": true,
      "thumbURL": "string",
      "mediumURL": "string",
      "largeURL": "string",
      "largeX2URL": "string",
      "origURL": "string",
      "platformFileUrl": "string"
    }
  ],
  "backOrderEnabled": false,
  "licenseExpirationDate": 1704067200000,
  "armsLengthType": "NON_ARMS_LENGTH",
  "brands": [],
  "additionalAddressList": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "address": "",
      "city": "",
      "state": "",
      "zipCode": "",
      "addressLine2": "",
      "country": "DEFAULT_COUNTRY",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "credits": 0,
  "mobileNumber": "555-0100",
  "relatedEntity": false,
  "vendorType": "VENDOR",
  "dbaName": "string",
  "companyLicenses": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "licenseNumber": "string",
      "licenseExpirationDate": 1704067200000,
      "toDefault": false
    }
  ],
  "createdBy": "string",
  "accountOwnerId": "abc123",
  "defaultPaymentTerm": "string",
  "salesPerson": "string",
  "contactPerson": "string",
  "defaultContactId": "abc123",
  "externalId": "abc123",
  "toDefault": false,
  "connectedShop": "string",
  "isGiftCard": false,
  "platformVendorId": "abc123"
}

Create Vendor

POST /api/v1/partner/vendors

Create a new vendor. The name field is required. Optionally provide employeeId to attribute the creation to a specific employee for audit purposes.

Request Body

Fields
JSON

Field	Type	Required	Description
`importId`	string	No	Import identifier
`active`	boolean	No	Whether active
`name`	string	Yes	Name
`medical`	boolean	No	Medical
`phone`	string	No	Phone number
`email`	string	No	Email address
`website`	string	No	Website URL
`fax`	string	No	Fax
`address`	Address	No	Address
`description`	string	No	Description
`contactFirstName`	string	No	Contact First Name
`contactLastName`	string	No	Contact Last Name
`licenseNumber`	string	No	License Number
`firstName`	string	No	First name
`lastName`	string	No	Last name
`assets`	CompanyAsset[]	No	Assets
`licenseExpirationDate`	long	No	License Expiration timestamp (epoch ms)
`brands`	string[]	No	Brands
`additionalAddressList`	Address[]	No	Additional Address List
`relatedEntity`	boolean	No	Related Entity
`mobileNumber`	string	No	Mobile number
`notes`	Note[]	No	Notes
`dbaName`	string	No	Dba Name
`companyLicenses`	CompanyLicense[]	No	Company Licenses
`employeeId`	string	No	Employee identifier
`accountOwnerId`	string	No	Account Owner identifier
`defaultPaymentTerm`	string	No	Default Payment Term
`externalId`	string	No	External system identifier
`salesPerson`	string	No	Sales Person
`contactPerson`	string	No	Contact Person
`defaultContactId`	string	No	Default Contact identifier
`connectedShop`	string	No	Connected Shop
`backOrderEnabled`	boolean	No	Back Order Enabled (default: `false`)
`platformVendorId`	string	No	Platform Vendor identifier

{
  "importId": "abc123",
  "active": false,
  "name": "string",
  "medical": false,
  "phone": "555-0100",
  "email": "user@example.com",
  "website": "https://example.com",
  "fax": "string",
  "address": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "address": "",
    "city": "",
    "state": "",
    "zipCode": "",
    "addressLine2": "",
    "country": "DEFAULT_COUNTRY",
    "latitude": 0,
    "longitude": 0
  },
  "description": "string",
  "contactFirstName": "string",
  "contactLastName": "string",
  "licenseNumber": "string",
  "firstName": "John",
  "lastName": "Doe",
  "assets": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "name": "string",
      "key": "string",
      "type": {},
      "publicURL": "string",
      "active": false,
      "priority": 0,
      "secured": true,
      "thumbURL": "string",
      "mediumURL": "string",
      "largeURL": "string",
      "largeX2URL": "string",
      "origURL": "string",
      "platformFileUrl": "string"
    }
  ],
  "licenseExpirationDate": 1704067200000,
  "brands": [],
  "additionalAddressList": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "address": "",
      "city": "",
      "state": "",
      "zipCode": "",
      "addressLine2": "",
      "country": "DEFAULT_COUNTRY",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "relatedEntity": false,
  "mobileNumber": "555-0100",
  "notes": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "writerId": "abc123",
      "writerName": "string",
      "message": "string",
      "enableOnFleet": false
    }
  ],
  "dbaName": "string",
  "companyLicenses": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "licenseNumber": "string",
      "licenseExpirationDate": 1704067200000,
      "toDefault": false
    }
  ],
  "employeeId": "abc123",
  "accountOwnerId": "abc123",
  "defaultPaymentTerm": "string",
  "externalId": "abc123",
  "salesPerson": "string",
  "contactPerson": "string",
  "defaultContactId": "abc123",
  "connectedShop": "string",
  "backOrderEnabled": false,
  "platformVendorId": "abc123"
}

Response

Returns a Vendor object.

Fields
JSON

Field	Type	Required	Description
`id`	string	No	Unique identifier
`companyId`	string	No	Company identifier
`created`	long	No	Created timestamp (epoch ms)
`modified`	long	No	Last modified timestamp (epoch ms)
`deleted`	boolean	No	Whether the record is deleted
`updated`	boolean	No	Whether the record has been updated
`importId`	string	No	Import identifier
`active`	boolean	No	Whether active (default: `true`)
`name`	string	Yes	Name
`phone`	string	No	Phone number
`email`	string	No	Email address
`fax`	string	No	Fax
`address`	Address	No	Address
`description`	string	No	Description
`website`	string	No	Website URL
`firstName`	string	No	First name
`lastName`	string	No	Last name
`notes`	Note[]	No	Notes
`licenseNumber`	string	No	License Number
`assets`	CompanyAsset[]	No	Assets
`backOrderEnabled`	boolean	No	Back Order Enabled (default: `false`)
`licenseExpirationDate`	long	No	License Expiration timestamp (epoch ms)
`armsLengthType`	string	No	Arms Length Type. One of: `ARMS_LENGTH`, `NON_ARMS_LENGTH` (default: `NON_ARMS_LENGTH`)
`brands`	string[]	No	Brands
`additionalAddressList`	Address[]	No	Additional Address List
`credits`	number	No	Credits
`mobileNumber`	string	No	Mobile number
`relatedEntity`	boolean	No	Related Entity
`vendorType`	string	No	Vendor Type. One of: `CUSTOMER`, `VENDOR`, `BOTH` (default: `VENDOR`)
`dbaName`	string	No	Dba Name
`companyLicenses`	CompanyLicense[]	No	Company Licenses
`createdBy`	string	No	Created By
`accountOwnerId`	string	No	Account Owner identifier
`defaultPaymentTerm`	string	No	Default Payment Term
`salesPerson`	string	No	Sales Person
`contactPerson`	string	No	Contact Person
`defaultContactId`	string	No	Default Contact identifier
`externalId`	string	No	External system identifier
`toDefault`	boolean	No	To Default
`connectedShop`	string	No	Connected Shop
`isGiftCard`	boolean	No	Is Gift Card
`platformVendorId`	string	No	Platform Vendor identifier

{
  "id": "abc123",
  "companyId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "importId": "abc123",
  "active": true,
  "name": "string",
  "phone": "555-0100",
  "email": "user@example.com",
  "fax": "string",
  "address": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "address": "",
    "city": "",
    "state": "",
    "zipCode": "",
    "addressLine2": "",
    "country": "DEFAULT_COUNTRY",
    "latitude": 0,
    "longitude": 0
  },
  "description": "string",
  "website": "https://example.com",
  "firstName": "John",
  "lastName": "Doe",
  "notes": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "writerId": "abc123",
      "writerName": "string",
      "message": "string",
      "enableOnFleet": false
    }
  ],
  "licenseNumber": "string",
  "assets": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "name": "string",
      "key": "string",
      "type": {},
      "publicURL": "string",
      "active": false,
      "priority": 0,
      "secured": true,
      "thumbURL": "string",
      "mediumURL": "string",
      "largeURL": "string",
      "largeX2URL": "string",
      "origURL": "string",
      "platformFileUrl": "string"
    }
  ],
  "backOrderEnabled": false,
  "licenseExpirationDate": 1704067200000,
  "armsLengthType": "NON_ARMS_LENGTH",
  "brands": [],
  "additionalAddressList": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "address": "",
      "city": "",
      "state": "",
      "zipCode": "",
      "addressLine2": "",
      "country": "DEFAULT_COUNTRY",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "credits": 0,
  "mobileNumber": "555-0100",
  "relatedEntity": false,
  "vendorType": "VENDOR",
  "dbaName": "string",
  "companyLicenses": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "licenseNumber": "string",
      "licenseExpirationDate": 1704067200000,
      "toDefault": false
    }
  ],
  "createdBy": "string",
  "accountOwnerId": "abc123",
  "defaultPaymentTerm": "string",
  "salesPerson": "string",
  "contactPerson": "string",
  "defaultContactId": "abc123",
  "externalId": "abc123",
  "toDefault": false,
  "connectedShop": "string",
  "isGiftCard": false,
  "platformVendorId": "abc123"
}

Update Vendor

PUT /api/v1/partner/vendors/{vendorId}

Update an existing vendor by ID. Send the full vendor object in the request body. Optionally include employeeId for audit attribution.

Path Parameters

Parameter	Type	Description
`vendorId`	string	The vendor i d

Request Body

Fields
JSON

Field	Type	Required	Description
`id`	string	No	Unique identifier
`companyId`	string	No	Company identifier
`created`	long	No	Created timestamp (epoch ms)
`modified`	long	No	Last modified timestamp (epoch ms)
`deleted`	boolean	No	Whether the record is deleted
`updated`	boolean	No	Whether the record has been updated
`importId`	string	No	Import identifier
`active`	boolean	No	Whether active (default: `true`)
`name`	string	Yes	Name
`phone`	string	No	Phone number
`email`	string	No	Email address
`fax`	string	No	Fax
`address`	Address	No	Address
`description`	string	No	Description
`website`	string	No	Website URL
`firstName`	string	No	First name
`lastName`	string	No	Last name
`notes`	Note[]	No	Notes
`licenseNumber`	string	No	License Number
`assets`	CompanyAsset[]	No	Assets
`backOrderEnabled`	boolean	No	Back Order Enabled (default: `false`)
`licenseExpirationDate`	long	No	License Expiration timestamp (epoch ms)
`armsLengthType`	string	No	Arms Length Type. One of: `ARMS_LENGTH`, `NON_ARMS_LENGTH` (default: `NON_ARMS_LENGTH`)
`brands`	string[]	No	Brands
`additionalAddressList`	Address[]	No	Additional Address List
`credits`	number	No	Credits
`mobileNumber`	string	No	Mobile number
`relatedEntity`	boolean	No	Related Entity
`vendorType`	string	No	Vendor Type. One of: `CUSTOMER`, `VENDOR`, `BOTH` (default: `VENDOR`)
`dbaName`	string	No	Dba Name
`companyLicenses`	CompanyLicense[]	No	Company Licenses
`createdBy`	string	No	Created By
`accountOwnerId`	string	No	Account Owner identifier
`defaultPaymentTerm`	string	No	Default Payment Term
`salesPerson`	string	No	Sales Person
`contactPerson`	string	No	Contact Person
`defaultContactId`	string	No	Default Contact identifier
`externalId`	string	No	External system identifier
`toDefault`	boolean	No	To Default
`connectedShop`	string	No	Connected Shop
`isGiftCard`	boolean	No	Is Gift Card
`platformVendorId`	string	No	Platform Vendor identifier
`employeeId`	string	No	Employee identifier

{
  "id": "abc123",
  "companyId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "importId": "abc123",
  "active": true,
  "name": "string",
  "phone": "555-0100",
  "email": "user@example.com",
  "fax": "string",
  "address": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "address": "",
    "city": "",
    "state": "",
    "zipCode": "",
    "addressLine2": "",
    "country": "DEFAULT_COUNTRY",
    "latitude": 0,
    "longitude": 0
  },
  "description": "string",
  "website": "https://example.com",
  "firstName": "John",
  "lastName": "Doe",
  "notes": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "writerId": "abc123",
      "writerName": "string",
      "message": "string",
      "enableOnFleet": false
    }
  ],
  "licenseNumber": "string",
  "assets": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "name": "string",
      "key": "string",
      "type": {},
      "publicURL": "string",
      "active": false,
      "priority": 0,
      "secured": true,
      "thumbURL": "string",
      "mediumURL": "string",
      "largeURL": "string",
      "largeX2URL": "string",
      "origURL": "string",
      "platformFileUrl": "string"
    }
  ],
  "backOrderEnabled": false,
  "licenseExpirationDate": 1704067200000,
  "armsLengthType": "NON_ARMS_LENGTH",
  "brands": [],
  "additionalAddressList": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "address": "",
      "city": "",
      "state": "",
      "zipCode": "",
      "addressLine2": "",
      "country": "DEFAULT_COUNTRY",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "credits": 0,
  "mobileNumber": "555-0100",
  "relatedEntity": false,
  "vendorType": "VENDOR",
  "dbaName": "string",
  "companyLicenses": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "licenseNumber": "string",
      "licenseExpirationDate": 1704067200000,
      "toDefault": false
    }
  ],
  "createdBy": "string",
  "accountOwnerId": "abc123",
  "defaultPaymentTerm": "string",
  "salesPerson": "string",
  "contactPerson": "string",
  "defaultContactId": "abc123",
  "externalId": "abc123",
  "toDefault": false,
  "connectedShop": "string",
  "isGiftCard": false,
  "platformVendorId": "abc123",
  "employeeId": "abc123"
}

Response

Returns a Vendor object.

Fields
JSON

Field	Type	Required	Description
`id`	string	No	Unique identifier
`companyId`	string	No	Company identifier
`created`	long	No	Created timestamp (epoch ms)
`modified`	long	No	Last modified timestamp (epoch ms)
`deleted`	boolean	No	Whether the record is deleted
`updated`	boolean	No	Whether the record has been updated
`importId`	string	No	Import identifier
`active`	boolean	No	Whether active (default: `true`)
`name`	string	Yes	Name
`phone`	string	No	Phone number
`email`	string	No	Email address
`fax`	string	No	Fax
`address`	Address	No	Address
`description`	string	No	Description
`website`	string	No	Website URL
`firstName`	string	No	First name
`lastName`	string	No	Last name
`notes`	Note[]	No	Notes
`licenseNumber`	string	No	License Number
`assets`	CompanyAsset[]	No	Assets
`backOrderEnabled`	boolean	No	Back Order Enabled (default: `false`)
`licenseExpirationDate`	long	No	License Expiration timestamp (epoch ms)
`armsLengthType`	string	No	Arms Length Type. One of: `ARMS_LENGTH`, `NON_ARMS_LENGTH` (default: `NON_ARMS_LENGTH`)
`brands`	string[]	No	Brands
`additionalAddressList`	Address[]	No	Additional Address List
`credits`	number	No	Credits
`mobileNumber`	string	No	Mobile number
`relatedEntity`	boolean	No	Related Entity
`vendorType`	string	No	Vendor Type. One of: `CUSTOMER`, `VENDOR`, `BOTH` (default: `VENDOR`)
`dbaName`	string	No	Dba Name
`companyLicenses`	CompanyLicense[]	No	Company Licenses
`createdBy`	string	No	Created By
`accountOwnerId`	string	No	Account Owner identifier
`defaultPaymentTerm`	string	No	Default Payment Term
`salesPerson`	string	No	Sales Person
`contactPerson`	string	No	Contact Person
`defaultContactId`	string	No	Default Contact identifier
`externalId`	string	No	External system identifier
`toDefault`	boolean	No	To Default
`connectedShop`	string	No	Connected Shop
`isGiftCard`	boolean	No	Is Gift Card
`platformVendorId`	string	No	Platform Vendor identifier

{
  "id": "abc123",
  "companyId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "importId": "abc123",
  "active": true,
  "name": "string",
  "phone": "555-0100",
  "email": "user@example.com",
  "fax": "string",
  "address": {
    "id": "abc123",
    "companyId": "abc123",
    "created": 1704067200000,
    "modified": 1704067200000,
    "deleted": false,
    "updated": false,
    "address": "",
    "city": "",
    "state": "",
    "zipCode": "",
    "addressLine2": "",
    "country": "DEFAULT_COUNTRY",
    "latitude": 0,
    "longitude": 0
  },
  "description": "string",
  "website": "https://example.com",
  "firstName": "John",
  "lastName": "Doe",
  "notes": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "writerId": "abc123",
      "writerName": "string",
      "message": "string",
      "enableOnFleet": false
    }
  ],
  "licenseNumber": "string",
  "assets": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "name": "string",
      "key": "string",
      "type": {},
      "publicURL": "string",
      "active": false,
      "priority": 0,
      "secured": true,
      "thumbURL": "string",
      "mediumURL": "string",
      "largeURL": "string",
      "largeX2URL": "string",
      "origURL": "string",
      "platformFileUrl": "string"
    }
  ],
  "backOrderEnabled": false,
  "licenseExpirationDate": 1704067200000,
  "armsLengthType": "NON_ARMS_LENGTH",
  "brands": [],
  "additionalAddressList": [
    {
      "id": "abc123",
      "companyId": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "address": "",
      "city": "",
      "state": "",
      "zipCode": "",
      "addressLine2": "",
      "country": "DEFAULT_COUNTRY",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "credits": 0,
  "mobileNumber": "555-0100",
  "relatedEntity": false,
  "vendorType": "VENDOR",
  "dbaName": "string",
  "companyLicenses": [
    {
      "id": "abc123",
      "created": 1704067200000,
      "modified": 1704067200000,
      "deleted": false,
      "updated": false,
      "licenseNumber": "string",
      "licenseExpirationDate": 1704067200000,
      "toDefault": false
    }
  ],
  "createdBy": "string",
  "accountOwnerId": "abc123",
  "defaultPaymentTerm": "string",
  "salesPerson": "string",
  "contactPerson": "string",
  "defaultContactId": "abc123",
  "externalId": "abc123",
  "toDefault": false,
  "connectedShop": "string",
  "isGiftCard": false,
  "platformVendorId": "abc123"
}

Endpoints Overview​

Get vendor by id​

Path Parameters​

Response​

Search vendors​

Query Parameters​

Response​

Create Vendor​

Request Body​

Response​

Update Vendor​

Path Parameters​

Request Body​

Response​

Endpoints Overview

Get vendor by id

Path Parameters

Response

Search vendors

Query Parameters

Response

Create Vendor

Request Body

Response

Update Vendor

Path Parameters

Request Body

Response