API Reference

Manage Time-Window Rotating Product

post https://restapi.ordergroove.com/products//selection_rules/time_window/manage/

This API allows you to take an existing standard product and configure it into a valid time-window rotating product or to manage an existing configuration.

🔐

Authentication

✔️ Application API Scope

✖️ Storefront API Scope

Time-Window selection rule validations

There are 4 validation rules for defining Time-Window selection rules:

  1. You must define at least one selection rule (we wouldn’t have anything to choose otherwise)
  2. One of the selection rules must have a starting date in the past (so that we don’t ever have an invalid state where we don’t know which product should be delivered)
  3. No two selection rules can have the same starting date (otherwise we wouldn’t know which product to choose between them, but you can have multiple selection rules with the same product)
  4. All starting dates must be in ISO8601 format with timezone. The timezone will be stored in UTC.

If validation fails no changes will be made to the product and no selection rules will be created, updated or deleted.


How to manage a Time-Window based Rotation using this API

  1. Choose an existing Standard or Rotating Product, if you don’t have one yet you will need to create one before you proceed with this configuration.
  2. Decide which selection rules you want to add, update or delete:
    1. All the rule validation explained above apply here, meaning that if you don’t follow them your update won't happen;
    2. Your changes will be reflected in all order items that haven’t had their Order Reminder sent or gone through the Send Now flow;
    3. You can add a new selection rule;
    4. You can delete an existing selection rule;
    5. You can update an existing selection rule with a different product and or starting date;
  3. Hit our API with your configuration, and your Time-Window based Rotating Product setup is complete!

Response Body Definitions

NameTypeDescriptionExample
array of objectsArray of object that reflect the current rotation configurationssee below

[
   {
      "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"
         }
      ]
   }
]

📘

To get the all the rules from the rotating product use get product or list product endpoints with ?include_product_selection_rules=true as a query param

Language