Bestellungen auflisten

Bestellungen auflisten. Erfordert start und end. Optionales paymentState filtert nach Zahlungsstatus. Neueste zuerst. Mit limit und optionalem cursor paginieren. Soft-gelöschte Bestellungen fehlen, ausser includeDeleted=true; diese Zeilen sind mit deleted: true markiert.

GET/orders

Autorisierung

AutorisierungBearer-Token (API key) · headererforderlich

Organisations-API-Key.

Query-Parameter

startstring<date-time>erforderlich

Beginn des Zeitraums (ISO-8601).

endstring<date-time>erforderlich

Ende des Zeitraums (ISO-8601).

paymentStatestring

Optionaler Filter nach Zahlungsstatus. Weglassen, um alle Zahlungsstatus im Zeitraum zu erhalten.

Erlaubt:successfulcancelledtimeoutfailedpending

limitinteger

Seitengrösse (1–5000, Standard 100).

min 1 · max 5000 · default: 100

cursorstring

Opake Dokument-ID für die nächste Seite. Nicht parsen. `meta.nextCursor` folgen, bis es fehlt.

includeDeletedboolean

Wenn true, soft-gelöschte Bestellungen mit `deleted: true` einbeziehen. Standard false.

default: false

Antworten

200Bestellungen mit Meta

dataOrder[]erforderlich

Eigenschaften anzeigen

Array of Order

idstring

orderIdstring

orderDatestring<date-time>

transactionDatestring<date-time>

paymentMethodstring

paymentStatestring

Erlaubt:successfulcancelledtimeoutfailedpending

paymentBrandstring

priceinteger

Bestelltotal in Rappen

storestring

Store-ID

transactionMessagestring

giftcardIdstring

giftcardFunctionstring

deletedboolean

Soft-gelöscht wenn true. Bei Abruf per ID immer; in Listen nur mit `includeDeleted=true`.

productsOrderLine[]

Eigenschaften anzeigen

Array of OrderLine

productIdstring

titlestring

priceinteger

Positionstotal in Rappen.

netPriceinteger

Nettobetrag in Rappen.

depositinteger

Depot in Rappen.

costPriceinteger

quantitynumber

weightnumber

supplierstring

categorystring

taxinteger

Steuerbetrag in Rappen.

taxRatenumber

typestring

z. B. product, coupon, giftcard.

imageUrlstring

originalProductIdstring

originalPriceinteger

discountnumber

undiscountedPriceinteger

storestring

printTicketboolean

flagsany

Vorhanden bei Abruf per ID.

resolutionany

Optional; vorhanden bei Abruf per ID.

metaListMetaerforderlich

Listen-Metadaten. `returned` ist die Länge von `data`. Soft-gelöschte Katalogeinträge fehlen in Listen — `returned` kann kleiner als `limit` sein, auch wenn noch aktive Einträge existieren.

Eigenschaften anzeigen

totalintegererforderlich

Bei Produktsuche (`q`): geschätzte Trefferanzahl. Sonst gleich `returned`. Kann kleiner als `limit` sein, wenn soft-gelöschte Einträge von der Seite gefiltert wurden.

returnedintegererforderlich

Anzahl aktiver Einträge in `data` (soft-gelöschte ausgeschlossen).

limitintegererforderlich

Angewendete Seitengrösse.

offsetinteger

Nur bei Produktsuche mit `q`.

nextCursorstring

Opaker Cursor für die nächste Seite. Gesetzt, wenn weitere Ergebnisse möglich sind. Unverändert als `cursor` übergeben. Bei Soft-Delete- oder `store`-Filter bedeutet `returned < limit` nicht, dass die Liste zu Ende ist.

400Ungültige Anfrage

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

pathstringerforderlich

Request-Pfad

403Nicht autorisiert

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

pathstringerforderlich

Request-Pfad

Anfrage

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"

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: {
    "Autorisierung": "Bearer YOUR_TOKEN"
  }
});

Antwort

{
  "data": [
    {
      "id": "string",
      "orderId": "string",
      "orderDate": "2019-08-24T14:15:22Z",
      "transactionDate": "2019-08-24T14:15:22Z",
      "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
        }
      ],
      "flags": null,
      "resolution": null
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}