Skip to main content
GET
/
orders
List orders (all document_type values)
curl --request GET \
  --url https://api.arcuserp.com/v1/orders \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "ord-uuid-0001",
      "object": "order",
      "entity_id": "ent-uuid-here",
      "order_number": "SO-001042",
      "document_type": "sales_order",
      "order_status": "confirmed",
      "payment_status": "unpaid",
      "fulfillment_status": "unfulfilled",
      "account_id": "acct-uuid-0001",
      "order_total": 1250,
      "subtotal": 1100,
      "shipping_total": 25,
      "tax_total": 125,
      "discount_total": 0,
      "fee_total": 0,
      "amount_paid": 0,
      "balance_due": 1250,
      "tax_exempt": false,
      "is_on_hold": false,
      "ship_complete": false,
      "created_at": "2026-05-01T09:00:00Z",
      "updated_at": "2026-05-01T09:05:00Z"
    }
  ],
  "total": 1,
  "has_more": false
}

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.

Query Parameters

​
document_type
enum<string>
Available options:
quote,
sales_order,
invoice,
return,
purchase_order
​
account_id
string<uuid>
​
order_status
string
​
payment_status
string
​
created_after
string<date-time>
​
created_before
string<date-time>
​
limit
integer
default:50
Required range: 1 <= x <= 200
​
offset
integer
default:0
Required range: x >= 0
​
expand[]
enum<string>[]

Hydrate related resources inline. List endpoints REQUIRE the data. prefix (e.g. expand[]=data.customer). Valid paths: see x-arcus-expand below.

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

Response

Paginated order list

​
object
enum<string>
Available options:
list
​
data
object[]
​
total
integer
​
has_more
boolean