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 stock adjustment: an item by id or SKU, a location, a positive exact decimal quantity and a reason. "Other" needs a note.

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

Whether an adjustment adds stock or takes it away.

Available options:
receipt,
issue
quantity
string
required
Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$
reason
enum<string>
required
Available options:
found,
damaged,
lost,
destroyed,
correction,
opening_balance,
other
unit
string | null
Maximum string length: 16
note
string | null
Maximum string length: 1000
status
enum<string> | null

Whether stock may be used. Only available stock counts as available to use; quarantined and rejected stock is on hand but held.

Available options:
available,
quarantined,
rejected
lot
string | null
Maximum string length: 64
lot_expires_on
string<date-time> | null
serials
string[] | null
Maximum array length: 25
Maximum string length: 64
unit_cost
string | null
Pattern: ^\d{1,20}(\.\d{1,20})?$
bulk_id
string<uuid> | null
bulk_line
integer | null
Required range: 0 <= x <= 99
decisions
object | null

The choice for each flag the person decided on the bulk preview, such as {"reserved": "leave"}. Only reserved, mixed_lots and short_dated can be decided.

bulk_undo_of
string<uuid> | null

On a line of "Undo all", the bulk it undoes.

Response

Array of StockMovementResource

data
StockMovementResource · object[]
required