Skip to content
Guides
OrdersOrders
order:read

Export orders

Queues an order export. Returns a job; the file becomes downloadable once it completes.

POST/v1/orders/exports

Queues an order export. Returns a job; the file becomes downloadable once it completes.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/orders/exports" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "format": "csv",    "search": "polo",    "statuses": [      "new"    ],    "states": [      "open"    ],    "fulfillmentStatuses": [      "unfulfilled"    ],    "returnStatuses": [      "none"    ],    "itemStatuses": [      "new"    ],    "paymentCodes": [      "example"    ]  }'
{  "id": "7204558912004325301",  "status": "pending",  "resource": "example",  "format": "example",  "createdOn": "2026-08-01T15:30:00Z"}