Sub-resources of purchases

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


Get purchase items tied to a purchase

Get information about all pruchase items created in relation to a specific purchase
[badge-blue GET] /purchases/{purchase_id}/purchase-items

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)
purchase_id string The unique id of the purchase Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
pruchase_items PurchaseItem[] List of purchase items tied to a purchase
total_items integer Count of all found purchase items


Get vouchers tied to a purchase

Get information about all vouchers created in relation to a specific purchase
[badge-blue GET] /purchases/{purchase_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

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
vouchers Voucher[] List of all recent vouchers
total_items integer Count of all recent vouchers


Get point records tied to a purchase

Get information about all point records created in relation to a specific purchase
[badge-blue GET] /purchases/{purchase_id}/points

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

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
points Point[] List of the point records
total_items integer Count of all found point records