Orders
Show partner order
get/api/v2/partner/orders/{id}
Request
- Base URL: http://localhost:5100
- URL: http://localhost:5100/api/v2/partner/orders/{id}
- Auth: API key in header Authorization
Path parameters
idstring required
ID for order
Query parameters
client_idstring required
Partner client ID
Response
Order retrieved successfully
Example response
{
"success": true,
"order": {
"id": 1,
"client_id": "partner-client-id",
"employee_id": "EMP123",
"title": "Mr",
"first_name": "John",
"surname": "Doe",
"email": "john.doe@example.com",
"effective_date": "2025-01-01T00:00:00Z",
"dispatch_date": "2025-01-02T00:00:00Z",
"total_amount_to_recover": "1200.0",
"total_end_of_agreement_inc_vat": "1200.0",
"amount_per_pay_period": "100.0",
"total_existing_active_orders_value": 1800,
"nmw_for_this_age_bracket": "6.4",
"order_number": 1,
"duration": 12,
"benefit_type": "Home and Electronics",
"benefit_name": "Home and Electronics / My Organisation",
"telephone_number": "07123456789",
"mobile_number": "07123456789",
"address1": "123 Main St",
"address2": "Suite 101",
"city": "London",
"county": "Greater London",
"postcode": "W1A 1AA",
"ni_number": "QQ123456C",
"date_of_birth": "1985-01-01",
"job_title": "Software Engineer",
"job_location": "Head Office",
"job_grade": "Band 5",
"partner_user_identifier": "ABC123",
"approval_status": "Accepted",
"order_status": "Order authorised",
"order_management_order_status": "Active",
"enabled": true,
"national_minimum_wage_check_complete": true,
"basic_details_check_complete": true,
"first_payroll_deduction": "January 2025",
"basic_net_cost_per_period": "19.11",
"higher_net_cost_per_period": "18.03",
"total_basic_net_cost": "229.32",
"total_higher_net_cost": "216.36",
"order_status_message": "Order will be placed with supplier shortly. Check back here at any time.",
"products": [
{
"ItemNo": "SKU123",
"ItemName": "MacBook Pro",
"ItemDescription": "16-inch Apple laptop",
"ItemQty": 1,
"ItemValue": 1200,
"ItemImage": "https://example.com/images/macbook_pro.jpg"
}
],
"comments": [
{
"name": "John Admin",
"comment": "The employee cancelled the order because",
"partner_user_id": "ABC123",
"created_at": "2025-01-10T14:30:00Z",
"comment_sent_to_employee": true
}
],
"accepted_details": {
"accepted_by": "John Admin",
"date_of_approval": "2025-01-15T10:00:00Z",
"term_end_date": "2026-01-15T10:00:00Z"
},
"rejection_details": [
{
"rejected_by": "Jane Manager",
"date_of_rejection": "2025-01-10T14:30:00Z",
"reason_type": "national_minimum_wage",
"additional_information_name": "Amount available to spend",
"additional_information": "500",
"additional_information_format": "integer",
"rejection_comment": "Insufficient funds available",
"employee_notified": true
}
],
"cancelled_details": {
"cancelled_by": "John Doe",
"date_of_cancellation": "2025-01-20T09:00:00Z",
"cancellation_type": "employee_cancellation",
"cancellation_comment": "Changed mind about the order"
},
"other_orders": [
{
"id": 2,
"order_number": 2,
"effective_date": "2024-06-01T00:00:00Z",
"order_status": "Ended",
"total_amount_to_recover": "800.0",
"amount_per_pay_period": "66.67",
"benefit_type": "Cycle to Work",
"products": [
{
"ItemName": "Mountain Bike"
}
],
"approval_status": "Accepted"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.