Skip to main content
POST
Transfer 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
fromBranchId
string
required
toBranchId
string
required
quantity
number
required
unitPrice
number
Required range: x >= 0
referenceId
string
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 transfer was recorded.

data
object
required