Inventory
Absolute Adjustment
PUT /stores/{store_hash}/v3/inventory/adjustments/absolute
Request
Override the existing inventory levels for an inventory item at a location. For maximum inventory levels, see Inventory adjustments. For payload limits, see Optimizing performance.
Use absolute adjustments as the default method for updating inventory. This endpoint batches requests, making them more resource friendly than the Catalog API. Absolute adjustments have lower complexity than relative adjustments, which synchronize with orders.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
reasonstring
Reason for the adjustment operation.
Example: Monthly arrival delivered.
itemsarray[object]
requiredOne of the
sku
,product_id
, orvariant_id
is required to identify the item.
Absolute Adjustment
Response
Request has been successfully processed.
Body
transaction_idstring
Unique identifier of performed action.
Relative Adjustment
POST /stores/{store_hash}/v3/inventory/adjustments/relative
Request
Add or subtract inventory for an inventory item at a location. For maximum inventory levels, see Inventory adjustments. For payload limits, see Optimizing performance.
Use this endpoint only when you do not know absolute quantities. For example, making order-related inventory changes through a third-party may require relative adjustments. Otherwise, use the Absolute adjustment endpoint for updating inventory.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
reasonstring
Reason for the adjustment operation.
Example: Monthly arrival delivered.
itemsarray[object]
requiredOne of the
sku
,product_id
, orvariant_id
is required to identify the item.
Relative Adjustment
Response
Request has been successfully processed.
Body
transaction_idstring
Unique identifier of performed action.