Orders

Export partner orders

get/api/v2/partner/orders/export

Request

  • Base URL: http://localhost:5100
  • URL: http://localhost:5100/api/v2/partner/orders/export
  • Auth: API key in header Authorization

Query parameters

client_idstring required

Please enter client-id

actor_identifierstring required

Specify the partner user identifier of the admin user who is performing the action

organisation_approval'Pending' | 'Rejected' | 'Accepted'
order_status'Active' | 'Ended' | 'Cancelled by Employee' | 'Active - Amended Order' | 'Ended - Amended Order'
show_employee_cancelled_ordersboolean
order_numberinteger
emailstring
benefit_typestring
pay_frequencystring
sort_by'placed_newest_oldest' | 'placed_oldest_newest' | 'price_asc' | 'price_desc' | 'last_name_asc' | 'last_name_desc' | 'first_name_asc' | 'first_name_desc'
first_name[]string[]

Filter by multiple first names

last_name[]string[]

Filter by multiple last names

employee_number[]string[]

Filter by multiple employee numbers

ni_number[]string[]

Filter by multiple ni numbers

payroll_period[]string[]

Filter by multiple payroll periods

Response

OK

successboolean
messagestring

Example response

{
  "message": "No orders. found."
}

Changes

No recorded changes to this operation across all 1 revision of this API.