Skip to main content
GET
List orders currently on hold

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

hold_type
string

Filter by hold type (e.g. credit, manual).

Search by order number or customer.

page
integer
default:1
per_page
integer
default:25

Response

Orders currently on hold.

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