Sign in

v1

latestOpenAPI 3.0.32026-08-06111223.1 KB
Orders

Create Order

Create a new order with optional custom field values.

post/api/orders

Request body

order_numberstring required

Unique order identifier

due_datestring date nullable

Order due date

custom_fieldsobject nullable

Custom field values keyed by field key

email_subjectstring nullable

Original email subject if imported from email

email_fromstring nullable

Original email sender if imported from email

email_bodystring nullable

Original email body if imported from email

Example request

{
  "order_number": "ORD-2024-001",
  "due_date": "2024-12-31",
  "custom_fields": {
    "client_name": "Acme Corp",
    "property_type": "residential"
  }
}

Response

Order created successfully

successboolean
order_idstring

Obfuscated order ID

order_numberstring
messagestring

Example response

{
  "success": true,
  "order_id": "abc123xyz",
  "order_number": "ORD-2024-001",
  "message": "Order created successfully"
}