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

Query Parameters

customer
string
required

The customer, by id or code.

Maximum string length: 64
item
string
required

The item, by id or SKU.

Maximum string length: 64
quantity
string
required

In the item's base unit.

Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$
on
string<date> | null

Today when left out.

Response

CustomerPriceResource

data
CustomerPriceResource · object
required