Ordergroove Developer Documentation

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"
    }
  ]
}'

{
  "public_id": "f74365c1acde4f41b8d46966a2d4177c",
  "name": "Retention discount 1",
  "merchant": "07f5cbbc9c0811ed99a9f2d3525685ca",
  "live": true,
  "min_days_since_last_claim": 40,
  "min_subscriber_orders_since_last_claim": null,
  "incentive_templates": [
    {
      "name": "Incentive template discount",
      "type": "Discount",
      "field": "total_price",
      "discount_type": "Discount Percent",
      "value": "20.00",
      "target": "item"
    }
  ]
}

Creates a retention incentive eligibility rule with their incentive templates.

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.

Request

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

Response

200

public_idstringOptional

namestringOptional

merchantstringOptional

livebooleanOptionalDefaults to true

min_days_since_last_claimintegerOptionalDefaults to 0

min_subscriber_orders_since_last_claiminteger or nullOptional

incentive_templateslist of objectsOptional

Errors

400

Bad Request Error