BigCommerce
Management API
Adjustments

Inventory

Absolute Adjustment

PUT /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 header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

Body

object | application/json
  • reason
    string

    Reason for the adjustment operation.

    Example: Monthly arrival delivered.

  • items
    array[object]
    required

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

Absolute Adjustment

Response

Request has been successfully processed.

Body

object | application/json
  • transaction_id
    string

    Unique identifier of performed action.

Relative Adjustment

POST /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 header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

Body

object | application/json
  • reason
    string

    Reason for the adjustment operation.

    Example: Monthly arrival delivered.

  • items
    array[object]
    required

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

Relative Adjustment

Response

Request has been successfully processed.

Body

object | application/json
  • transaction_id
    string

    Unique identifier of performed action.

example

Did you find what you were looking for?