Skip to content
Guides
ES
API reference
stabledraft:read

List order drafts

GET/v1/order-drafts

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"
status?array<>
customerId?null|string

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"
{  "data": [    {      "id": "string",      "storeId": "string",      "customerId": null,      "cartId": null,      "draftNumber": "string",      "currencyCode": "string",      "source": null,      "email": null,      "phone": null,      "firstName": null,      "lastName": null,      "entityName": null,      "status": "draft",      "draftDate": "2019-08-24T14:15:22Z",      "sentAt": null,      "acceptedAt": null,      "expiredAt": null,      "cancelledAt": null,      "convertedAt": null,      "shareToken": null,      "shareExpiresAt": null,      "allowAnonymousShareAccess": true,      "sharedAt": null,      "total": 0.1,      "createdOn": "2019-08-24T14:15:22Z",      "updatedOn": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}