ORordergroove

List

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

get/one_time_incentives/

Request

  • Base URL
    https://restapi.ordergroove.com
  • Auth
    • none
    • or API key in header x-api-key

Query parameters

orderstring

Order Public ID

customerstring

Merchant Customer ID

external_codestring

External code on the OTD

itemstring

Item Public ID

createdstring date

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

created_startstring date

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_endstring date

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_updatedstring date

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

last_updated_startstring date

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_endstring date

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_atstring date

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

applied_at_startstring date

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

applied_at_endstring date

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

include_item_levelboolean

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

Response

200

Changes

No recorded changes to this operation across all 1 revision of this API.