GET
/
v1
/
retailers
/
{retailer_pk}
/
variants
/

Authorizations

Authorization
string
headerrequired

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

Path Parameters

retailer_pk
number
required

Query Parameters

inventory_updated_at_lt
number

Inventory updated date is less than specified date (Unix epoch format)

inventory_updated_at_lte
number

Inventory updated date is less than or equal to specified date (Unix epoch format)

inventory_updated_at_gt
number

Inventory updated date is greater than specified date (Unix epoch format)

inventory_updated_at_gte
number

Inventory updated date is greater than or equal to specified date (Unix epoch format)

search
string

Search criteria

search_id
string

Search ID

search_name
string

Search name

search_upc
string

Search by UPC

search_sku
string

Search by SKUs

retailer_sku
string

Retailer SKUs

attribute
string

Product attribute

retailer_id
number

Retailer ID

brand_id
number[]

Vendor Ids. Multiple values may be separated by commas.

brand_code
string[]

Brand codes. Multiple values may be separated by commas.

manufacturer_id
number[]

Manufacturer IDs. Multiple values may be separated by commas.

manufacturer_code
string[]

Manufacturer codes. Multiple values may be separated by commas.

failed_rule_id
string

Failed rule ID

rule_id
number

Rule ID

ruleset_id
string

Ruleset ID

failure_type
string

Failure type

taxonomy_id
string

Taxonomy ID

retailer_category
string[]

Retailer category. Multiple values may be added, separated by commas.

retailer_category_id
number[]

Retailer category IDs

connection_id
number

Connection ID

product_id
number[]

Product IDs. Multiple values may be separated by commas.

parent_identifier
string[]

Parent identifiers. Multiple values may be separated by commas.

is_replenishable
number

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

is_discontinued
number

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

is_sellable
number

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

in_stock
number

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

has_images
number

1: Variant has images <br /> 0: Variant does not have images.

has_shipping
number

1: Variant has shipping <br /> 0: Variant does not have shipping.

order_by
string

Sorting preference

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
next
string | null

Next page (applicable in a paginated response)

previous
string | null

Previous page (applicable in a paginated response)