List

get

https://restapi.ordergroove.com/one_time_incentives/

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

order

string

Order Public ID

customer

string

Merchant Customer ID

external_code

string

External code on the OTD

item

string

Item Public ID

created

date

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

created_start

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_end

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_updated

date

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

last_updated_start

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_end

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_at

date

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

applied_at_start

date

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

applied_at_end

date

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

include_item_level

boolean

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

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

404404