Ordergroove Developer Documentation

[
  {
    "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"
      }
    ],
    "configuration": {
      "reveal_moment": "ORDER_PLACEMENT",
      "cyclical_rotation_enabled": false,
      "pricing_policy": "BEST_PRICE"
    }
  }
]

This API allows you to take an existing standard product and configure it into a valid ordinal rotating product or to manage an existing configuration. This endpoint accepts the Application API Scope only. Storefront API Scope signatures are rejected.

Authentication

x-api-keystring

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

Path parameters

product_idstringRequired

Merchant product ID

Request

This endpoint expects an object.

createlist of objectsOptional

Add new selection rules for your rotation

updatelist of objectsOptional

Update existing selection rules

deletelist of stringsOptional

Delete existing selection rules with public ids to be deleted , ex: [“85eae83c245111eeb185acde48001122”,“b3928a0c3c4211eeac2bacde48001122”]

configurationobjectOptional

Configures the rotation product

Response

200

public_idstringOptional

selection_rule_typestringOptional

product_selection_list_elementslist of objectsOptional

configurationobjectOptional