Skip to main content
POST
Adjust inventory stock

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json
adjustment_entries
object[]
required

One entry per stock adjustment. A maximum of 3000 entries may be submitted in a single request (exceeding this returns a 422). Payloads larger than 500 entries are posted asynchronously in the background: the response returns the created adjustment header immediately, but the individual stock changes finish posting shortly afterward rather than within the request.

Maximum array length: 3000
remarks
string

Optional remarks for the adjustment

Response

Successful response

id
integer

ID of the created adjustment

remarks
string

Remarks for the adjustment

posted_by
integer

ID of the user who posted the adjustment

created_at
string<date-time>

Timestamp of when the adjustment was created

updated_at
string<date-time>

Timestamp of when the adjustment was last updated