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…

Name	Type	Description	Example
public_id	string	One-Time Incentive ID	8637c3fe9b7011eaa2c1bc764e107990
external_code	string	External Code	awesome_discount
description	string	Description	One-Time Incentive
merchant	string	Merchant ID	ac4f7938383a11e89ecbbc764e1107f2
customer	string	Customer ID	00026001
order	string	Order ID	c4e05d04ccc411e8ada3bc764e101db1
created	string	Datetime of creation	2020-05-21 09:36:57
last_updated	string	Datetime of last update	2020-05-21 09:36:57
incentive	object	Incentive object
applied_at	string	Datetime of when the incentive was applied	2020-05-21 09:36:57

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

200200

404404