v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Rewards

Get product groups tied to a reward

Get information about all product groups created in relation to a specific reward.

get/rewards/{reward_id}/product-groups

Path parameters

reward_idstring required

The unique ID of the reward.

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

reward_product_relation_type'condition' | 'bonus'

Parameter identify type of the relation between reward and product | product group | product brand.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

Example response

{
  "data": {
    "product_groups": [
      {
        "product_group_id": "8fd73167342d06899c4c015320",
        "name": "Accessories",
        "parent_product_group_id": "83d1d11ea3884a5d33253fe214",
        "parent_external_id": "678",
        "code": "567829",
        "external_id": "953",
        "store_id": "83d1d11ea3884a5d33253fe214",
        "partner_id": "86e05affc7a7abefcd513ab400",
        "last_change": "2021-04-16 15:55:44.33538",
        "state": 1,
        "reward_product_relation_types": [
          "condition",
          "bonus"
        ]
      }
    ],
    "total_items": 1
  }
}