Skip to main content
PUT
Perform negative stock adjustment

Request Structure

Key Fields

Behavior

  • The stock must have status AVAILABLE or be on hold, and its stock balance (available or on hold respectively) must cover quantity.
  • The stock’s quantity decreases by quantity, and the stock balance for its account, product and warehouse decreases with it.
  • The response has no body (204).

Error Codes

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

id
integer
required

The unique identifier of the stock record to adjust

Body

application/json

Request body for negative stock adjustment. The body is sent as plain JSON, not wrapped in a JSON:API data envelope.

description
string
required

Free-text reason for the adjustment, recorded on the transaction

quantity
number
required

Quantity to REMOVE from the stock. Must be greater than 0 and no more than the stock's current quantity.

Required range: x > 0
reason_code_id
integer | null

ID of a reason code with reason_type negative_adjustment, recorded on the transaction for the audit trail. Required when the stock's account has enforce_negative_adjustment_reason_code enabled.

Response

Stock adjusted successfully