List orders

List orders. Requires start and end. Optional paymentState filters by payment status. Newest first. Use limit and optional cursor for pagination. Soft-deleted orders are omitted unless includeDeleted=true; those rows are marked deleted: true.

GET/orders

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Query parameters

startstring<date-time>required

Start of the orderDate range, inclusive. UTC with Z suffix, e.g. 2024-01-01T00:00:00.000Z; offsets like +02:00 are rejected.

endstring<date-time>required

End of the orderDate range, inclusive. UTC with Z suffix.

paymentStatestring

Optional payment status filter. Omit to return all payment states in the date range.

Allowed:successfulcancelledtimeoutfailedpending

limitinteger

Page size (1–5000, default 100).

min 1 · max 5000 · default: 100

cursorstring

Opaque document id for the next page. Do not parse. Follow meta.nextCursor until it is absent.

min length 1

includeDeletedboolean

When true, include soft-deleted orders marked deleted: true. Default false.

default: false

Responses

200

Orders with meta

dataOrder[]required

Show properties

Array of Order

idstringrequired

orderIdstring

orderDatestring<date-time>

transactionDatestring<date-time>

paymentMethodstring

paymentStatestring

Allowed:successfulcancelledtimeoutfailedpending

paymentBrandstring

priceinteger

Order total in cents

storestring

Store id

transactionMessagestring

giftcardIdstring

giftcardFunctionstring

deletedboolean

Present when stored. Lists include orders with deleted: true only with includeDeleted=true; get-by-id always returns them.

productsOrderLine[]required

Show properties

Array of OrderLine

productIdstring

titlestring

priceinteger

Line total in cents.

netPriceinteger

Net amount in cents.

depositinteger

Deposit in cents.

costPriceinteger

quantitynumber

weightnumber

supplierstring

categorystring

taxinteger

Tax amount in cents.

taxRatenumber

VAT rate as a decimal fraction (0.081 = 8.1%).

typestring

e.g. product, coupon, giftcard.

imageUrlstring

originalProductIdstring

originalPriceinteger

discountnumber

undiscountedPriceinteger

storestring

printTicketboolean

metaListMetarequired

List metadata. returned is the length of data. Soft-deleted catalog rows are omitted from list results, so returned may be less than limit even when more active items exist. When nextCursor is present, more pages may exist — keep paging until nextCursor is absent.

Show properties

totalintegerrequired

With product search (q) without store: estimated match count. With store: equals returned after store visibility filtering. Otherwise equals returned. Soft-deleted items are omitted, so a page may be shorter than limit even when more active items exist.

returnedintegerrequired

Number of items in data. With includeDeleted=true (orders), deleted orders count too.

limitintegerrequired

Applied page size.

offsetinteger

Only for product search with q.

nextCursorstring

Opaque cursor for the next page; pass it unchanged as cursor. Present when more results may exist. Soft-deleted rows are filtered out after reading, so a page can be shorter than limit while nextCursor is set. Never returned for categories, suppliers and stores, which are not paginated.

400

Invalid parameters or body.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

403

Missing, unknown or inactive API key, or a Read key on a write operation.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (API key)Remember on this deviceInclude my values in samples

Parameters

startquery*Start of the `orderDate` range, inclusive. UTC with `Z` suffix, e.g. `2024-01-01T00:00:00.000Z`; offsets like `+02:00` are rejected.endquery*End of the `orderDate` range, inclusive. UTC with `Z` suffix.paymentStatequeryOptional payment status filter. Omit to return all payment states in the date range.limitqueryPage size (1–5000, default 100).cursorqueryOpaque document id for the next page. Do not parse. Follow `meta.nextCursor` until it is absent.includeDeletedqueryWhen true, include soft-deleted orders marked `deleted: true`. Default false.

Request

curl -X GET 'https://dashboard.scango.ch/api/v1/orders?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://dashboard.scango.ch/api/v1/orders?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://dashboard.scango.ch/api/v1/orders?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/orders?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
  ],
]);

$response = curl_exec($curl);

Response

{
  "data": [
    {
      "id": "order_01",
      "orderId": "order_01",
      "store": "store_01",
      "price": 4590,
      "paymentState": "successful",
      "orderDate": "2024-04-20T12:00:00.000Z",
      "transactionDate": "2024-04-20T12:00:01.000Z",
      "products": []
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 1,
    "nextCursor": "order_02"
  }
}

{
  "statusCode": 400,
  "message": "Validation failed for Field: name, Error: Required",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/suppliers"
}

{
  "statusCode": 403,
  "message": "Unknown Error",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/products"
}