All available methods for the sub-resources of the resource rewards.
Get information about all vouchers created in relation to a specific reward
[badge-blue GET] /rewards/{reward_id}/vouchers
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
count | integer | The number of records to return. Default value is 100. |
No |
offset | integer | The number of records from a collection to skip. Default value is 0. | No |
sort_field | string | One of the query string parameters for sorting. Response is sorted by the specified field. | No |
sort_direction | string | Direction of sorting the response list. Possible values are: ASC / DESC | No |
customer_id | string | The unique id for the customer that has the vouchers on the account. | No |
store_id | string | The unique id for the store where the reward can be applied. | No |
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
reward_id | string | The unique id for the reward | Yes |
Status code: 200 OK
Output structure : object
Parameter name | Type | Description |
---|---|---|
vouchers | Vouchers[] | List of vouchers tied to a reward |
total_items | integer | Count of all found vouchers |
Get information about all products created in relation to a specific reward
[badge-blue GET] /rewards/{reward_id}/products
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
count | integer | The number of records to return. Default value is 100. |
No |
offset | integer | The number of records from a collection to skip. Default value is 0. | No |
sort_field | string | One of the query string parameters for sorting. Response is sorted by the specified field. | No |
sort_direction | string | Direction of sorting the response list. Possible values are: ASC / DESC | No |
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
reward_id | string | The unique id of the reward | Yes |
Status code: 200 OK
Output structure : object
Parameter name | Type | Description |
---|---|---|
products | Product[] | List of products tied to a reward |
total_items | integer | Count of all found products |
Get information about all product groups created in relation to a specific reward
[badge-blue GET] /rewards/{reward_id}/product-groups
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
count | integer | The number of records to return. Default value is 100. |
No |
offset | integer | The number of records from a collection to skip. Default value is 0. | No |
sort_field | string | One of the query string parameters for sorting. Response is sorted by the specified field. | No |
sort_direction | string | Direction of sorting the response list. Possible values are: ASC / DESC | No |
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
reward_id | string | The unique id of the reward | Yes |
Status code: 200 OK
Output structure : object
Parameter name | Type | Description |
---|---|---|
product_groups | ProductGroup[] | List of product groups tied to a reward |
total_items | integer | Count of all found product groups |
Get information about all product brands created in relation to a specific reward
[badge-blue GET] /rewards/{reward_id}/product-brands
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
count | integer | The number of records to return. Default value is 100. |
No |
offset | integer | The number of records from a collection to skip. Default value is 0. | No |
sort_field | string | One of the query string parameters for sorting. Response is sorted by the specified field. | No |
sort_direction | string | Direction of sorting the response list. Possible values are: ASC / DESC | No |
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
reward_id | string | The unique id of the reward | Yes |
Status code: 200 OK
Output structure : object
Parameter name | Type | Description |
---|---|---|
product_brands | ProductBrand[] | List of product brands tied to a reward |
total_items | integer | Count of all found product brands |
Get information as a list of all stores of specific reward. Customer can apply this reward in every of these stores
[badge-blue GET] /rewards/{reward_id}/stores
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
count | integer | The number of records to return. Default value is 100. |
No |
offset | integer | The number of records from a collection to skip. Default value is 0. | No |
sort_field | string | One of the query string parameters for sorting. Response is sorted by the specified field. | No |
sort_direction | string | Direction of sorting the response list. Possible values are: ASC / DESC | No |
visible_for_customer | integer | State of the visibility for the customer Possible values are: 0 - invisible / 1- visible. If query string is not used, return both. | No |
Status code: 200 OK
Output structure : object
Parameter name | Type | Description |
---|---|---|
stores | Store[] | List of the all stores where customer can apply reward |
total_items | integer | Count of all found stores |