Skip to main content
GET
/
orders
List orders
curl --request GET \
  --url https://apiv2.example.com/orders \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "orderId": "ce0539b4-ec57-4709-b72e-47892586d05a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "customer": {
        "customerId": "<string>",
        "name": "<string>"
      },
      "pricing": {
        "total": 123,
        "currency": "USD"
      },
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

​
limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
​
cursor
string

Opaque pagination token from a previous response's nextCursor.

​
state
enum<string>

Filter by order state The status of an order in its lifecycle.

  • PENDING: Order is in cart state, can be modified
  • PENDING_PAYMENT: Order is locked and awaiting payment completion
  • SUBMITTED: Order has been submitted for processing
  • PENDING_APPROVAL: Order is pending approval
  • PROCESSING: Order is being fulfilled
  • COMPLETED: Order has been successfully fulfilled
  • CANCELLED: Order was cancelled before completion
  • EXPIRED: Order expired due to inactivity
  • FAILED: Order fulfillment failed
Available options:
PENDING,
PENDING_PAYMENT,
SUBMITTED,
PENDING_APPROVAL,
PROCESSING,
COMPLETED,
CANCELLED,
EXPIRED,
FAILED
​
userId
string

Filter by user ID

​
customerId
string

Filter by customer. May be the entity's internal UUID or an external reference identifier. Reference identifiers MUST be prefixed with rid_ (e.g., rid_crm-customer-12345) so the API can distinguish them from internal UUIDs. The prefix is stripped before lookup.

​
expiresAfter
string<date-time>

Filter orders expiring after this date

​
expiresBefore
string<date-time>

Filter orders expiring before this date

Response

Orders retrieved successfully

​
items
object[]
required
​
pagination
object
required