PlanDocket

Service Orders

Business+

View orders for additional services and move them through their workflow.

Required scopes: service_orders
Access level: GET service_orders:read POST / PUT / PATCH / DELETE service_orders:write About access levels
Feature flag: service_orders

Endpoints

GET /api/v1/service-orders

List all orders

GET /api/v1/service-orders/{id}

Retrieve a single order

PATCH /api/v1/service-orders/{id}

Change the status: submitted → confirmed or cancelled, confirmed → completed or cancelled ("cancellation_reason" optional). Cancelling gives the stock back and voids open billable items; an invoiced order cannot be cancelled (409, correct it with a credit note). Fires service_order.confirmed / .completed / .cancelled

POST /api/v1/service-orders/{id}/status

Same as PATCH /service-orders/{id} (for clients that cannot send PATCH)

Query Parameters

Parameter Description
event_key Filter by event key
status Filter by order status
participant_id Filter by participant ID
order_number Filter by order number
sort Sort field (order_number, total, status, submitted_at, created_at)
order Sort direction (ASC or DESC, default: DESC)
include Include related data (items, participant)

Request Schema

Parameter Type Required Description
status string Yes New status: confirmed, completed or cancelled
cancellation_reason string No Reason shown to the exhibitor when cancelling (optional)

Response Schema

Field Type
id integer
order_number string|null
event_participant_id integer|null
status string
subtotal float
tax_total float
total float
currency string
notes string|null
submitted_at string|null
confirmed_at string|null
cancelled_at string|null
cancellation_reason string|null
created_at string
updated_at string

Code Examples

curl -X GET "https://your-tenant.plandocket.com/api/v1/service-orders" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://your-tenant.plandocket.com';

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => $baseUrl . '/api/v1/service-orders',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);
const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://your-tenant.plandocket.com';

const response = await fetch(`${baseUrl}/api/v1/service-orders`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

const data = await response.json();
console.log(data);
import requests

api_key = 'YOUR_API_KEY'
base_url = 'https://your-tenant.plandocket.com'

headers = {
    'Authorization': f'Bearer {api_key}',
}

response = requests.get(f'{base_url}/api/v1/service-orders', headers=headers)
data = response.json()
print(data)

Sample Response

200 OK
{
    "data": [
        {
            "id": 1,
            "order_number": "string",
            "event_participant_id": 1,
            "status": "string",
            "subtotal": 100,
            "tax_total": 100,
            "total": 100,
            "currency": "string",
            "notes": "string",
            "submitted_at": "2026-01-15T10:00:00+01:00",
            "confirmed_at": "2026-01-15T10:00:00+01:00",
            "cancelled_at": "2026-01-15T10:00:00+01:00",
            "cancellation_reason": "string",
            "created_at": "2026-01-15T10:00:00+01:00",
            "updated_at": "2026-01-15T10:00:00+01:00"
        }
    ],
    "meta": {
        "current_page": 1,
        "per_page": 25,
        "total": 1,
        "total_pages": 1
    }
}