API ReferenceSuppliers

Create Supplier

Creates a new supplier record for the business.

Requires scope: suppliers:write

Authentication

API_KEYstring
API Key authentication via header

Request

This endpoint expects an object.
businessNamestringRequired
Display name for the supplier business. Required. Maximum 255 characters.
businessEmailstringOptional
Primary email address. Maximum 255 characters.
contactNamestringOptional
Name of the primary contact person. Maximum 255 characters.
phoneNumberstringOptional
Primary phone number. Maximum 50 characters.
addressstringOptional
Street address. Maximum 500 characters.
citystringOptional
City. Maximum 255 characters.
statestringOptional
State or province code. Maximum 50 characters.
zipCodestringOptional

Postal/ZIP code. Maximum 20 characters.

websitestringOptional
Website URL. Maximum 500 characters.
notestringOptional
Internal notes about this supplier.

Response

This endpoint returns an object.
idUUID
Unique identifier for the supplier.
businessNamestring
Display name of the supplier business.
additionalContactslist of objects
Additional contacts at this supplier. Empty list if none configured.
businessEmailstring
Primary email address for the supplier business.
contactNamestring
Name of the primary contact person at this supplier.
phoneNumberstring
Primary phone number for the supplier.
addressstring
Street address.
citystring
City.
statestring

State or province code (e.g. TX).

zipCodestring

Postal/ZIP code.

websitestring
Supplier website URL.
notestring
Internal notes about this supplier.
createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error