Sub-resources of rewards

All available methods for the sub-resources of the resource rewards.


Get vouchers tied to a reward

Get information about all vouchers created in relation to a specific reward
[badge-blue GET] /rewards/{reward_id}/vouchers

Query string

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

Path parameters

Parameter name Type Description Mandatory (Yes/No)
reward_id string The unique id for the reward Yes

Response

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 products tied to a reward

Get information about all products created in relation to a specific reward
[badge-blue GET] /rewards/{reward_id}/products

Query string

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

Path parameters

Parameter name Type Description Mandatory (Yes/No)
reward_id string The unique id of the reward Yes

Response

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 product groups tied to a reward

Get information about all product groups created in relation to a specific reward
[badge-blue GET] /rewards/{reward_id}/product-groups

Query string

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

Path parameters

Parameter name Type Description Mandatory (Yes/No)
reward_id string The unique id of the reward Yes

Response

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 product brands tied to a reward

Get information about all product brands created in relation to a specific reward
[badge-blue GET] /rewards/{reward_id}/product-brands

Query string

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

Path parameters

Parameter name Type Description Mandatory (Yes/No)
reward_id string The unique id of the reward Yes

Response

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 all stores

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

Query string

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

Response

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