Ordergroove Developer Documentation

Creates a retention incentive eligibility rule with their incentive templates.

x-api-keystring

API Key authentication via header

This endpoint expects an object.

namestringRequired

Anything to help identify this rule

livebooleanRequired

Active / inactive state for this rule

min_days_since_last_claimintegerOptional

Minimum number of days since the last retention incentive has been claimed for a given customer

min_subscriber_orders_since_last_claimintegerOptional

Minimum number of orders that had to be placed since the last retention incentive was claimed for a given customer

incentive_templateslist of objectsOptional

200

public_idstring

namestring

merchantstring

livebooleanDefaults to true

min_days_since_last_claimintegerDefaults to 0

min_subscriber_orders_since_last_claimany

incentive_templateslist of objects

400

Bad Request Error

$	curl -X POST https://restapi.ordergroove.com/retention_incentives/eligibility_rule/ \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Retention discount 1",
>	"live": true,
>	"min_days_since_last_claim": 40,
>	"incentive_templates": [
>	{
>	"type": "Discount",
>	"target": "item",
>	"discount_type": "Discount Percent",
>	"field": "total_price",
>	"value": "20.00",
>	"name": "Incentive template discount"
>	}
>	]
>	}'