Benefits and Perks Order
These endpoints return the order history of the signed-in employee in Benefits and Perks. They are read-only and return the same orders as the Order history page, newest first. Orders awaiting payment are not included.
This endpoint retrieves the paginated order history of the signed-in employee. Use the optional query parameters to filter by purchase date range, order number, order item number or status. Filters can be combined, and the pagination fields reflect the filtered results. start_date and end_date must be sent together.
https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/benefits_and_perks/ordersPath Parameters
The ID of the organisation.
The ID of the signed-in employee. Must be the employee making the request.
Query Parameters
Page number (must be a positive integer).
1Number of items per page (1–100). Values above 100 are capped at 100.
20Only return orders placed on or after this date (YYYY-MM-DD). Must be sent together with end_date.
Only return orders placed on or before this date (YYYY-MM-DD). Must be sent together with start_date.
Only return the order with this order number, as shown on the Order history page.
Only return orders that contain the item with this order item number, as shown on the Order history page.
Only return orders with this status. Send the parameter as a list (status[]=fulfilled&status[]=processing) to match several statuses. See the status field in the response for the possible values.
Response Body
Returns a paginated list of the signed-in employee's Benefits and Perks orders. Returns an empty items array when there are no orders.
List of the employee's orders, newest first.
Unique identifier for the order.
The name of the purchased product (e.g. "Coles Gift Card"). null when the order has no items.
The status of the order. An order that failed processing is reported as processing. null when the order has no items.
When the order was created, in RFC 3339 format.
When the order was last updated, in RFC 3339 format.
Current page number.
Number of items per page.
Total number of orders across all pages.
Total number of pages.
Example
curl -X GET \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/benefits_and_perks/orders" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
{ "data": { "items": [ { "id": "5b0f4a39-8c4e-4d6e-9f43-2a1c7e5d9b10", "name": "Coles Gift Card", "status": "fulfilled", "created_at": "2026-06-19T02:15:30+00:00", "updated_at": "2026-06-19T02:20:05+00:00" } ], "page_index": 1, "item_per_page": 20, "total_items": 1, "total_pages": 1 }}This endpoint retrieves a single order belonging to the signed-in employee.
https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/benefits_and_perks/orders/:order_idPath Parameters
The ID of the organisation.
The ID of the signed-in employee. Must be the employee making the request.
The ID of the order to retrieve. Must be one of the signed-in employee's own orders.
Response Body
Returns the order. Returns 404 Not Found when the order does not exist or belongs to another employee.
Unique identifier for the order.
The name of the purchased product (e.g. "Coles Gift Card"). null when the order has no items.
The status of the order. An order that failed processing is reported as processing. null when the order has no items.
When the order was created, in RFC 3339 format.
When the order was last updated, in RFC 3339 format.
The unit price of the item before any discount, rounded to 2 decimals. null when the order has no items.
The quantity of the item purchased. null when the order has no items.
The discount (including promotions) applied to the item, rounded to 2 decimals. null when the order has no items.
The transaction fee charged for the order, rounded to 2 decimals.
The total amount billed for the order, rounded to 2 decimals.
The payment method of the order, taken from its successful transaction (or its first transaction if none succeeded). null when the order has no transactions.
The total discount across every item of the order, rounded to 2 decimals.
Example
curl -X GET \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/benefits_and_perks/orders/:order_id" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
{ "data": { "id": "5b0f4a39-8c4e-4d6e-9f43-2a1c7e5d9b10", "name": "Coles Gift Card", "status": "fulfilled", "created_at": "2026-06-19T02:15:30+00:00", "updated_at": "2026-06-19T02:20:05+00:00", "original_price": 50, "quantity": 1, "amount_saved": 5, "transaction_fee": 1.5, "total": 46.5, "payment_method": "credit_card", "total_saving": 5 }}