Skip to main content
POST
Adjust stock

Authorizations

x-api-key
string
header
required

Your API key, for example cmp_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx. Create one on the Integrations page of the compliance dashboard.

Body

application/json
itemId
string
required
action
enum<string>
required
Available options:
ADD,
DEDUCT
quantity
number
required
branchId
string

Defaults to the business's first branch.

unitPrice
number
Required range: x >= 0
referenceId
string

Your own reference for the movement.

Maximum string length: 100
businessId
string

The business to act for. Required for organisation-wide keys; omit it for a business-bound key. List the ids you can use with GET /v1/businesses.

Response

The movement was recorded.

data
object
required