Docs
Management API
Inventory
Items

Items

Get Inventory at Locations

GET /inventory/items

Request

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

Limits

  • Limit of 1000 items for payload length.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • 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

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/inventory/items' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Request has been successfully processed.

Body

object | application/json

  • data    array[object]

  • meta    object

example

{
"data": [
{
"identity": {
"sku": "RE-130",
"variant_id": 79,
"product_id": 120,
"sku_id": 0
},
"locations": [
{
"location_id": 1,
"location_code": "BC-LOCATION-1",
"location_name": "Default location",
"available_to_sell": 10,
"total_inventory_onhand": 11,
"location_enabled": true,
"settings": {
"safety_stock": 1,
"is_in_stock": true,
"warning_level": 1,
"bin_picking_number": "1"
}
}
]
}
],
"meta": {
"pagination": {

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.

Limits

  • Limit of 1000 items for payload length.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • 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

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/inventory/locations/[location_id]/items' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Request has been successfully processed.

Body

object | application/json

  • data    array[object]

  • meta    object

example

{
"data": [
{
"identity": {
"sku": "RE-130",
"variant_id": 78,
"product_id": 130
},
"available_to_sell": 10,
"total_inventory_onhand": 12,
"settings": {
"safety_stock": 2,
"is_in_stock": true,
"warning_level": 2,
"bin_picking_number": "1"
}
}
],
"meta": {
"pagination": {
"total": 246,
"count": 5,
"per_page": 5,
"current_page": 1,
"total_pages": 50,
"links": {
"previous": "?limit=5&page=2",
"current": "?limit=5&page=3",
"next": "?limit=5&page=4"

Update Inventory Settings for a Location

PUT /inventory/locations/{location_id}/items

Request

Update inventory settings for items at a location.

Limits

  • Limit of 2000 items for payload length.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • location_id in path - integer
    required
    Unique identifier for a location.

Body

object | application/json

  • settings    array[object]
    required

example

{
"settings": [
{
"identity": {
"sku": "RE-130"
},
"safety_stock": 5,
"is_in_stock": true,
"warning_level": 10,
"bin_picking_number": "1"
}
]
}

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?
Relative AdjustmentGet Inventory at Locations