v1

latestOpenAPI 3.1.02026-07-24920300.7 KB

Retrieve Rotating Delivery Product

Returns what product will be revealed at a given order placement date or a given ordinal integer in the series

get/products/{product_id}/rotating_delivery_product/

Path parameters

product_idstring required

Merchant product ID

Query parameters

datestring

Date of order placement (ISO8601 format, Timezone required)

ordinalinteger

Delivery "position" for the product in the ordinal planned sequence

Response

200

merchantstring

namestring

pricestring

image_urlstring

detail_urlstring

external_product_idstring

skustring

autoship_enabledboolean

premier_enabledinteger

createdstring

last_updatestring

liveboolean

discontinuedboolean

{"stackTrail":"paths:/products/{product_id}/rotating_delivery_product/:get:responses:200:content:application/json:schema:properties:extra_data","oasType":"schema","type":"unknown"}

product_typestring

autoship_by_defaultboolean

{"stackTrail":"paths:/products/{product_id}/rotating_delivery_product/:get:responses:200:content:application/json:schema:properties:every","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/products/{product_id}/rotating_delivery_product/:get:responses:200:content:application/json:schema:properties:every_period","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/products/{product_id}/rotating_delivery_product/:get:responses:200:content:application/json:schema:properties:offer_profile","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/products/{product_id}/rotating_delivery_product/:get:responses:200:content:application/json:schema:properties:incentive_group","oasType":"schema","type":"unknown"}

Example response

{
  "merchant": "{merchant_id}",
  "groups": [
    {
      "name": "subscription",
      "group_type": "eligibility"
    }
  ],
  "name": "Medium Roast Coffee Bag",
  "price": "10.00",
  "image_url": "(image_url}",
  "detail_url": "(detail_url}",
  "external_product_id": "48398751432995",
  "sku": "48398751432995",
  "autoship_enabled": true,
  "created": "2024-05-09 15:20:09",
  "last_update": "2024-05-13 08:56:36",
  "live": true,
  "product_type": "standard",
  "autoship_by_default": true
}