List offer profiles

GET

https://restapi.ordergroove.com/offer_profiles/

GET

/offer_profiles/

curl https://restapi.ordergroove.com/offer_profiles/ \
     -H "x-api-key: <apiKey>"

{
  "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": "Free discount_percent",
        "value": "100",
        "threshold_field": 3,
        "threshold_value": "50"
      }
    ]
  },
  "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": "Free discount_percent",
        "value": "100",
        "threshold_field": 3,
        "threshold_value": "50"
      }
    ]
  }
}

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

offer_profile_categoryenumOptional

Controls inclusion/filtering of offer profiles with SFI.

Allowed values:

statusenumOptionalDefaults to available

Allowed values:

Response

200

public_idstringOptional

namestringOptional

livebooleanOptionalDefaults to true

statusenumOptionalDefaults to available

Allowed values:

weightintegerOptionalDefaults to 0

offerslist of stringsOptional

recurring_couponobjectOptional

initial_couponobjectOptional

Errors

403

Forbidden Error