Skip to main content
POST
Adjust stock

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

A unique value you choose for this request, such as a UUID. Sending the same key again returns the first answer instead of doing the work twice, so a timed-out request is safe to retry. Reusing a key for a different request is refused with 409 idempotency_key_conflict, and retrying while the first request is still running with 409 idempotency_key_reused. See Retries and idempotency.

Minimum string length: 1

Path Parameters

clinic_id
string<uuid>
required

Body

application/json
item_id
string<uuid>
required
location_id
string<uuid>
required
lot_id
string<uuid>
required
delta
number
required

Positive or negative. abs(delta) over clinic_settings.inventory_api_max_adjustment_qty (default 1000) is refused (limit_exceeded).

reason
string
required
Minimum string length: 1

Response

OK.

data
object
required

The ledger movement receive/adjust/transfer just recorded — never the whole inventory_transactions row.