Ordergroove Developer Documentation

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "public_id": "8637c3fe9b7011eaa2c1bc764e107990",
      "external_code": "one_time_item_discount_with_limit",
      "description": "One-Time Item Discount With Limit",
      "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
      "customer": "00026001",
      "order": null,
      "item": "a6f7305aed3511eebfaf6a353c182723",
      "created": "2024-04-02 09:07:21",
      "last_updated": "2024-04-02 09:07:21",
      "expires": "2024-05-21 00:00:00",
      "stacking_type": "additional",
      "applied_at": null,
      "incentive": {
        "name": "One-Time Item Discount With Limit",
        "public_id": "b21f5d7a4c8e4f1c9a6d3e8f7b2c5a90",
        "type": "Discount",
        "discount_type": "Discount Amount",
        "target": "item",
        "field": "total_price",
        "value": "5.00",
        "threshold_field": null,
        "threshold_value": null,
        "limit_value": "10.00",
        "limit_policy": "fixed"
      }
    },
    {
      "public_id": "52df97b4f0fa11eeafd33e19316267db",
      "external_code": "one_time_order_total_discount",
      "description": "One-Time Order Total Discount",
      "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
      "customer": "00023208",
      "order": "a4f656f6ed4511eebfaf6a353c182723",
      "item": null,
      "created": "2024-04-02 09:19:40",
      "last_updated": "2024-04-02 09:19:40",
      "expires": "2024-05-21 00:00:00",
      "stacking_type": "base",
      "applied_at": "2024-04-03 09:00:15",
      "incentive": {
        "name": "One-Time Order Total Discount",
        "public_id": "a8cf39af36e14bdabb1a397360883096",
        "type": "Discount",
        "discount_type": "Discount Percent",
        "target": "order",
        "field": "sub_total",
        "value": "10.00",
        "threshold_field": null,
        "threshold_value": null
      }
    }
  ]
}

Returns a list all of One Time Incentives attached to subscriptions for a merchant, or a list of one incentives for an individual customer.

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.

Query parameters

orderstringOptional

Order Public ID

customerstringOptional

Merchant Customer ID

external_codestringOptional

External code on the OTD

itemstringOptional

Item Public ID

createddateOptional

One Time Incentives whose created date matches exactly (yyyy-mm-dd)

created_startdateOptional

One Time Incentives whose created datetime is greater than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

created_enddateOptional

One Time Incentives whose created datetime is less than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

last_updateddateOptional

One Time Incentives whose last updated date matches exactly (yyyy-mm-dd)

last_updated_startdateOptional

One Time Incentives whose last updated datetime is greater than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

last_updated_enddateOptional

One Time Incentives whose last updated datetime is less than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

applied_atdateOptional

One Time Incentives applied on the specified date (yyyy-mm-dd)

applied_at_startdateOptional

One Time Incentives applied after or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

applied_at_enddateOptional

One Time Incentives applied before or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

include_item_levelbooleanOptional

If the list is filtered by order, include also the One Time Incentives for all the items linked to this order

Response

200

Errors

404

Not Found Error