List

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

🔐

Authentication

✔️ Application API Scope

✔️ Storefront API Scope

Response Body Definitions

NameTypeDescriptionExample
merchantstringMerchant ID"ac4f7938383a11e89ecbbc764e1107f2"
groupsarrayArray of group objects[{
"group_type": "foo",
"name": "bar"
}, {...}]
namestringProduct name"test"
pricestringProduct price"12.99"
image_urlstringProduct image URL"ordergroove.com/product/product_id"
detail_urlstringProduct detail image URL"ordergroove.com/product/product_id"
external_product_idstringMerchant product ID"62900-W01"
skustringProduct SKU"123456789"
autoship_enabledbooleanAutoship option enabled for product: enabled = truefalse
premier_enabledinteger0
createdstringDate of product creation"2017-02-29 12:00:00"
last_updatestringDate of last product update"09/3099"
livebooleanAccount status: active = TrueTrue
discontinuedbooleanProduct status:
discontinued = True
False
extra_datastringRaw JSON string that should be JSON.parse() as key/value store for any extra information."{"some": "extra", "fields": "here"}"
product_typestringProduct type"standard"
autoship_by_defaultbooleantrue
everyintegerNumber of periods30
every_periodintegerType of period1
offer_profilestringOffer profile associated with product"OfferProfileId"
incentive_groupstring
Language