Skip to main content
PUT
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

A supplier's fields, for adding it or editing it. A code is letters, digits and . _ - /, starting with a letter or digit.

code
string
required
Maximum string length: 32
Pattern: ^[A-Za-z0-9][A-Za-z0-9._\/-]*$
name
string
required
Maximum string length: 255
lead_time_days
integer | null

Days from order to delivery, when the supplier's catalog does not say.

Required range: 0 <= x <= 365
payment_terms
string | null
Maximum string length: 100
address
string | null
Maximum string length: 1000
notes
string | null
Maximum string length: 2000

Response

SupplierResource

data
SupplierResource · object
required