Absolute Adjustment

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/inventory/adjustments/absolute

PUT

/stores/:store_hash/v3/inventory/adjustments/absolute

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/inventory/adjustments/absolute \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "items": [
    {
      "location_id": 1,
      "quantity": 1,
      "sku": "RE-130",
      "variant_id": 1
    },
    {
      "location_id": 2,
      "quantity": 1,
      "sku": "RE-130",
      "variant_id": 3
    },
    {
      "location_id": 3,
      "quantity": 1,
      "sku": "sku-4"
    },
    {
      "location_id": 1,
      "quantity": 1,
      "sku": "sku-5"
    },
    {
      "location_id": 1,
      "product_id": 111,
      "quantity": 7,
      "sku": "RE-130"
    }
  ],
  "reason": "Absolute adjustment reason"
}'

{
  "transaction_id": "string"
}

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-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Store Inventory	read-only	`store_inventory_read_only`
Store Inventory	modify	`store_inventory`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see API Accounts and OAuth Scopes.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

itemslist of objectsRequired

One of the sku, product_id, or variant_id is required to identify the item.

reasonstringOptional

Reason for the adjustment operation.

Response

Request has been successfully processed.

transaction_idstringOptional

Unique identifier of performed action.

Errors

422

Unprocessable Entity Error