List
Returns a list of all merchant's products that are autoship enabled and not discontinued.
Authentication
x-api-keystring
API Key authentication via header
Query parameters
search
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
fields
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
id_or_name
Case insensitive partial match for Product ID or Name
autoship_enabled
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
allow_discontinued
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
group_name
Product group's name
group_type
Product group's type
autoship_by_default
live
Account status: active = True
external_product_ids[]
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
product_type
Product Type
Allowed values:
include_product_selection_rules
For rotating products this param returns a product_selection_rules list with all selection_list_elements
Response
200
count
next
previous
results
Errors
403
Forbidden Error
404
Not Found Error