Adjustments
Absolute Adjustment
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/inventory/adjustments/absoluteRequest
Override the existing inventory levels for an inventory item at a location. 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.
Limits
- For maximum inventory levels, see Inventory adjustments.
- Limit of 2000 items for payload length, see Optimizing performance for more information.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
reasonstring
Reason for the adjustment operation.Example: Monthly arrival delivered.itemsarray[]
requiredOne of thesku,product_id, orvariant_idis required to identify the item.
Absolute Adjustment
{
"reason": "Absolute adjustment reason",
"items": [
{
"location_id": 1,
"variant_id": 1,
"quantity": 1
},
{
"location_id": 2,
"variant_id": 3,
"quantity": 1
},
{
"location_id": 3,
"sku": "sku-4",
"quantity": 1
},
{
"location_id": 1,
"sku": "sku-5",
"quantity": 1
},
{
"location_id": 1,
"product_id": 111,
"quantity": 7
}
]
}
Response
Request has been successfully processed.
Body
object | application/json
transaction_idstring
Unique identifier of performed action.
Relative Adjustment
POST https://api.bigcommerce.com/stores/{store_hash}/v3/inventory/adjustments/relativeRequest
Add or subtract inventory for an inventory item at a location. 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.
Limits
- For maximum inventory levels, see Inventory adjustments.
- Limit of 2000 items for payload length, see Optimizing performance for more information.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
reasonstring
Reason for the adjustment operation.Example: Monthly arrival delivered.itemsarray[]
requiredOne of thesku,product_id, orvariant_idis required to identify the item.
Relative Adjustment
{
"reason": "Relative adjustment reason",
"items": [
{
"location_id": 1,
"variant_id": 1,
"quantity": 1
},
{
"location_id": 2,
"variant_id": 3,
"quantity": -1
},
{
"location_id": 3,
"sku": "sku-4",
"quantity": 1
},
{
"location_id": 1,
"sku": "sku-5",
"quantity": -1
},
{
"location_id": 1,
"product_id": 111,
"quantity": 7
}
]
}
Response
Request has been successfully processed.
Body
object | application/json
transaction_idstring
Unique identifier of performed action.
example
{
"transaction_id": "string"
}
Did you find what you were looking for?