BigCommerce
Management API
Items

Inventory

Get Inventory at Locations

GET /inventory/items

Request

Return a list of inventory and inventory settings for all items in all locations.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • sku:in in query - string

    List of sku separated by comma.

  • variant_id:in in query - integer

    List of variant_id separated by comma.

  • product_id:in in query - integer

    List of product_id separated by comma.

  • location_id:in in query - integer

    Comma separated list of location_id.

  • location_code:in in query - string

    Comma separated list of location_code.

  • page in query - integer

    Specifies the page number in a limited (paginated) list.

  • limit in query - integer

    Controls the number of items per page in a limited (paginated) list.

example

Response

Request has been successfully processed.

Body

object | application/json
  • data
    array[object]

  • meta
    object

example

Get Inventory at a Location

GET /inventory/locations/{location_id}/items

Request

Return a list of inventory and inventory settings for all items in a location.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • location_id in path - integer - required

    Unique identifier for a location.

  • variant_id:in in query - integer

    List of variant_id separated by comma.

  • product_id:in in query - integer

    List of product_id separated by comma.

  • sku:in in query - string

    List of sku separated by comma.

  • page in query - integer

    Specifies the page number in a limited (paginated) list.

  • limit in query - integer

    Controls the number of items per page in a limited (paginated) list.

example

Response

Request has been successfully processed.

Body

object | application/json
  • data
    array[object]

  • meta
    object

example

Update Inventory Settings for a Location

PUT /inventory/locations/{location_id}/items

Request

Update inventory settings for items at a location.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • location_id in path - integer - required

    Unique identifier for a location.

Body

object | application/json
  • settings
    array[object]
    required

example

Response

Request has been successfully processed.

Body

object | application/json
  • transaction_id
    string

    Unique identifier of performed action.

Did you find what you were looking for?