Get a list of variant inventory positions

Get variants and their inventory details, including total inventory and inventory based on location.To get items with inventory updated since a Unix epoch Time, pass the updated_at_{operator} as a query paramater, where {operator} is
lt (less than)
lte (less than or equal)
gt (greater than)
gte (greater than or equal).

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

retailer_pk

number

required

Retailer ID

Query Parameters

identifier

string

Unique identifier assigned to the variant by the brand

brand_id

integer[]

Brand ID. Multiple values may be separated by commas

connection_id

number

Connection ID. Multiple values may be separated by comma.

parent_identifier

string[]

Parent product identifier. Multiple values may be separated by commas

retailer_sku

string

Retailer SKU

in_stock

integer

1: Variant is in stock <br /> 0: Variant is out of stock

ignore_deleted

integer

1: Ignore deleted variant <br /> 0: Include deleted variant

is_sellable

integer

1: Variant is sellable <br /> 0: Variant is not sellable

is_discontinued

integer

1: Variant is discontinued <br /> 0: Variant is active

no_ead

integer

1: Variant has no estimated availability date <br /> 0: Variant has estimated delivery date

no_stock_no_ead

number

1: Variant does not have an estimated availability date. <br /> 0: Variant has an estimated availability

inventory_updated_at_lt

number

Inventory update was less than specified Time (Unix epoch format)

inventory_updated_at_lte

number

Inventory update was less than or equal to specified Time (Unix epoch format) Time

inventory_updated_at_gt

number

Inventory update was greater than specified Time (Unix epoch format)

inventory_updated_at_gte

number

Inventory update was greater than or equal to a specified Time (Unix epoch format)

order_by

string

Sorting criteria

page

integer

Page number within the paginated result set

limit

integer

Number of records per page

Response

200 - application/json

count

integer

required

Total number of records

results

object[]

required

Show child attributes

next

string | null

Next page (applicable in a paginated response)

previous

string | null

Previous page (applicable in a paginated response)