Create a service order

Only available with the Service Orders module enabled.

Creates a new service order. This endpoint allows you to create service orders with a customer, a service item, note and location.

🔒 Requires: services:write sales:write scopes

Request body

assigned_user_idstring uuid

The user assigned to work on the service order

customer_idstring uuid required

The customer associated with the service

job_status_idstring nullable

The ID of a custom service status to assign to this order. When provided, overrides the status field.

locationstring

Location where the service will be performed

outlet_idstring uuid required

The outlet of the service order

register_idstring uuid required

The register of the service order

statusstring

The status of the service order

Example request

{
  "assigned_user_id": "b1ed6158-f019-11e3-a0f5-b8ca3a64f8f4",
  "customer_id": "06e35f89-3783-11e6-ec7e-13193f7bd2ed",
  "item": {
    "description": "Red mountain bike requiring brake service",
    "initial_condition": "Brakes not functioning properly",
    "item_id": "06e35f89-3783-11e6-ec7e-13193f7bd2ed",
    "item_name": "Mountain Bike",
    "serial_number": "MB2025-001"
  },
  "location": "Service Bay 2",
  "notes": [
    {
      "body": "Customer requested bike before the weekend",
      "created_at": "2026-01-27T10:00:00Z",
      "is_visible_to_customer": true
    },
    {
      "body": "Internal note: Check brake fluid levels"
    }
  ],
  "outlet_id": "348fff91-8c43-4599-812b-13636760895a",
  "register_id": "b1e198a9-f019-11e3-a0f5-b8ca3a64f8f4",
  "status": "NEW"
}

Response

Service order created successfully

v1

Create a service order

Request body

Example request

Response