Zum Hauptinhalt springen
GET
/
orders
List orders
curl --request GET \
  --url https://dashboard.scango.ch/api/v1/orders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "order_01",
      "orderId": "order_01",
      "instance": "org_01",
      "store": "store_01",
      "price": 4590,
      "paymentState": "successful",
      "orderDate": {
        "_seconds": 1713600000,
        "_nanoseconds": 0
      },
      "products": []
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 100
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.scango.ch/llms.txt

Use this file to discover all available pages before exploring further.

Optional limit (1–5000, Standard 100) begrenzt die Anzahl der zurückgegebenen Bestellungen (neueste zuerst). Die Antwort-meta enthält total, returned und limit (total und returned entsprechen der Größe von data in dieser Antwort). Siehe Einführung.

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Abfrageparameter

​
start
string<date-time>

Start date (Format: 2020-01-01T00:00:00Z)

​
end
string<date-time>

End date (Format: 2020-01-01T00:00:00Z)

​
paymentState
enum<string>

Payment status filter

Verfügbare Optionen:
successful,
cancelled,
timeout,
failed,
pending
​
limit
integer
Standard:100

Maximum number of orders to return. Integer 1–5000. Default 100.

Erforderlicher Bereich: 1 <= x <= 5000

Antwort

200 - application/json

List of orders with meta (ListMeta).

​
data
object[]
erforderlich
​
meta
object
erforderlich

Included on every list response. returned is the length of data. For Firestore-backed lists (/products without q, /orders, /suppliers, /categories), total equals returned for that response (the API does not return a separate full match count). For product search with q, total is the search index’s estimated number of matching documents. limit is the applied page size (query default 100, maximum 5000; search with q caps the effective page size at 250). offset is only used for product search with q.