List

Returns a list of all merchant's products that are autoship enabled and not discontinued.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

A single string value used to search for products. The value in this parameter will be matched against product’s name, sku, or external_product_id, depending on the field specified in the "fields" parameter. e.g. /products?search=12345&fields=sku

string

Specifies which field (name, sku, or external_product_id) the "search" parameter value should be matched against. name – Matches the search value against the product’s name. sku – Matches the search value against the product’s SKU. external_product_id – Matches the search value against the product’s external product ID. e.g. /products?search=12345&fields=sku

string

Case insensitive partial match for Product ID or Name

string

By default the endpoint will only return products that are autoship enabled, but you can change the behavior by passing "all" to return all products regardless of their autoship status. You can also pass "false" to only return products that are NOT autoship enabled

string

By default the endpoint returns non-discontinued products, but you can change the behavior by passing "true" to also include discontinued products. You can also pass "strict" to only list the discontinued products

string

Product group's name

string

Product group's type

boolean
boolean

Account status: active = True

string

Product ID (could be passed multiple times in the query string to match multiple products). Note there is "[]" at the end of this field that is required

string
enum

Product Type

Allowed:
boolean
Defaults to false

For rotating products this param returns a product_selection_rules list with all selection_list_elements

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json