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.

Body

application/json

A location's fields, for creating it or editing it. A code is letters, digits and . _ - /, starting with a letter or digit, so it can be printed on a label and scanned.

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

Response

StockLocationResource

data
StockLocationResource · object
required