Skip to content
scango.ch
English
DeutschNot translatedEnglishFrançaisNot translatedItalianoNot translated
Esc
↑↓navigate↵open⌘Jpreview

List orders

List orders. Requires start, end, and paymentState. Newest first. Use limit and optional cursor for pagination.

GET/orders
Authorization
AuthorizationBearer token (API key) · headerrequired
Organization API key.
Query parameters
startstring<date-time>required
Start of range (ISO-8601).
endstring<date-time>required
End of range (ISO-8601).
paymentStatestringrequired
Payment status filter.
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.
Responses
200Orders with meta
dataOrder[]required
Show properties
Array of Order
idstring
Id
orderIdstring
orderDatestring<date-time>
transactionDatestring<date-time>
paymentMethodstring
paymentStatestring
Allowed:successfulcancelledtimeoutfailedpending
paymentBrandstring
priceinteger
Order total in cents
storestring
Store id
transactionMessagestring
giftcardIdstring
giftcardFunctionstring
deletedboolean
productsOrderLine[]
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
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 active items in `data` (soft-deleted rows excluded).
limitintegerrequired
Applied page size.
offsetinteger
Only for product search with `q`.
nextCursorstring
Opaque cursor for the next page. Present when more results may exist. Do not parse; pass unchanged as `cursor`. Under soft-delete filtering, `returned < limit` does not mean the list is finished.
400Bad request
statusCodeintegerrequired
HTTP status code
messagestringrequired
Human-readable error message
timestampstring<date-time>required
pathstringrequired
Request path
403Unauthorized
statusCodeintegerrequired
HTTP status code
messagestringrequired
Human-readable error message
timestampstring<date-time>required
pathstringrequired
Request path
Request
curl -X GET "https://dashboard.scango.ch/api/v1/orders?start=2024-01-01T00%3A00%3A00Z&end=2024-01-01T00%3A00%3A00Z&paymentState=successful" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "data": [
    {
      "id": "string",
      "orderId": "string",
      "orderDate": "2024-01-01T00:00:00Z",
      "transactionDate": "2024-01-01T00:00:00Z",
      "paymentMethod": "string",
      "paymentState": "successful",
      "paymentBrand": "string",
      "price": 0,
      "store": "string",
      "transactionMessage": "string",
      "giftcardId": "string",
      "giftcardFunction": "string",
      "deleted": true,
      "products": [
        {
          "productId": "string",
          "title": "string",
          "price": 0,
          "netPrice": 0,
          "deposit": 0,
          "costPrice": 0,
          "quantity": 0,
          "weight": 0,
          "supplier": "string",
          "category": "string",
          "tax": 0,
          "taxRate": 0,
          "type": "string",
          "imageUrl": "string",
          "originalProductId": "string",
          "originalPrice": 0,
          "discount": 0,
          "undiscountedPrice": 0,
          "store": "string",
          "printTicket": true
        }
      ]
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}