Bestellung per ID abrufen

Bestellung anhand der ID abrufen, inklusive Positionen. Soft-gelöschte Bestellungen werden mit deleted: true zurückgegeben.

GET/orders/{orderId}

Autorisierung

AuthorizationBearer-Token (API-Key) · headererforderlich

Organisations-API-Key.

Pfadparameter

orderIdstringerforderlich

Antworten

200

Bestelldetails

dataOrdererforderlich

Bestellung. Daten sind ISO-8601. Geldfelder sind Ganzzahlen in Rappen.

Eigenschaften anzeigen

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

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).

404

Kein Eintrag mit dieser ID.

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

orderIdpath*

Anfrage

curl -X GET 'https://dashboard.scango.ch/api/v1/orders/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://dashboard.scango.ch/api/v1/orders/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://dashboard.scango.ch/api/v1/orders/string",
    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/string',
  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": 240,
    "paymentState": "successful",
    "paymentMethod": "card",
    "paymentBrand": "visa",
    "orderDate": "2024-04-20T12:00:00.000Z",
    "transactionDate": "2024-04-20T12:00:01.000Z",
    "transactionMessage": "",
    "giftcardId": "",
    "products": [
      {
        "productId": "a1b2c3",
        "quantity": 2,
        "title": "Mineralwasser 50cl",
        "price": 240,
        "netPrice": 234,
        "tax": 6,
        "taxRate": 0.026,
        "type": "product",
        "supplier": "sup_01",
        "category": "cat_01",
        "deposit": 0
      }
    ]
  }
}

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

{
  "statusCode": 0,
  "message": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "path": "string"
}