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

AuthorizationBearer-Token (API-Key) · headererforderlich

Organisations-API-Key.

Query-Parameter

startstring<date-time>erforderlich

Beginn des orderDate-Zeitraums, inklusive. UTC mit Z, z. B. 2024-01-01T00:00:00.000Z; Offsets wie +02:00 werden abgelehnt.

endstring<date-time>erforderlich

Ende des orderDate-Zeitraums, inklusive. UTC mit Z.

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.

min length 1

includeDeletedboolean

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

default: false

Antworten

200

Bestellungen mit Meta

dataOrder[]erforderlich

Eigenschaften anzeigen

Array von Order

idstringerforderlich

orderIdstring

orderDatestring<date-time>

transactionDatestring<date-time>

paymentMethodstring

paymentStatestring

Erlaubt:successfulcancelledtimeoutfailedpending

paymentBrandstring

priceinteger

Bestelltotal in Rappen

storestring

Store-ID

transactionMessagestring

giftcardIdstring

giftcardFunctionstring

deletedboolean

Vorhanden, wenn gespeichert. Listen enthalten Bestellungen mit deleted: true nur mit includeDeleted=true; der Abruf per ID liefert sie immer.

productsOrderLine[]erforderlich

Eigenschaften anzeigen

Array von 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

MwSt.-Satz als Dezimalbruch (0.081 = 8,1 %).

typestring

z. B. product, coupon, giftcard.

imageUrlstring

originalProductIdstring

originalPriceinteger

discountnumber

undiscountedPriceinteger

storestring

printTicketboolean

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 Einträge in data. Mit includeDeleted=true (Bestellungen) zählen gelöschte Bestellungen mit.

limitintegererforderlich

Angewendete Seitengrösse.

offsetinteger

Nur bei Produktsuche mit q.

nextCursorstring

Opaker Cursor für die nächste Seite; unverändert als cursor übergeben. Vorhanden, wenn weitere Ergebnisse existieren können. Soft-gelöschte Einträge werden nach dem Lesen herausgefiltert, daher kann eine Seite kürzer als limit sein, obwohl nextCursor gesetzt ist. Bei Kategorien, Lieferanten und Filialen nie vorhanden, da diese nicht paginiert sind.

400

Ungültige Parameter oder ungültiger Body.

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

Zeitpunkt des Fehlers (UTC).

pathstringerforderlich

Request-URL (Pfad und Query-String).

403

Fehlender, unbekannter oder inaktiver API-Key oder ein Read-Key bei einem Schreibzugriff.

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

Zeitpunkt des Fehlers (UTC).

pathstringerforderlich

Request-URL (Pfad und Query-String).

Ausprobieren

Server

Basis-URLEigene Basis-URLÜberschreibt den gewählten Server, wenn gesetzt.

Autorisierung

Bearer-Token (API-Key)Auf diesem Gerät merkenMeine Werte in Beispielen verwenden

Parameter

startquery*Beginn des `orderDate`-Zeitraums, inklusive. UTC mit `Z`, z. B. `2024-01-01T00:00:00.000Z`; Offsets wie `+02:00` werden abgelehnt.endquery*Ende des `orderDate`-Zeitraums, inklusive. UTC mit `Z`.paymentStatequeryOptionaler Filter nach Zahlungsstatus. Weglassen, um alle Zahlungsstatus im Zeitraum zu erhalten.limitquerySeitengrösse (1–5000, Standard 100).cursorqueryOpake Dokument-ID für die nächste Seite. Nicht parsen. `meta.nextCursor` folgen, bis es fehlt.includeDeletedqueryWenn true, soft-gelöschte Bestellungen mit `deleted: true` einbeziehen. Standard false.

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' \
  -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);

Antwort

{
  "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"
}