Skip to main content
POST
Increase stock quantity (positive adjustment)

Request Structure

Key Fields

Behavior

  • The stock must have status AVAILABLE or be on hold; allocated, picked and in-transit stock cannot be adjusted.
  • The stock’s quantity increases by quantity, and the stock balance for its account, product and warehouse increases with it.
  • Returns the updated stock record.

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.

Body

application/json

Request body for increasing the quantity of an existing stock record. 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 ADD to the stock's current quantity (not the new total)

Required range: x > 0
stock_id
integer
required

ID of the existing stock record to increase

reason_code_id
integer | null

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

serial_numbers
string[]

Serial numbers for the added units. Required when the stock has full serial number tracking, in which case exactly one serial number per added unit must be sent (quantity rounded up). Serial numbers must be unique and must not already be in stock for the product.

Response

Stock quantity increased successfully

The updated stock as a JSON:API resource. Attribute and relationship keys are dasherized (e.g. fifo-date, storage-unit) and decimal values such as quantity are serialized as strings.

data
object