Skip to content
docs
Guides
ES
OrdersOrder Drafts
draft:read

List order drafts

GET/v1/order-drafts

List order drafts. A successful request returns HTTP 200 with the documented response body.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
id?string

Unique identifier of the resource.

status?array<>

Only items in these statuses.

customerId?string

Identifier of the customer.

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.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/order-drafts" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "storeId": "7204558912004325301",      "customerId": "7204558912004325301",      "cartId": "7204558912004325301",      "draftNumber": "example",      "currencyCode": "PEN",      "source": "example",      "email": "andrea@example.com",      "phone": "+51987654321",      "firstName": "Andrea",      "lastName": "Ramos",      "entityName": "Comercial Lima SAC",      "status": "draft",      "draftDate": "2026-08-01T15:30:00Z",      "sentAt": "2026-08-01T15:30:00Z",      "acceptedAt": "2026-08-01T15:30:00Z",      "expiredAt": "2026-08-01T15:30:00Z",      "cancelledAt": "2026-08-01T15:30:00Z",      "convertedAt": "2026-08-01T15:30:00Z",      "shareToken": "replace_with_the_issued_token",      "shareExpiresAt": "2026-08-01T15:30:00Z",      "allowAnonymousShareAccess": false,      "sharedAt": "2026-08-01T15:30:00Z",      "total": 1,      "createdOn": "2026-08-01T15:30:00Z",      "updatedOn": "2026-08-01T15:30:00Z"    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}