InventoryLevel

Version 2019-10

An inventory level represents the available quantity of an inventory item at a specific location.

Each inventory level belongs to one inventory item and has one location. For every location where an inventory item is available, there's an inventory level that represents the inventory item's quantity at that location:

Inventory levels and fulfillment service locations

A fulfillment service location has a 1:1 relationship with a third-party fulfillment service. When an app creates a new fulfillment service on a store, Shopify automatically creates a location that's associated with that fulfillment service. The FulfillmentService resource has a location_id property, which identifies the associated location.

An inventory item connected to a fulfillment service location can't be connected to any other locations at the same time:

Connecting an inventory item to a fulfillment service location

When you work with items that have been or will be connected a fulfillment location, you should include "relocate_if_necessary": true in the body of the request. There are two situations where you might do this:

connecting an inventory item to a fulfillment service location and disconnecting it from all standard locations
connecting an inventory item to one or more standard locations and disconnecting it from a fulfillment service location

If relocate_if_necessary is true, then all inventory for the item is relocated to the new location and disconnected from any other locations. If a fulfillment service location is involved but relocate_if_necessary is false, then the connection will fail. If no fulfillment service is involved, then the property is ignored and no inventory is relocated.

Setting the inventory level at a fulfillment service location

When you set inventory for a location, the inventory item is connected to the location if they are not already connected. If the item has been or will be connected to a fulfillment service location, then you should include "disconnect_if_necessary": true in the body of the request. There are two situations where you might do this:

setting inventory for an inventory item at a fulfillment service location when the item is already connected to one or more standard locations
setting inventory for an inventory item at a standard location when the item is already connected to a fulfillment service location

The inventory at the new location is set to the value of the available property. The inventory for other locations is set to 0 and the locations are disconnected from the inventory item.

If disconnect_if_necessary is set to false when you set inventory at a location and a fulfillment service location is involved, then the action will fail. If no fulfillment service location is involved, then this property is ignored.

What you can do with InventoryLevel

The Shopify API lets you do the following with the InventoryLevel resource. More detailed versions of these general actions may be available:

GET /admin/api/2019-10/inventory_levels.json Retrieves a list of inventory levels
POST /admin/api/2019-10/inventory_levels/adjust.json Adjusts the inventory level of an inventory item at a location
DELETE /admin/api/2019-10/inventory_levels.json?inventory_item_id=808950810&location_id=905684977 Deletes an inventory level from a location
POST /admin/api/2019-10/inventory_levels/connect.json Connects an inventory item to a location
POST /admin/api/2019-10/inventory_levels/set.json Sets the inventory level for an inventory item at a location

InventoryLevel properties

available	`"available": 6` The quantity of inventory items available for sale. Returns `null` if the inventory item is not tracked.
inventory_item_id read-only	`"inventory_item_id": 450789469` The ID of the inventory item that the inventory level belongs to.
location_id	`"location_id": 40642626` The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
updated_at read-only	`"updated_at": "2012-08-24T14:01:47-04:00"` The date and time (ISO 8601 format) when the inventory level was last modified.

Endpoints

GET /admin/api/2019-10/inventory_levels.json

Retrieves a list of inventory levels.

You must include inventory_item_ids, location_ids, or both as filter parameters.

Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

inventory_item_ids	A comma-separated list of inventory item IDs. (maximum: `50`)
location_ids	A comma-separated list of location IDs. To find the ID of a location, use the Location resource. (maximum: `50`)
limit	The maximum number of results to show. (default: `50`, maximum: `250`)
updated_at_min	Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).

Retrieving inventory levels without specifying `location_ids` or `inventory_item_ids` fails and returns an error

GET /admin/api/2020-07/inventory_levels.json

View Response

HTTP/1.1 422 Unprocessable Entity

Retrieve inventory levels for the specified inventory items and locations

GET /admin/api/2020-07/inventory_levels.json?inventory_item_ids=808950810,39072856&location_ids=905684977,487838322

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 808950810,
      "location_id": 487838322,
      "available": 9,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 487838322,
      "available": 27,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=39072856"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 905684977,
      "available": 3,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=39072856"
    }
  ]
}

Retrieve inventory levels for a single inventory item

GET /admin/api/2020-07/inventory_levels.json?inventory_item_ids=808950810

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 808950810,
      "location_id": 487838322,
      "available": 9,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    }
  ]
}

Retrieve inventory levels at a single location

GET /admin/api/2020-07/inventory_levels.json?location_ids=905684977

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 49148385,
      "location_id": 905684977,
      "available": 2,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=49148385"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 457924702,
      "location_id": 905684977,
      "available": 4,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=457924702"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 905684977,
      "available": 3,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=39072856"
    }
  ]
}

POST /admin/api/2019-10/inventory_levels/adjust.json

Adjusts the inventory level of an inventory item at a single location

inventory_item_id required	The ID of the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
available_adjustment required	The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, `"available_adjustment": 2` increases the current available quantity by 2, and `"available_adjustment": -3`decreases the current available quantity by 3.

Adjust the available quantity of an inventory item by 5 at a single location

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 200 OK
{
  "inventory_level": {
    "inventory_item_id": 808950810,
    "location_id": 905684977,
    "available": 6,
    "updated_at": "2020-09-08T13:25:03-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
  }
}

Adjusting inventory levels at a non-existent location fails and returns an error

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 404 Not Found
{
  "errors": "Not Found"
}

Adjusting inventory levels for an inventory item that is untracked fails and returns an error

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 422 Unprocessable Entity

DELETE /admin/api/2019-10/inventory_levels.json?inventory_item_id=808950810&location_id=905684977

Deletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.

inventory_item_id required	The ID for the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.

Delete an inventory level

DELETE /admin/api/2020-07/inventory_levels.json?inventory_item_id=808950810&location_id=905684977

View Response

HTTP/1.1 204 No Content

POST /admin/api/2019-10/inventory_levels/connect.json

Connects an inventory item to a location by creating an inventory level at that location.

When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.

inventory_item_id required	The ID of the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
relocate_if_necessary	Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations. (default: `false`)

Connect an inventory item to a location

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 192722535,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 201 Created
{
  "inventory_level": {
    "inventory_item_id": 457924702,
    "location_id": 192722535,
    "available": 0,
    "updated_at": "2020-09-08T13:25:09-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/192722535?inventory_item_id=457924702"
  }
}

Connecting an inventory item to a non-existent location fails and returns an error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 123,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 404 Not Found
{
  "errors": "Not Found"
}

Connecting an inventory item to a fulfillment service location without `"relocate_if_necessary": true` fails with a 422 error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 48752903,
  "inventory_item_id": 808950810
}

View Response

HTTP/1.1 422 Unprocessable Entity
{
  "errors": [
    "An item cannot be active at more than one location if one of them is a fulfillment service location."
  ]
}

Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 192722535,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 403 Forbidden
{
  "errors": [
    "Shop does not have multi-location enabled"
  ]
}

POST /admin/api/2019-10/inventory_levels/set.json

Sets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.

inventory_item_id required	The ID for the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
available required	Sets the available inventory quantity.
disconnect_if_necessary	Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. For more information, see Inventory levels and fulfillment service locations. (default: `false`)

Set the available inventory at a location

POST /admin/api/2020-07/inventory_levels/set.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available": 42
}

View Response

HTTP/1.1 200 OK
{
  "inventory_level": {
    "inventory_item_id": 808950810,
    "location_id": 905684977,
    "available": 42,
    "updated_at": "2020-09-08T13:25:13-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
  }
}

Setting an inventory item to a fulfillment service without `"disconnect_if_necessary": true` fails with a 422 error

POST /admin/api/2020-07/inventory_levels/set.json

{
  "location_id": 61629186,
  "inventory_item_id": 808950810,
  "available": 42
}

View Response

HTTP/1.1 422 Unprocessable Entity
{
  "errors": [
    "An item cannot be active at more than one location if one of them is a fulfillment service location."
  ]
}

Version 2020-01

An inventory level represents the available quantity of an inventory item at a specific location.

Each inventory level belongs to one inventory item and has one location. For every location where an inventory item is available, there's an inventory level that represents the inventory item's quantity at that location:

Inventory levels and fulfillment service locations

A fulfillment service location has a 1:1 relationship with a third-party fulfillment service. When an app creates a new fulfillment service on a store, Shopify automatically creates a location that's associated with that fulfillment service. The FulfillmentService resource has a location_id property, which identifies the associated location.

An inventory item connected to a fulfillment service location can't be connected to any other locations at the same time:

Connecting an inventory item to a fulfillment service location

When you work with items that have been or will be connected a fulfillment location, you should include "relocate_if_necessary": true in the body of the request. There are two situations where you might do this:

connecting an inventory item to a fulfillment service location and disconnecting it from all standard locations
connecting an inventory item to one or more standard locations and disconnecting it from a fulfillment service location

If relocate_if_necessary is true, then all inventory for the item is relocated to the new location and disconnected from any other locations. If a fulfillment service location is involved but relocate_if_necessary is false, then the connection will fail. If no fulfillment service is involved, then the property is ignored and no inventory is relocated.

Setting the inventory level at a fulfillment service location

When you set inventory for a location, the inventory item is connected to the location if they are not already connected. If the item has been or will be connected to a fulfillment service location, then you should include "disconnect_if_necessary": true in the body of the request. There are two situations where you might do this:

setting inventory for an inventory item at a fulfillment service location when the item is already connected to one or more standard locations
setting inventory for an inventory item at a standard location when the item is already connected to a fulfillment service location

The inventory at the new location is set to the value of the available property. The inventory for other locations is set to 0 and the locations are disconnected from the inventory item.

If disconnect_if_necessary is set to false when you set inventory at a location and a fulfillment service location is involved, then the action will fail. If no fulfillment service location is involved, then this property is ignored.

What you can do with InventoryLevel

The Shopify API lets you do the following with the InventoryLevel resource. More detailed versions of these general actions may be available:

GET /admin/api/2020-01/inventory_levels.json Retrieves a list of inventory levels
POST /admin/api/2020-01/inventory_levels/adjust.json Adjusts the inventory level of an inventory item at a location
DELETE /admin/api/2020-01/inventory_levels.json?inventory_item_id=808950810&location_id=905684977 Deletes an inventory level from a location
POST /admin/api/2020-01/inventory_levels/connect.json Connects an inventory item to a location
POST /admin/api/2020-01/inventory_levels/set.json Sets the inventory level for an inventory item at a location

InventoryLevel properties

available	`"available": 6` The quantity of inventory items available for sale. Returns `null` if the inventory item is not tracked.
inventory_item_id read-only	`"inventory_item_id": 450789469` The ID of the inventory item that the inventory level belongs to.
location_id	`"location_id": 40642626` The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
updated_at read-only	`"updated_at": "2012-08-24T14:01:47-04:00"` The date and time (ISO 8601 format) when the inventory level was last modified.

Endpoints

GET /admin/api/2020-01/inventory_levels.json

Retrieves a list of inventory levels.

You must include inventory_item_ids, location_ids, or both as filter parameters.

Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

inventory_item_ids	A comma-separated list of inventory item IDs. (maximum: `50`)
location_ids	A comma-separated list of location IDs. To find the ID of a location, use the Location resource. (maximum: `50`)
limit	The maximum number of results to show. (default: `50`, maximum: `250`)
updated_at_min	Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).

Retrieving inventory levels without specifying `location_ids` or `inventory_item_ids` fails and returns an error

GET /admin/api/2020-07/inventory_levels.json

View Response

HTTP/1.1 422 Unprocessable Entity

Retrieve inventory levels for the specified inventory items and locations

GET /admin/api/2020-07/inventory_levels.json?inventory_item_ids=808950810,39072856&location_ids=905684977,487838322

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 808950810,
      "location_id": 487838322,
      "available": 9,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 487838322,
      "available": 27,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=39072856"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 905684977,
      "available": 3,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=39072856"
    }
  ]
}

Retrieve inventory levels for a single inventory item

GET /admin/api/2020-07/inventory_levels.json?inventory_item_ids=808950810

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 808950810,
      "location_id": 487838322,
      "available": 9,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    }
  ]
}

Retrieve inventory levels at a single location

GET /admin/api/2020-07/inventory_levels.json?location_ids=905684977

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 49148385,
      "location_id": 905684977,
      "available": 2,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=49148385"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 457924702,
      "location_id": 905684977,
      "available": 4,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=457924702"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 905684977,
      "available": 3,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=39072856"
    }
  ]
}

POST /admin/api/2020-01/inventory_levels/adjust.json

Adjusts the inventory level of an inventory item at a single location

inventory_item_id required	The ID of the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
available_adjustment required	The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, `"available_adjustment": 2` increases the current available quantity by 2, and `"available_adjustment": -3`decreases the current available quantity by 3.

Adjust the available quantity of an inventory item by 5 at a single location

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 200 OK
{
  "inventory_level": {
    "inventory_item_id": 808950810,
    "location_id": 905684977,
    "available": 6,
    "updated_at": "2020-09-08T13:25:03-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
  }
}

Adjusting inventory levels at a non-existent location fails and returns an error

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 404 Not Found
{
  "errors": "Not Found"
}

Adjusting inventory levels for an inventory item that is untracked fails and returns an error

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 422 Unprocessable Entity

DELETE /admin/api/2020-01/inventory_levels.json?inventory_item_id=808950810&location_id=905684977

Deletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.

inventory_item_id required	The ID for the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.

Delete an inventory level

DELETE /admin/api/2020-07/inventory_levels.json?inventory_item_id=808950810&location_id=905684977

View Response

HTTP/1.1 204 No Content

POST /admin/api/2020-01/inventory_levels/connect.json

Connects an inventory item to a location by creating an inventory level at that location.

When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.

inventory_item_id required	The ID of the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
relocate_if_necessary	Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations. (default: `false`)

Connect an inventory item to a location

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 192722535,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 201 Created
{
  "inventory_level": {
    "inventory_item_id": 457924702,
    "location_id": 192722535,
    "available": 0,
    "updated_at": "2020-09-08T13:25:09-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/192722535?inventory_item_id=457924702"
  }
}

Connecting an inventory item to a non-existent location fails and returns an error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 123,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 404 Not Found
{
  "errors": "Not Found"
}

Connecting an inventory item to a fulfillment service location without `"relocate_if_necessary": true` fails with a 422 error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 48752903,
  "inventory_item_id": 808950810
}

View Response

HTTP/1.1 422 Unprocessable Entity
{
  "errors": [
    "An item cannot be active at more than one location if one of them is a fulfillment service location."
  ]
}

Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 192722535,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 403 Forbidden
{
  "errors": [
    "Shop does not have multi-location enabled"
  ]
}

POST /admin/api/2020-01/inventory_levels/set.json

Sets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.

inventory_item_id required	The ID for the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
available required	Sets the available inventory quantity.
disconnect_if_necessary	Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. For more information, see Inventory levels and fulfillment service locations. (default: `false`)

Set the available inventory at a location

POST /admin/api/2020-07/inventory_levels/set.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available": 42
}

View Response

HTTP/1.1 200 OK
{
  "inventory_level": {
    "inventory_item_id": 808950810,
    "location_id": 905684977,
    "available": 42,
    "updated_at": "2020-09-08T13:25:13-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
  }
}

Setting an inventory item to a fulfillment service without `"disconnect_if_necessary": true` fails with a 422 error

POST /admin/api/2020-07/inventory_levels/set.json

{
  "location_id": 61629186,
  "inventory_item_id": 808950810,
  "available": 42
}

View Response

HTTP/1.1 422 Unprocessable Entity
{
  "errors": [
    "An item cannot be active at more than one location if one of them is a fulfillment service location."
  ]
}

Version 2020-04

An inventory level represents the available quantity of an inventory item at a specific location.

Each inventory level belongs to one inventory item and has one location. For every location where an inventory item is available, there's an inventory level that represents the inventory item's quantity at that location:

Inventory levels and fulfillment service locations

A fulfillment service location has a 1:1 relationship with a third-party fulfillment service. When an app creates a new fulfillment service on a store, Shopify automatically creates a location that's associated with that fulfillment service. The FulfillmentService resource has a location_id property, which identifies the associated location.

An inventory item connected to a fulfillment service location can't be connected to any other locations at the same time:

Connecting an inventory item to a fulfillment service location

When you work with items that have been or will be connected a fulfillment location, you should include "relocate_if_necessary": true in the body of the request. There are two situations where you might do this:

connecting an inventory item to a fulfillment service location and disconnecting it from all standard locations
connecting an inventory item to one or more standard locations and disconnecting it from a fulfillment service location

If relocate_if_necessary is true, then all inventory for the item is relocated to the new location and disconnected from any other locations. If a fulfillment service location is involved but relocate_if_necessary is false, then the connection will fail. If no fulfillment service is involved, then the property is ignored and no inventory is relocated.

Setting the inventory level at a fulfillment service location

When you set inventory for a location, the inventory item is connected to the location if they are not already connected. If the item has been or will be connected to a fulfillment service location, then you should include "disconnect_if_necessary": true in the body of the request. There are two situations where you might do this:

setting inventory for an inventory item at a fulfillment service location when the item is already connected to one or more standard locations
setting inventory for an inventory item at a standard location when the item is already connected to a fulfillment service location

The inventory at the new location is set to the value of the available property. The inventory for other locations is set to 0 and the locations are disconnected from the inventory item.

If disconnect_if_necessary is set to false when you set inventory at a location and a fulfillment service location is involved, then the action will fail. If no fulfillment service location is involved, then this property is ignored.

What you can do with InventoryLevel

The Shopify API lets you do the following with the InventoryLevel resource. More detailed versions of these general actions may be available:

GET /admin/api/2020-04/inventory_levels.json Retrieves a list of inventory levels
POST /admin/api/2020-04/inventory_levels/adjust.json Adjusts the inventory level of an inventory item at a location
DELETE /admin/api/2020-04/inventory_levels.json?inventory_item_id=808950810&location_id=905684977 Deletes an inventory level from a location
POST /admin/api/2020-04/inventory_levels/connect.json Connects an inventory item to a location
POST /admin/api/2020-04/inventory_levels/set.json Sets the inventory level for an inventory item at a location

InventoryLevel properties

available	`"available": 6` The quantity of inventory items available for sale. Returns `null` if the inventory item is not tracked.
inventory_item_id read-only	`"inventory_item_id": 450789469` The ID of the inventory item that the inventory level belongs to.
location_id	`"location_id": 40642626` The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
updated_at read-only	`"updated_at": "2012-08-24T14:01:47-04:00"` The date and time (ISO 8601 format) when the inventory level was last modified.

Endpoints

GET /admin/api/2020-04/inventory_levels.json

Retrieves a list of inventory levels.

You must include inventory_item_ids, location_ids, or both as filter parameters.

Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

inventory_item_ids	A comma-separated list of inventory item IDs. (maximum: `50`)
location_ids	A comma-separated list of location IDs. To find the ID of a location, use the Location resource. (maximum: `50`)
limit	The maximum number of results to show. (default: `50`, maximum: `250`)
updated_at_min	Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).

Retrieving inventory levels without specifying `location_ids` or `inventory_item_ids` fails and returns an error

GET /admin/api/2020-07/inventory_levels.json

View Response

HTTP/1.1 422 Unprocessable Entity

Retrieve inventory levels for the specified inventory items and locations

GET /admin/api/2020-07/inventory_levels.json?inventory_item_ids=808950810,39072856&location_ids=905684977,487838322

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 808950810,
      "location_id": 487838322,
      "available": 9,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 487838322,
      "available": 27,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=39072856"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 905684977,
      "available": 3,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=39072856"
    }
  ]
}

Retrieve inventory levels for a single inventory item

GET /admin/api/2020-07/inventory_levels.json?inventory_item_ids=808950810

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 808950810,
      "location_id": 487838322,
      "available": 9,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    }
  ]
}

Retrieve inventory levels at a single location

GET /admin/api/2020-07/inventory_levels.json?location_ids=905684977

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 49148385,
      "location_id": 905684977,
      "available": 2,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=49148385"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 457924702,
      "location_id": 905684977,
      "available": 4,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=457924702"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 905684977,
      "available": 3,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=39072856"
    }
  ]
}

POST /admin/api/2020-04/inventory_levels/adjust.json

Adjusts the inventory level of an inventory item at a single location

inventory_item_id required	The ID of the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
available_adjustment required	The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, `"available_adjustment": 2` increases the current available quantity by 2, and `"available_adjustment": -3`decreases the current available quantity by 3.

Adjust the available quantity of an inventory item by 5 at a single location

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 200 OK
{
  "inventory_level": {
    "inventory_item_id": 808950810,
    "location_id": 905684977,
    "available": 6,
    "updated_at": "2020-09-08T13:25:03-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
  }
}

Adjusting inventory levels at a non-existent location fails and returns an error

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 404 Not Found
{
  "errors": "Not Found"
}

Adjusting inventory levels for an inventory item that is untracked fails and returns an error

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 422 Unprocessable Entity

DELETE /admin/api/2020-04/inventory_levels.json?inventory_item_id=808950810&location_id=905684977

Deletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.

inventory_item_id required	The ID for the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.

Delete an inventory level

DELETE /admin/api/2020-07/inventory_levels.json?inventory_item_id=808950810&location_id=905684977

View Response

HTTP/1.1 204 No Content

POST /admin/api/2020-04/inventory_levels/connect.json

Connects an inventory item to a location by creating an inventory level at that location.

When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.

inventory_item_id required	The ID of the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
relocate_if_necessary	Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations. (default: `false`)

Connect an inventory item to a location

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 192722535,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 201 Created
{
  "inventory_level": {
    "inventory_item_id": 457924702,
    "location_id": 192722535,
    "available": 0,
    "updated_at": "2020-09-08T13:25:09-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/192722535?inventory_item_id=457924702"
  }
}

Connecting an inventory item to a non-existent location fails and returns an error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 123,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 404 Not Found
{
  "errors": "Not Found"
}

Connecting an inventory item to a fulfillment service location without `"relocate_if_necessary": true` fails with a 422 error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 48752903,
  "inventory_item_id": 808950810
}

View Response

HTTP/1.1 422 Unprocessable Entity
{
  "errors": [
    "An item cannot be active at more than one location if one of them is a fulfillment service location."
  ]
}

Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 192722535,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 403 Forbidden
{
  "errors": [
    "Shop does not have multi-location enabled"
  ]
}

POST /admin/api/2020-04/inventory_levels/set.json

Sets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.

inventory_item_id required	The ID for the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
available required	Sets the available inventory quantity.
disconnect_if_necessary	Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. For more information, see Inventory levels and fulfillment service locations. (default: `false`)

Set the available inventory at a location

POST /admin/api/2020-07/inventory_levels/set.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available": 42
}

View Response

HTTP/1.1 200 OK
{
  "inventory_level": {
    "inventory_item_id": 808950810,
    "location_id": 905684977,
    "available": 42,
    "updated_at": "2020-09-08T13:25:13-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
  }
}

Setting an inventory item to a fulfillment service without `"disconnect_if_necessary": true` fails with a 422 error

POST /admin/api/2020-07/inventory_levels/set.json

{
  "location_id": 61629186,
  "inventory_item_id": 808950810,
  "available": 42
}

View Response

HTTP/1.1 422 Unprocessable Entity
{
  "errors": [
    "An item cannot be active at more than one location if one of them is a fulfillment service location."
  ]
}

Version 2020-07 (Latest)

An inventory level represents the available quantity of an inventory item at a specific location.

Each inventory level belongs to one inventory item and has one location. For every location where an inventory item is available, there's an inventory level that represents the inventory item's quantity at that location:

Inventory levels and fulfillment service locations

A fulfillment service location has a 1:1 relationship with a third-party fulfillment service. When an app creates a new fulfillment service on a store, Shopify automatically creates a location that's associated with that fulfillment service. The FulfillmentService resource has a location_id property, which identifies the associated location.

An inventory item connected to a fulfillment service location can't be connected to any other locations at the same time:

Connecting an inventory item to a fulfillment service location

When you work with items that have been or will be connected a fulfillment location, you should include "relocate_if_necessary": true in the body of the request. There are two situations where you might do this:

connecting an inventory item to a fulfillment service location and disconnecting it from all standard locations
connecting an inventory item to one or more standard locations and disconnecting it from a fulfillment service location

If relocate_if_necessary is true, then all inventory for the item is relocated to the new location and disconnected from any other locations. If a fulfillment service location is involved but relocate_if_necessary is false, then the connection will fail. If no fulfillment service is involved, then the property is ignored and no inventory is relocated.

Setting the inventory level at a fulfillment service location

When you set inventory for a location, the inventory item is connected to the location if they are not already connected. If the item has been or will be connected to a fulfillment service location, then you should include "disconnect_if_necessary": true in the body of the request. There are two situations where you might do this:

setting inventory for an inventory item at a fulfillment service location when the item is already connected to one or more standard locations
setting inventory for an inventory item at a standard location when the item is already connected to a fulfillment service location

The inventory at the new location is set to the value of the available property. The inventory for other locations is set to 0 and the locations are disconnected from the inventory item.

If disconnect_if_necessary is set to false when you set inventory at a location and a fulfillment service location is involved, then the action will fail. If no fulfillment service location is involved, then this property is ignored.

What you can do with InventoryLevel

The Shopify API lets you do the following with the InventoryLevel resource. More detailed versions of these general actions may be available:

GET /admin/api/2020-07/inventory_levels.json Retrieves a list of inventory levels
POST /admin/api/2020-07/inventory_levels/adjust.json Adjusts the inventory level of an inventory item at a location
DELETE /admin/api/2020-07/inventory_levels.json?inventory_item_id=808950810&location_id=905684977 Deletes an inventory level from a location
POST /admin/api/2020-07/inventory_levels/connect.json Connects an inventory item to a location
POST /admin/api/2020-07/inventory_levels/set.json Sets the inventory level for an inventory item at a location

InventoryLevel properties

available	`"available": 6` The quantity of inventory items available for sale. Returns `null` if the inventory item is not tracked.
inventory_item_id read-only	`"inventory_item_id": 450789469` The ID of the inventory item that the inventory level belongs to.
location_id	`"location_id": 40642626` The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
updated_at read-only	`"updated_at": "2012-08-24T14:01:47-04:00"` The date and time (ISO 8601 format) when the inventory level was last modified.

Endpoints

GET /admin/api/2020-07/inventory_levels.json

Retrieves a list of inventory levels.

You must include inventory_item_ids, location_ids, or both as filter parameters.

Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

inventory_item_ids	A comma-separated list of inventory item IDs. (maximum: `50`)
location_ids	A comma-separated list of location IDs. To find the ID of a location, use the Location resource. (maximum: `50`)
limit	The maximum number of results to show. (default: `50`, maximum: `250`)
updated_at_min	Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).

Retrieving inventory levels without specifying `location_ids` or `inventory_item_ids` fails and returns an error

GET /admin/api/2020-07/inventory_levels.json

View Response

HTTP/1.1 422 Unprocessable Entity

Retrieve inventory levels for the specified inventory items and locations

GET /admin/api/2020-07/inventory_levels.json?inventory_item_ids=808950810,39072856&location_ids=905684977,487838322

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 808950810,
      "location_id": 487838322,
      "available": 9,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 487838322,
      "available": 27,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=39072856"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 905684977,
      "available": 3,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=39072856"
    }
  ]
}

Retrieve inventory levels for a single inventory item

GET /admin/api/2020-07/inventory_levels.json?inventory_item_ids=808950810

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 808950810,
      "location_id": 487838322,
      "available": 9,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    }
  ]
}

Retrieve inventory levels at a single location

GET /admin/api/2020-07/inventory_levels.json?location_ids=905684977

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 49148385,
      "location_id": 905684977,
      "available": 2,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=49148385"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 457924702,
      "location_id": 905684977,
      "available": 4,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=457924702"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 905684977,
      "available": 3,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=39072856"
    }
  ]
}

POST /admin/api/2020-07/inventory_levels/adjust.json

Adjusts the inventory level of an inventory item at a single location

inventory_item_id required	The ID of the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
available_adjustment required	The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, `"available_adjustment": 2` increases the current available quantity by 2, and `"available_adjustment": -3`decreases the current available quantity by 3.

Adjust the available quantity of an inventory item by 5 at a single location

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 200 OK
{
  "inventory_level": {
    "inventory_item_id": 808950810,
    "location_id": 905684977,
    "available": 6,
    "updated_at": "2020-09-08T13:25:03-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
  }
}

Adjusting inventory levels at a non-existent location fails and returns an error

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 404 Not Found
{
  "errors": "Not Found"
}

Adjusting inventory levels for an inventory item that is untracked fails and returns an error

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 422 Unprocessable Entity

DELETE /admin/api/2020-07/inventory_levels.json?inventory_item_id=808950810&location_id=905684977

Deletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.

inventory_item_id required	The ID for the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.

Delete an inventory level

DELETE /admin/api/2020-07/inventory_levels.json?inventory_item_id=808950810&location_id=905684977

View Response

HTTP/1.1 204 No Content

POST /admin/api/2020-07/inventory_levels/connect.json

Connects an inventory item to a location by creating an inventory level at that location.

When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.

inventory_item_id required	The ID of the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
relocate_if_necessary	Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations. (default: `false`)

Connect an inventory item to a location

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 192722535,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 201 Created
{
  "inventory_level": {
    "inventory_item_id": 457924702,
    "location_id": 192722535,
    "available": 0,
    "updated_at": "2020-09-08T13:25:09-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/192722535?inventory_item_id=457924702"
  }
}

Connecting an inventory item to a non-existent location fails and returns an error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 123,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 404 Not Found
{
  "errors": "Not Found"
}

Connecting an inventory item to a fulfillment service location without `"relocate_if_necessary": true` fails with a 422 error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 48752903,
  "inventory_item_id": 808950810
}

View Response

HTTP/1.1 422 Unprocessable Entity
{
  "errors": [
    "An item cannot be active at more than one location if one of them is a fulfillment service location."
  ]
}

Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 192722535,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 403 Forbidden
{
  "errors": [
    "Shop does not have multi-location enabled"
  ]
}

POST /admin/api/2020-07/inventory_levels/set.json

Sets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.

inventory_item_id required	The ID for the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
available required	Sets the available inventory quantity.
disconnect_if_necessary	Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. For more information, see Inventory levels and fulfillment service locations. (default: `false`)

Set the available inventory at a location

POST /admin/api/2020-07/inventory_levels/set.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available": 42
}

View Response

HTTP/1.1 200 OK
{
  "inventory_level": {
    "inventory_item_id": 808950810,
    "location_id": 905684977,
    "available": 42,
    "updated_at": "2020-09-08T13:25:13-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
  }
}

Setting an inventory item to a fulfillment service without `"disconnect_if_necessary": true` fails with a 422 error

POST /admin/api/2020-07/inventory_levels/set.json

{
  "location_id": 61629186,
  "inventory_item_id": 808950810,
  "available": 42
}

View Response

HTTP/1.1 422 Unprocessable Entity
{
  "errors": [
    "An item cannot be active at more than one location if one of them is a fulfillment service location."
  ]
}

Version 2020-10 (Release candidate)

An inventory level represents the available quantity of an inventory item at a specific location.

Each inventory level belongs to one inventory item and has one location. For every location where an inventory item is available, there's an inventory level that represents the inventory item's quantity at that location:

Inventory levels and fulfillment service locations

A fulfillment service location has a 1:1 relationship with a third-party fulfillment service. When an app creates a new fulfillment service on a store, Shopify automatically creates a location that's associated with that fulfillment service. The FulfillmentService resource has a location_id property, which identifies the associated location.

An inventory item connected to a fulfillment service location can't be connected to any other locations at the same time:

Connecting an inventory item to a fulfillment service location

When you work with items that have been or will be connected a fulfillment location, you should include "relocate_if_necessary": true in the body of the request. There are two situations where you might do this:

connecting an inventory item to a fulfillment service location and disconnecting it from all standard locations
connecting an inventory item to one or more standard locations and disconnecting it from a fulfillment service location

If relocate_if_necessary is true, then all inventory for the item is relocated to the new location and disconnected from any other locations. If a fulfillment service location is involved but relocate_if_necessary is false, then the connection will fail. If no fulfillment service is involved, then the property is ignored and no inventory is relocated.

Setting the inventory level at a fulfillment service location

When you set inventory for a location, the inventory item is connected to the location if they are not already connected. If the item has been or will be connected to a fulfillment service location, then you should include "disconnect_if_necessary": true in the body of the request. There are two situations where you might do this:

setting inventory for an inventory item at a fulfillment service location when the item is already connected to one or more standard locations
setting inventory for an inventory item at a standard location when the item is already connected to a fulfillment service location

The inventory at the new location is set to the value of the available property. The inventory for other locations is set to 0 and the locations are disconnected from the inventory item.

If disconnect_if_necessary is set to false when you set inventory at a location and a fulfillment service location is involved, then the action will fail. If no fulfillment service location is involved, then this property is ignored.

What you can do with InventoryLevel

The Shopify API lets you do the following with the InventoryLevel resource. More detailed versions of these general actions may be available:

GET /admin/api/2020-10/inventory_levels.json Retrieves a list of inventory levels
POST /admin/api/2020-10/inventory_levels/adjust.json Adjusts the inventory level of an inventory item at a location
DELETE /admin/api/2020-10/inventory_levels.json?inventory_item_id=808950810&location_id=905684977 Deletes an inventory level from a location
POST /admin/api/2020-10/inventory_levels/connect.json Connects an inventory item to a location
POST /admin/api/2020-10/inventory_levels/set.json Sets the inventory level for an inventory item at a location

InventoryLevel properties

available	`"available": 6` The quantity of inventory items available for sale. Returns `null` if the inventory item is not tracked.
inventory_item_id read-only	`"inventory_item_id": 450789469` The ID of the inventory item that the inventory level belongs to.
location_id	`"location_id": 40642626` The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
updated_at read-only	`"updated_at": "2012-08-24T14:01:47-04:00"` The date and time (ISO 8601 format) when the inventory level was last modified.

Endpoints

GET /admin/api/2020-10/inventory_levels.json

Retrieves a list of inventory levels.

You must include inventory_item_ids, location_ids, or both as filter parameters.

Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

inventory_item_ids	A comma-separated list of inventory item IDs. (maximum: `50`)
location_ids	A comma-separated list of location IDs. To find the ID of a location, use the Location resource. (maximum: `50`)
limit	The maximum number of results to show. (default: `50`, maximum: `250`)
updated_at_min	Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).

Retrieving inventory levels without specifying `location_ids` or `inventory_item_ids` fails and returns an error

GET /admin/api/2020-07/inventory_levels.json

View Response

HTTP/1.1 422 Unprocessable Entity

Retrieve inventory levels for the specified inventory items and locations

GET /admin/api/2020-07/inventory_levels.json?inventory_item_ids=808950810,39072856&location_ids=905684977,487838322

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 808950810,
      "location_id": 487838322,
      "available": 9,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 487838322,
      "available": 27,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=39072856"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 905684977,
      "available": 3,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=39072856"
    }
  ]
}

Retrieve inventory levels for a single inventory item

GET /admin/api/2020-07/inventory_levels.json?inventory_item_ids=808950810

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 808950810,
      "location_id": 487838322,
      "available": 9,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/690933842?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    }
  ]
}

Retrieve inventory levels at a single location

GET /admin/api/2020-07/inventory_levels.json?location_ids=905684977

View Response

HTTP/1.1 200 OK
{
  "inventory_levels": [
    {
      "inventory_item_id": 49148385,
      "location_id": 905684977,
      "available": 2,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=49148385"
    },
    {
      "inventory_item_id": 808950810,
      "location_id": 905684977,
      "available": 1,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
    },
    {
      "inventory_item_id": 457924702,
      "location_id": 905684977,
      "available": 4,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=457924702"
    },
    {
      "inventory_item_id": 39072856,
      "location_id": 905684977,
      "available": 3,
      "updated_at": "2020-09-08T13:05:54-04:00",
      "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=39072856"
    }
  ]
}

POST /admin/api/2020-10/inventory_levels/adjust.json

Adjusts the inventory level of an inventory item at a single location

inventory_item_id required	The ID of the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
available_adjustment required	The amount to adjust the available inventory quantity. Send negative values to subtract from the current available quantity. For example, `"available_adjustment": 2` increases the current available quantity by 2, and `"available_adjustment": -3`decreases the current available quantity by 3.

Adjust the available quantity of an inventory item by 5 at a single location

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 200 OK
{
  "inventory_level": {
    "inventory_item_id": 808950810,
    "location_id": 905684977,
    "available": 6,
    "updated_at": "2020-09-08T13:25:03-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
  }
}

Adjusting inventory levels at a non-existent location fails and returns an error

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 404 Not Found
{
  "errors": "Not Found"
}

Adjusting inventory levels for an inventory item that is untracked fails and returns an error

POST /admin/api/2020-07/inventory_levels/adjust.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available_adjustment": 5
}

View Response

HTTP/1.1 422 Unprocessable Entity

DELETE /admin/api/2020-10/inventory_levels.json?inventory_item_id=808950810&location_id=905684977

Deletes an inventory level of an inventory item at a location. Deleting an inventory level for an inventory item removes that item from the specified location. Every inventory item must have at least one inventory level. To move inventory to another location, first connect the inventory item to another location, and then delete the previous inventory level.

inventory_item_id required	The ID for the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.

Delete an inventory level

DELETE /admin/api/2020-07/inventory_levels.json?inventory_item_id=808950810&location_id=905684977

View Response

HTTP/1.1 204 No Content

POST /admin/api/2020-10/inventory_levels/connect.json

Connects an inventory item to a location by creating an inventory level at that location.

When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.

inventory_item_id required	The ID of the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
relocate_if_necessary	Whether inventory for any previously connected locations will be relocated. This property is ignored when no fulfillment service location is involved. For more information, see Inventory levels and fulfillment service locations. (default: `false`)

Connect an inventory item to a location

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 192722535,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 201 Created
{
  "inventory_level": {
    "inventory_item_id": 457924702,
    "location_id": 192722535,
    "available": 0,
    "updated_at": "2020-09-08T13:25:09-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/192722535?inventory_item_id=457924702"
  }
}

Connecting an inventory item to a non-existent location fails and returns an error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 123,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 404 Not Found
{
  "errors": "Not Found"
}

Connecting an inventory item to a fulfillment service location without `"relocate_if_necessary": true` fails with a 422 error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 48752903,
  "inventory_item_id": 808950810
}

View Response

HTTP/1.1 422 Unprocessable Entity
{
  "errors": [
    "An item cannot be active at more than one location if one of them is a fulfillment service location."
  ]
}

Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error

POST /admin/api/2020-07/inventory_levels/connect.json

{
  "location_id": 192722535,
  "inventory_item_id": 457924702
}

View Response

HTTP/1.1 403 Forbidden
{
  "errors": [
    "Shop does not have multi-location enabled"
  ]
}

POST /admin/api/2020-10/inventory_levels/set.json

Sets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first. When connecting inventory items to locations, it's important to understand the rules around fulfillment service locations.

inventory_item_id required	The ID for the inventory item.
location_id required	The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
available required	Sets the available inventory quantity.
disconnect_if_necessary	Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. This property is ignored when no fulfillment service is involved. For more information, see Inventory levels and fulfillment service locations. (default: `false`)

Set the available inventory at a location

POST /admin/api/2020-07/inventory_levels/set.json

{
  "location_id": 905684977,
  "inventory_item_id": 808950810,
  "available": 42
}

View Response

HTTP/1.1 200 OK
{
  "inventory_level": {
    "inventory_item_id": 808950810,
    "location_id": 905684977,
    "available": 42,
    "updated_at": "2020-09-08T13:25:13-04:00",
    "admin_graphql_api_id": "gid://shopify/InventoryLevel/905684977?inventory_item_id=808950810"
  }
}

Setting an inventory item to a fulfillment service without `"disconnect_if_necessary": true` fails with a 422 error

POST /admin/api/2020-07/inventory_levels/set.json

{
  "location_id": 61629186,
  "inventory_item_id": 808950810,
  "available": 42
}

View Response

HTTP/1.1 422 Unprocessable Entity
{
  "errors": [
    "An item cannot be active at more than one location if one of them is a fulfillment service location."
  ]
}

InventoryLevel

Inventory levels and fulfillment service locations

Connecting an inventory item to a fulfillment service location

Setting the inventory level at a fulfillment service location

What you can do with InventoryLevel

InventoryLevel properties

Endpoints

Retrieving inventory levels without specifying location_ids or inventory_item_ids fails and returns an error

Retrieve inventory levels for the specified inventory items and locations

Retrieve inventory levels for a single inventory item

Retrieve inventory levels at a single location

Adjust the available quantity of an inventory item by 5 at a single location

Adjusting inventory levels at a non-existent location fails and returns an error

Adjusting inventory levels for an inventory item that is untracked fails and returns an error

Delete an inventory level

Connect an inventory item to a location

Connecting an inventory item to a non-existent location fails and returns an error

Connecting an inventory item to a fulfillment service location without "relocate_if_necessary": true fails with a 422 error

Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error

Set the available inventory at a location

Setting an inventory item to a fulfillment service without "disconnect_if_necessary": true fails with a 422 error

Inventory levels and fulfillment service locations

Connecting an inventory item to a fulfillment service location

Setting the inventory level at a fulfillment service location

What you can do with InventoryLevel

InventoryLevel properties

Endpoints

Retrieving inventory levels without specifying location_ids or inventory_item_ids fails and returns an error

Retrieve inventory levels for the specified inventory items and locations

Retrieve inventory levels for a single inventory item

Retrieve inventory levels at a single location

Adjust the available quantity of an inventory item by 5 at a single location

Adjusting inventory levels at a non-existent location fails and returns an error

Adjusting inventory levels for an inventory item that is untracked fails and returns an error

Delete an inventory level

Connect an inventory item to a location

Connecting an inventory item to a non-existent location fails and returns an error

Connecting an inventory item to a fulfillment service location without "relocate_if_necessary": true fails with a 422 error

Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error

Set the available inventory at a location

Setting an inventory item to a fulfillment service without "disconnect_if_necessary": true fails with a 422 error

Inventory levels and fulfillment service locations

Connecting an inventory item to a fulfillment service location

Setting the inventory level at a fulfillment service location

What you can do with InventoryLevel

InventoryLevel properties

Endpoints

Retrieving inventory levels without specifying location_ids or inventory_item_ids fails and returns an error

Retrieve inventory levels for the specified inventory items and locations

Retrieve inventory levels for a single inventory item

Retrieve inventory levels at a single location

Adjust the available quantity of an inventory item by 5 at a single location

Adjusting inventory levels at a non-existent location fails and returns an error

Adjusting inventory levels for an inventory item that is untracked fails and returns an error

Delete an inventory level

Connect an inventory item to a location

Connecting an inventory item to a non-existent location fails and returns an error

Connecting an inventory item to a fulfillment service location without "relocate_if_necessary": true fails with a 422 error

Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error

Set the available inventory at a location

Setting an inventory item to a fulfillment service without "disconnect_if_necessary": true fails with a 422 error

Inventory levels and fulfillment service locations

Connecting an inventory item to a fulfillment service location

Setting the inventory level at a fulfillment service location

What you can do with InventoryLevel

InventoryLevel properties

Endpoints

Retrieving inventory levels without specifying location_ids or inventory_item_ids fails and returns an error

Retrieve inventory levels for the specified inventory items and locations

Retrieve inventory levels for a single inventory item

Retrieve inventory levels at a single location

Adjust the available quantity of an inventory item by 5 at a single location

Adjusting inventory levels at a non-existent location fails and returns an error

Adjusting inventory levels for an inventory item that is untracked fails and returns an error

Delete an inventory level

Connect an inventory item to a location

Connecting an inventory item to a non-existent location fails and returns an error

Connecting an inventory item to a fulfillment service location without "relocate_if_necessary": true fails with a 422 error

Connecting an inventory item to a location when the store hasn't enabled multiple locations fails with a 403 error

Set the available inventory at a location

Retrieving inventory levels without specifying `location_ids` or `inventory_item_ids` fails and returns an error

Connecting an inventory item to a fulfillment service location without `"relocate_if_necessary": true` fails with a 422 error

Setting an inventory item to a fulfillment service without `"disconnect_if_necessary": true` fails with a 422 error

Retrieving inventory levels without specifying `location_ids` or `inventory_item_ids` fails and returns an error

Connecting an inventory item to a fulfillment service location without `"relocate_if_necessary": true` fails with a 422 error

Setting an inventory item to a fulfillment service without `"disconnect_if_necessary": true` fails with a 422 error

Retrieving inventory levels without specifying `location_ids` or `inventory_item_ids` fails and returns an error

Connecting an inventory item to a fulfillment service location without `"relocate_if_necessary": true` fails with a 422 error

Setting an inventory item to a fulfillment service without `"disconnect_if_necessary": true` fails with a 422 error

Retrieving inventory levels without specifying `location_ids` or `inventory_item_ids` fails and returns an error

Connecting an inventory item to a fulfillment service location without `"relocate_if_necessary": true` fails with a 422 error

Setting an inventory item to a fulfillment service without `"disconnect_if_necessary": true` fails with a 422 error

Retrieving inventory levels without specifying `location_ids` or `inventory_item_ids` fails and returns an error

Connecting an inventory item to a fulfillment service location without `"relocate_if_necessary": true` fails with a 422 error

Setting an inventory item to a fulfillment service without `"disconnect_if_necessary": true` fails with a 422 error