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 request to release held stock: an item by id or SKU, a location and the status it is held in. It also takes a positive exact decimal quantity and its lot, serial number or labelled piece.

item
string
required
Maximum string length: 64
location_id
string<uuid>
required
held_status
enum<string>
required

quarantined or rejected.

Available options:
available,
quarantined,
rejected
quantity
string
required
Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$
unit
string | null
Maximum string length: 16
lot
string | null
Maximum string length: 64
serial
string | null
Maximum string length: 64
piece
string | null

The piece ID on the label that was scanned.

Maximum string length: 64
note
string | null
Maximum string length: 1000
waiting_command_id
string<uuid> | null

The id of the device command that waits for the release.

Response

ReleaseRequestResource

data
ReleaseRequestResource · object
required