Skip to main content
GET
/
orders
/
{id}
Retrieve a single order by UUID or order_number
curl --request GET \
  --url https://api.arcuserp.com/v1/orders/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "order",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_number": "<string>",
  "document_type": "quote",
  "order_status": "draft",
  "payment_status": "unpaid",
  "fulfillment_status": "unfulfilled",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "po_number": "<string>",
  "order_date": "2023-11-07T05:31:56Z",
  "due_date": "2023-11-07T05:31:56Z",
  "subtotal": 123,
  "discount_total": 123,
  "shipping_total": 123,
  "tax_total": 123,
  "fee_total": 123,
  "order_total": 123,
  "amount_paid": 123,
  "balance_due": 123,
  "tax_exempt": true,
  "delivery_option": "ship",
  "notes": "<string>",
  "internal_notes": "<string>",
  "invoice_number": "<string>",
  "invoice_type": "order",
  "is_on_hold": true,
  "hold_type": "<string>",
  "ship_complete": true,
  "source_platform": "<string>",
  "external_order_id": "<string>",
  "external_order_number": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

​
id
string
required

The order's UUID id or its human-readable order_number (e.g. SO-001234, INV-0042, Q-2026-0099). UUID lookup uses a direct index and is slightly faster. order_number lookup resolves within the authenticated entity scope (Layer 1 enforced -- cross-entity collision impossible).

Example:
{
  "uuid": {
    "value": "550e8400-e29b-41d4-a716-446655440000",
    "summary": "UUID lookup (direct index)"
  },
  "order_number": {
    "value": "SO-001234",
    "summary": "order_number lookup (polymorphic)"
  }
}

Query Parameters

​
expand[]
enum<string>[]

Hydrate related resources inline. Single-resource endpoints do NOT use the data. prefix (e.g. expand[]=customer). Valid paths: see x-arcus-expand below.

Available options:
customer,
account,
line_items,
line_items.product,
payments,
refunds,
packages,
fulfillments,
gl_entries,
invoice,
tax_lines

Response

Order object

An Arcus ERP order document. One table holds quotes, sales_orders, invoices, returns, and purchase_orders -- always filter by document_type. entity_id is always from the API key (Layer 1 isolation).

​
id
string<uuid>
​
object
enum<string>
Available options:
order
​
entity_id
string<uuid>
read-only
​
order_number
string
read-only
​
document_type
enum<string>
Available options:
quote,
sales_order,
invoice,
return,
purchase_order
​
order_status
enum<string>
Available options:
draft,
confirmed,
partially_fulfilled,
fulfilled,
cancelled,
voided,
awaiting_ach_clearance,
on_hold
​
payment_status
enum<string>
Available options:
unpaid,
partially_paid,
paid,
overpaid,
refunded,
partially_refunded,
voided
​
fulfillment_status
enum<string>
Available options:
unfulfilled,
partially_fulfilled,
fulfilled
​
account_id
string<uuid> | null
​
location_id
string<uuid> | null
​
po_number
string | null
​
order_date
string<date-time> | null
​
due_date
string<date-time> | null
​
subtotal
number
​
discount_total
number
​
shipping_total
number
​
tax_total
number
​
fee_total
number
​
order_total
number
​
amount_paid
number
read-only

SSOT: utils/ar-helpers.mjs::updateARBalance. Do not write directly.

​
balance_due
number
read-only
​
tax_exempt
boolean
​
delivery_option
enum<string>
Available options:
ship,
pick_up,
local_delivery
​
notes
string | null
​
internal_notes
string | null
​
invoice_number
string | null
read-only
​
invoice_type
enum<string> | null
Available options:
order,
manual,
proforma,
correction
​
is_on_hold
boolean
read-only
​
hold_type
string | null
read-only
​
ship_complete
boolean
​
source_platform
string | null
​
external_order_id
string | null
​
external_order_number
string | null
​
metadata
object
​
created_at
string<date-time>
read-only
​
updated_at
string<date-time>
read-only