Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

supplier
string
required

Body

application/json

An item of a supplier's catalog, with up to ten price breaks.

item
string
required

The item, by id or SKU.

Maximum string length: 64
supplier_sku
string | null
Maximum string length: 64
description
string | null
Maximum string length: 255
purchase_unit
string | null

The unit the supplier sells in; the item's base unit when left out.

Maximum string length: 16
minimum_quantity
string | null
Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$
order_multiple
string | null
Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$
lead_time_days
integer | null
Required range: 0 <= x <= 365
origin_country
string | null

ISO 3166-1 alpha-2; a receipt of this item defaults to it.

Required string length: 2
preferred
boolean | null
prices
object[] | null
Maximum array length: 10

Response

SupplierCatalogResource

data
SupplierCatalogResource · object
required