Obtenir une commande par ID

Récupère une commande par id, y compris les lignes. Les commandes supprimées sont renvoyées avec deleted: true.

GET/orders/{orderId}

Autorisation

AuthorizationJeton Bearer (clé API) · headerobligatoire

Clé API de l’organisation.

Paramètres de chemin

orderIdstringobligatoire

Réponses

200

Détails de la commande

dataOrderobligatoire

Commande. Les dates sont en ISO-8601. Les champs monétaires sont des entiers en centimes.

Afficher les propriétés

idstringobligatoire

Identifiant

orderIdstring

orderDatestring<date-time>

transactionDatestring<date-time>

paymentMethodstring

paymentStatestring

Autorisé:successfulcancelledtimeoutfailedpending

paymentBrandstring

priceinteger

Total de la commande en centimes

storestring

Id du magasin

transactionMessagestring

giftcardIdstring

giftcardFunctionstring

deletedboolean

Présent s’il est enregistré. Les listes n’incluent les commandes avec deleted: true qu’avec includeDeleted=true ; l’obtention par id les renvoie toujours.

productsOrderLine[]obligatoire

Afficher les propriétés

Tableau de OrderLine

productIdstring

titlestring

priceinteger

Total de la ligne en centimes.

netPriceinteger

Montant net en centimes.

depositinteger

Consigne en centimes.

costPriceinteger

quantitynumber

weightnumber

supplierstring

categorystring

taxinteger

Montant de taxe en centimes.

taxRatenumber

Taux de TVA en fraction décimale (0.081 = 8,1 %).

typestring

p. ex. product, coupon, giftcard.

imageUrlstring

originalProductIdstring

originalPriceinteger

discountnumber

undiscountedPriceinteger

storestring

printTicketboolean

403

Clé API absente, inconnue ou inactive, ou clé Read sur une opération d’écriture.

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

Moment de l’erreur (UTC).

pathstringobligatoire

URL de la requête (chemin et chaîne de requête).

404

Aucun élément avec cet id.

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

Moment de l’erreur (UTC).

pathstringobligatoire

URL de la requête (chemin et chaîne de requête).

Essayer

Serveur

URL de baseURL de base personnaliséeRemplace le serveur sélectionné si renseignée.

Autorisation

Jeton Bearer (clé API)Mémoriser sur cet appareilUtiliser mes valeurs dans les exemples

Paramètres

orderIdpath*

Requête

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

Réponse

{
  "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": "Eau minérale 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"
}