Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Orders

Search Orders

Endpoint to retrieve your Orders.

get/business/v2/orders

Query parameters

idstring

The Order ID.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

The Order ID.

status'PENDING' | 'ERROR' | 'PLACED' | 'CANCELLED' | 'COMPLETED' | 'COMPLETED_WITH_CREDIT'

The status of the Order.

fromDatestring date-time

The beginning of the period of the search fromDate included (i.e. greater than or equal to) (Formats: yyyy-MM-dd, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ssZ).

toDatestring date-time

The end of the period of the search toDate included (i.e. less than) (Formats: yyyy-MM-dd, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ssZ).

pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3

It indicates the specific page to display (the counter starts from zero).

sinteger

It indicates the number of items per page.

Example:25

It indicates the number of items per page.

d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC

It indicates how the pages are ordered.

propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The result is an array containing Orders.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "creation_time": "2017-06-01T12:48:40Z",
      "last_update_time": "2017-06-01T12:48:40Z",
      "total_paid_amount": 10.25,
      "items": [
        {
          "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
          "item_type": "CARD"
        }
      ],
      "is_valid": true
    }
  ]
}