Command Palette

Search for a command to run...

Search Documentation

Search documentation topics, API endpoints, and guides

getOrders
Source

OpenAPI Documentation

GET /v1/orders

List orders

List orders owned by the authenticated user or organization.

Last updated on 5/26/2026

Endpoint

get/v1/orders

Lists orders owned by the authenticated customer or organization. Use limit and offset for pagination, and sourceSystem when you need to narrow results to a specific integration. Treat retrieved order status as the source of truth for reconciliation.

Authentication

Include your customer API key in the Authorization header:

shell
Authorization: Bearer $AUTOMATIC_PALLET_API_KEY

Request

Parameters

NameInTypeRequiredDescription
limitqueryintegerOptionalMaximum number of items to return. Defaults to 50 when omitted.
offsetqueryintegerOptionalZero-based offset for paginated list requests.
sourceSystemquerystringOptionalOptional client-defined source system used to filter orders created by a specific integration.

Responses

200Orders for the authenticated customer.
200 Response Schema
{
  "$ref": "#/components/schemas/OrderListResponse"
}
401Missing or invalid API key.
401 Response Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}
403API key lacks orders:read.
403 Response Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example cURL Request

cURL
curl "https://automaticpallet.com/v1/orders?limit=50&offset=0" \
  -H "Authorization: Bearer $AUTOMATIC_PALLET_API_KEY"