Skip to main content
POST
Create an adjustment (discriminated by adjustment_type)

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Body

application/json
adjustment_type
enum<string>
required
Available options:
inventory,
ar,
ap
product_id
string<uuid>

Required when adjustment_type=inventory.

location_id
string<uuid>

Required when adjustment_type=inventory.

quantity_delta
number

Signed quantity delta for inventory adjustments.

vendor_bill_id
string<uuid>

Required when adjustment_type=ap.

amount
number

Required when adjustment_type=ar (write-off amount).

account_id
string<uuid>
reason_code
string
notes
string

Response

Adjustment created

The response is of type object.