GET
/
v1
/
retailers
/
{retailer_pk}
/
products
/

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

since
number

Past date till current (Unix epoch format)

search
string

Search by variant ID, identifier, UPC, name, and retailer_identifier

search_id
number

Variant ID

search_name
string

Search by name

search_upc
string

Search by UPC

search_sku
string

Search by SKU

retailer_sku
string

Retailer SKU

product_search
string

Search by product name, identifier, or brand category

attribute
string

Product attributes

retailer_attribute
string

Retailer attribute

retailer_id
number

Retailer ID

brand_id
number[]

Vendor IDs. Multiple values may be added, separated by commas.

brand_code
string[]

Brand codes. Multiple values may be added, separated by commas.

brand_category
string[]

Brand categories. Multiple values may be separated by commas.

manufacturer_id
number[]

Manufacturer IDs. Multiple values may be separated by commas.

connection_id
number

Connection ID.

manufacturer_code
string[]

Manufacturer codes. Multiple values may be separated by commas.

identifier
string

Stock Keeping Unit (SKU), unique identifier of a product

parent_identifier
string

SKU of parent product

is_discontinued
number

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

is_sellable
number

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

in_stock
number

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

taxonomy_id
string

Taxonomy ID

has_images
number

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

has_shipping
number

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

decision
string

Internal only

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)

Was this page helpful?

Get details of a single variantUpdate attributes of a variant