Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Inventory levels

Returns a list of inventory levels

Get all Inventory levels.

get/inventory-levels

Query parameters

updatedTimeobject

A filter on the list based on the updatedTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt—return values where the updatedTime field is after this timestamp
  • gte—return values where the updatedTime field is after or equal to this timestamp
  • lt—return values where the updatedTime field is before this timestamp
  • lte—return values where the updatedTime field is before or equal to this timestamp
inventoryItemIdsstring[] required

Only return inventory levels for these inventory items.

shipToCountrystring

Only return inventory levels for locations that ship to this country.

availableboolean

Only return available (i.e. greater than zero) inventory levels.

Response

200 OK

Example response

{
  "data": [
    {
      "locationId": "afe95639-8181-4b66-86a6-1a9493d5419d",
      "inventoryItemId": "ce4ce2de-530c-4da2-bf8a-f0f8cf059095",
      "available": true,
      "availableQuantity": 6,
      "availableTime": "2018-04-25T20:36:00Z",
      "updatedTime": "2018-04-25T20:36:00Z"
    }
  ]
}