Retrieve Orders data

GET 
/reporting

Retrieve checkout share data

Request

application/json

Body

required

request_id uuidrequired

A unique identifier to track this request

from ISO 8601 date-timerequired

Date for greater than order placed_at filter, in UTC

pageLimit integerrequired

limit in offset calculation

currentPage integerrequired

current page in offset calculation

Responses

200

OK

application/json

Schema

Schema

request_id uuid

items

object[]

Array [

order_id stringrequired

The increment id that uniquely identifies the order in the system

payment_method stringrequired

Should resolve to payment service as a title not payment methods with client specifics. Example of good values: [Simpler, Card, Cash on delivery, Apple Pay, Klarna, Paypal, Revolut]. Examples of bad values: [Amex ending in 1017, Credit card via Eurobank, mypos_virtual, PayPal - user02@hotmail.com]

is_guest booleanrequired

If customer is guest

country_code stringrequired

ISO country code

cart_size integerrequired

The total quantity ordered

total_paid floatrequired

Total paid

created_at ISO 8601 date-timerequired

Date order was added in UTC

]

total_pages integer

Example (from schema)

{
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "items": [
    {
      "order_id": "string",
      "payment_method": "string",
      "is_guest": true,
      "country_code": "string",
      "cart_size": 0,
      "total_paid": 0,
      "created_at": "string"
    }
  ],
  "total_pages": 0
}

Example

{
  "request_id": "fdde53a4-4d6d-4de5-b3e1-e3d5fe2a9c03",
  "total_pages": 12,
  "items": [
    {
      "order_id": 29,
      "payment_method": "Simpler Checkout",
      "is_guest": true,
      "country_code": "GR",
      "cart_size": 1,
      "total_paid": 36.46,
      "created_at": "2023-09-13 11:53:11"
    },
    {
      "order_id": 40,
      "payment_method": "GPAY",
      "is_guest": false,
      "country_code": "FR",
      "cart_size": 4,
      "total_paid": 108.3,
      "created_at": "2023-12-13 05:12:11"
    }
  ]
}

Loading...