Ordergroove Developer Documentation

{
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "groups": [
    {
      "name": "subscription",
      "group_type": "eligibility"
    }
  ],
  "name": "Medium Roast Coffee Bag",
  "price": "10.00",
  "image_url": "http://some.image.com",
  "detail_url": "http://some.store.com/medium-roast-coffee-bag",
  "external_product_id": "48398751432995",
  "sku": "48398751432995",
  "autoship_enabled": true,
  "premier_enabled": 0,
  "created": "2024-05-09 15:20:09",
  "last_update": "2024-05-13 08:56:36",
  "live": true,
  "discontinued": false,
  "product_type": "standard",
  "autoship_by_default": true,
  "every": null,
  "every_period": null,
  "offer_profile": null
}

Returns the delivery product a rotating product reveals at a given order placement date (time-window rotation) or ordinal (ordinal rotation): the product of the rule with the latest starting_date or starting_ordinal at or before the requested value.

date defaults to the current time and ordinal to 0, so by default the response is the product currently in rotation (time-window) or the product delivered in the checkout order (ordinal). An ordinal past the last rule returns the last product, because cyclical rotation isn’t applied here. A date before the earliest rule returns 404.

To see every rule, call List or Retrieve with include_product_selection_rules=true.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Path parameters

product_idstringRequired

Merchant product ID

Query parameters

datestringOptional

Date of order placement (ISO8601 format, Timezone required)

ordinalintegerOptional

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

Response

200

merchantstringOptional

groupslist of objectsOptional

namestringOptional

pricestringOptional

image_urlstringOptional

detail_urlstringOptional

external_product_idstringOptional

skustringOptional

autoship_enabledbooleanOptionalDefaults to true

premier_enabledintegerOptionalDefaults to 0

createdstringOptional

last_updatestringOptional

livebooleanOptionalDefaults to true

discontinuedbooleanOptionalDefaults to true

extra_dataanyOptional

product_typestringOptional

autoship_by_defaultbooleanOptionalDefaults to true

everyinteger or nullOptional

every_periodinteger or nullOptional

offer_profilestring or nullOptional

incentive_groupanyOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error