Skip to main content
GET
List orders (sales-side document types by default)

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>

Select a single document type. Evaluated BEFORE the default sales-side population, so this is the supported way to reach return, purchase_order and late_fee_invoice rows.

Available options:
quote,
sales_order,
invoice,
return,
purchase_order,
late_fee_invoice
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