Retrieve detailed inventory data

GET

/v1/inventory

curl --request GET \
  --url 'https://api.zentail.com/v1/inventory?activeOnly=false&isCaseSensitive=true' \
  --header 'Authorization: Bearer <token>'

Retrieve inventory data for SKUs with various filters. One of lastUpdatedTs, skus, warehouses is required to be passed in as a parameters.

Authorizations

• zentail_oauth
  inventory
• zentail_oauth
  inventory:self
• zentail_oauth
  legacy

Parameters

Query Parameters

activeOnly

boolean

lastUpdatedTs

string

Providing lastUpdateTs returns inventory for all SKUs updated after that timestamp.

skus

Array<string>

If a list of SKUs is provided, lastUpdatedTs and warehouses are ignored.

isCaseSensitive

boolean

default: true

If this is true, a case-sensitive match will be used to search for the ‘skus’ provided. If false, as case-insensitive search will be used. Default value is true.

warehouses

Array<integer>

If a list of warehouses is provided, inventory for products with non-zero inventory in those warehouses will be returned.

pageLength

integer

Passing this will return the number of Inventory objects specified, otherwise defaults to 25.

nextToken

string

Passing this will return the next page of a previous call (we will disregard all other parameters provided). You can find nextToken in the response from a previous GET inventory call.

Responses

200

Success

Media typeapplication/json

object

results

Array<object>

object

SKU

string

active

boolean

standardProductId

Depending on the type defined in standardProductIdType this field contains either the UPC, EAN, ISBN, or GTIN for this product.

string

standardProductIdType

One of UPC, EAN, ISBN or GTIN.

string

totalAvailableQuantity

This is the total quantity across all warehouses that is made available for sale on the marketplaces. This does not include stock committed or reserved for various sales orders.

integer

warehouses

Array<object>

object

warehouseName

The Name of the warehouse.

string

warehouseUniqueId

Unique identifier for the warehouse as recognized by the application.

string

availableQuantity

This is the quantity from this warehouse that is made available for sale on the marketplaces. This does not include stock committed or reserved for various sales orders.

integer

assembledQuantity

Inventory for Kits with assembled quantity.

integer

nullable

inventoryLocations

Bins are located within a warehouse.

Array<object>

object

binLocation

Name of the Bin

string

quantity

Quantity in the Bin

integer

updatedTs

Timestamp quantity for this product in this warehouse was last updated.

string format: date-time

inboundShipments

Array<object>

object

quantity

This is the quantity that is inbound for this product in this warehouse.

integer

expectedDeliveryDate

This is the date the shipment is expected to arrive at the warehouse.

string format: date

tracking

Tracking for the shipment associated.

string

carrier

Carrier for the shipment associated.

string

lastInventoryUpdateTs

Timestamp quantity for this product was last updated across all warehouses.

string format: date-time

errors

Array<string>

pagination

object

hasNext

Indicates if there is an additional page. This is true if there is another page, otherwise it is false.

boolean

nextToken

If hasNext is true this provides the full URL for the next page of results.

string format: uri

Example^generated

{
  "results": [
    {
      "SKU": "example",
      "active": true,
      "standardProductId": "example",
      "standardProductIdType": "example",
      "totalAvailableQuantity": 1,
      "warehouses": [
        {
          "warehouseName": "example",
          "warehouseUniqueId": "example",
          "availableQuantity": 1,
          "assembledQuantity": 1,
          "inventoryLocations": [
            {
              "binLocation": "example",
              "quantity": 1
            }
          ],
          "updatedTs": "2026-04-15T12:00:00Z",
          "inboundShipments": [
            {
              "quantity": 1,
              "expectedDeliveryDate": "2026-04-15",
              "tracking": "example",
              "carrier": "example"
            }
          ]
        }
      ],
      "lastInventoryUpdateTs": "2026-04-15T12:00:00Z"
    }
  ],
  "errors": [
    "example"
  ],
  "pagination": {
    "hasNext": true,
    "nextToken": "https://example.com"
  }
}

400

Bad Request

Media typeapplication/json

object

errorCode

number

errorMessages

Array<string>

referenceId

string format: uuid

Example

{
  "errorCode": 400
}

403

Permission Denied

Media typeapplication/json

object

errorCode

number

errorMessages

Array<string>

referenceId

string format: uuid

Example

{
  "errorCode": 403
}

404

Not Found

Media typeapplication/json

object

errorCode

number

errorMessages

Array<string>

referenceId

string format: uuid

Example

{
  "errorCode": 404
}

500

Zentail Error

Media typeapplication/json

object

errorCode

number

errorMessages

Array<string>

referenceId

string format: uuid

errorMessage

string

Example

{
  "errorCode": 500
}

503

Zentail Error

Media typeapplication/json

object

errorCode

number

errorMessages

Array<string>

referenceId

string format: uuid

Example

{
  "errorCode": 503
}