Ordergroove Developer Documentation

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "public_id": "e3e9ac44a24f15e485b0bc764e107cf3",
      "name": "offer profile name",
      "live": true,
      "status": "available",
      "weight": 100,
      "offers": [
        "a748aa648ac811e8af3bbc764e106cf4"
      ],
      "recurring_coupon": {
        "public_id": "ff48e9fdc8eb4d79abd7c8c573523d25",
        "name": "Demo Store Incentives",
        "code": "demo_store",
        "discounts": [
          {
            "public_id": "c67dec11aedb4885aa9a58c3f89de746",
            "name": "Free shipping on orders over $50",
            "object": 1,
            "field": 2,
            "type": "discount_percent",
            "value": "100.00",
            "threshold_field": 3,
            "threshold_value": "50.00",
            "has_conditions": false
          }
        ],
        "has_conditions": false
      },
      "initial_coupon": {
        "public_id": "ff48e9fdc8eb4d79abd7c8c573523d25",
        "name": "Demo Store Incentives",
        "code": "demo_store",
        "discounts": [
          {
            "public_id": "c67dec11aedb4885aa9a58c3f89de746",
            "name": "Free shipping on orders over $50",
            "object": 1,
            "field": 2,
            "type": "discount_percent",
            "value": "100.00",
            "threshold_field": 3,
            "threshold_value": "50.00",
            "has_conditions": false
          }
        ],
        "has_conditions": false
      },
      "merchant": "0e5de2bedc5911e3a2a7bc764e106cf4",
      "is_standardized": false
    }
  ]
}

Returns offer profiles — the configurations that pair a set of offers with the initial_coupon and recurring_coupon carrying their discounts.

This endpoint accepts the Application API Scope only. Storefront API Scope signatures are rejected.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

Query parameters

livebooleanOptional

Filter by whether the offer profile is live. Use true to return only live profiles.

offer_profile_categoryenumOptional

Which offer profiles to return, and whether to include their conditional incentives. all (the default) returns every profile without them. all_with_standard_flex_incentives returns every profile and adds standard_flex_incentives to each coupon. only_with_standard_flex_incentives returns only profiles that have conditional incentives, with them included.

Allowed values:

statusenumOptionalDefaults to available

Filter by archive status. Defaults to available, which excludes archived profiles.

Allowed values:

pageintegerOptionalDefaults to 1

Page number to return.

page_sizeintegerOptionalDefaults to 10

Number of offer profiles per page. Default value is 10, maximum allowed is 100.

Response

200

countintegerOptionalDefaults to 0

nextstring or nullOptional

previousstring or nullOptional

resultslist of objectsOptional

Errors

403

Forbidden Error