get https://restapi.ordergroove.com/products/
Returns a list of all merchant's products that are autoship enabled and not discontinued.
Authentication
Response Body Definitions
| Name | Type | Description | Example |
|---|---|---|---|
| merchant | string | Merchant ID | "ac4f7938383a11e89ecbbc764e1107f2" |
| groups | array | Array of group objects | [{ "group_type": "foo", "name": "bar" }, {...}] |
| name | string | Product name | "test" |
| price | string | Product price | "12.99" |
| image_url | string | Product image URL | "ordergroove.com/product/product_id" |
| detail_url | string | Product detail image URL | "ordergroove.com/product/product_id" |
| external_product_id | string | Merchant product ID | "62900-W01" |
| sku | string | Product SKU | "123456789" |
| autoship_enabled | boolean | Autoship option enabled for product: enabled = true | false |
| prepaid_eligible | boolean | Product prepaid eligibility | true |
| premier_enabled | integer | 0 | |
| created | string | Date of product creation | "2017-02-29 12:00:00" |
| last_update | string | Date of last product update | "09/3099" |
| live | boolean | Account status: active = True | True |
| discontinued | boolean | Product status: discontinued = True | False |
| extra_data | string | Raw JSON string that should be JSON.parse() as key/value store for any extra information. | "{"some": "extra", "fields": "here"}" |
| product_type | string | Product type | "standard" |
| autoship_by_default | boolean | true | |
| every | integer | Number of periods | 30 |
| every_period | integer | Type of period | 1 |
| offer_profile | string | Offer profile associated with product | "OfferProfileId" |
| incentive_group | string |
When the query param ?include_product_selection_rules=true is provided for a rotating product we will return all the selection rule configuration:
[
{
"public_id":"e1a61e620ed411ef8740767250df1ed7",
"selection_rule_type":"TIME_WINDOW",
"product_selection_list_elements":[
{
"public_id":"e1a626000ed411ef8740767250df1ed7",
"product":"48398751432995",
"starting_date":"2024-05-01T00:00:00Z"
},
{
"public_id":"e1a62b140ed411ef8740767250df1ed7",
"product":"48398752317731",
"starting_date":"2024-06-01T00:00:00Z"
},
{
"public_id":"e1a62fe20ed411ef8740767250df1ed7",
"product":"48398760149283",
"starting_date":"2024-07-01T00:00:00Z"
}
]
}
]
[
{
"public_id":"e1a61e620ed411ef8740767250df1ed7",
"selection_rule_type":"ORDINAL",
"product_selection_list_elements":[
{
"public_id":"e1a626000ed411ef8740767250df1ed7",
"product":"48398751432995",
"starting_ordinal":"0"
},
{
"public_id":"e1a62b140ed411ef8740767250df1ed7",
"product":"48398752317731",
"starting_ordinal":"1"
},
{
"public_id":"e1a62fe20ed411ef8740767250df1ed7",
"product":"48398760149283",
"starting_ordinal":"4"
}
]
}
]