Orders

Update an order

put/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

idinteger required

Order ID

Request body

client_idstring required
basic_details_check_completeboolean
order_details_check_completeboolean
national_minimum_wage_check_completeboolean
employee_numberstring
ni_numberstring
apply_updates_to_employee_profileboolean

Example request

{
  "client_id": "client-123",
  "basic_details_check_complete": true,
  "order_details_check_complete": true,
  "national_minimum_wage_check_complete": true,
  "employee_number": "EMP123",
  "ni_number": "QQ123456C",
  "apply_updates_to_employee_profile": true
}

Response

Order updated successfully

successboolean

Example response

{
  "success": true,
  "order": {
    "id": 123,
    "client_id": "CLIENT123",
    "employee_id": "EMP456",
    "title": "Mr",
    "first_name": "John",
    "surname": "Doe",
    "email": "john.doe@example.com",
    "effective_date": "2025-01-01T10:00:00Z",
    "dispatch_date": "2025-01-10T10: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": 123,
    "duration": 12,
    "benefit_type": "Home and Electronics",
    "benefit_name": "Home and Electronics / My Organisation",
    "telephone_number": "07123456789",
    "mobile_number": "07123456789",
    "address1": "123 Baker Street",
    "address2": "Flat 2B",
    "city": "London",
    "county": "Greater London",
    "postcode": "NW1 6XE",
    "ni_number": "QQ123456C",
    "date_of_birth": "1990-01-01",
    "job_title": "Software Engineer",
    "job_location": "London HQ",
    "job_grade": "Grade A",
    "partner_user_identifier": "user-xyz-123",
    "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,
    "order_details_check_complete": true,
    "products": [
      {
        "ItemNo": "SKU123",
        "ItemName": "Laptop",
        "ItemDescription": "A powerful 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
      }
    ]
  }
}

Changes

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