Lister les commandes

Liste les commandes. Nécessite start et end. paymentState est optionnel. Les plus récentes en premier. Utilisez limit et cursor optionnel pour paginer. Les commandes supprimées sont exclues sauf includeDeleted=true ; elles sont alors marquées deleted: true.

GET/orders

Autorisation

AuthorizationJeton Bearer (clé API) · headerobligatoire

Clé API de l’organisation.

Paramètres de requête

startstring<date-time>obligatoire

Début de la période orderDate, inclus. UTC avec Z, p. ex. 2024-01-01T00:00:00.000Z ; les décalages comme +02:00 sont refusés.

endstring<date-time>obligatoire

Fin de la période orderDate, incluse. UTC avec Z.

paymentStatestring

Filtre optionnel sur le statut de paiement. Omettre pour renvoyer tous les statuts dans la plage de dates.

Autorisé:successfulcancelledtimeoutfailedpending

limitinteger

Taille de page (1–5000, défaut 100).

min 1 · max 5000 · default: 100

cursorstring

Identifiant opaque de document pour la page suivante. Ne pas analyser. Suivre meta.nextCursor jusqu'à son absence.

min length 1

includeDeletedboolean

Si true, inclure les commandes supprimées marquées deleted: true. Défaut false.

default: false

Réponses

200

Commandes avec meta

dataOrder[]obligatoire

Afficher les propriétés

Tableau de Order

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

metaListMetaobligatoire

Métadonnées de liste. returned est la longueur de data. Les entrées de catalogue supprimées (soft delete) sont exclues des listes — returned peut être inférieur à limit même s'il reste des entrées actives.

Afficher les propriétés

totalintegerobligatoire

Avec recherche produit (q) : nombre estimé de correspondances. Sinon égal à returned. Peut être inférieur à limit lorsque des entrées supprimées ont été filtrées de la page.

returnedintegerobligatoire

Nombre d’éléments dans data. Avec includeDeleted=true (commandes), les commandes supprimées sont comptées.

limitintegerobligatoire

Taille de page appliquée.

offsetinteger

Uniquement pour la recherche produit avec q.

nextCursorstring

Curseur opaque pour la page suivante ; à transmettre tel quel dans cursor. Présent lorsque d’autres résultats peuvent exister. Les éléments supprimés logiquement sont filtrés après lecture, une page peut donc être plus courte que limit alors que nextCursor est présent. Jamais renvoyé pour les catégories, fournisseurs et magasins, qui ne sont pas paginés.

400

Paramètres ou corps invalides.

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

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

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

startquery*Début de la période `orderDate`, inclus. UTC avec `Z`, p. ex. `2024-01-01T00:00:00.000Z` ; les décalages comme `+02:00` sont refusés.endquery*Fin de la période `orderDate`, incluse. UTC avec `Z`.paymentStatequeryFiltre optionnel sur le statut de paiement. Omettre pour renvoyer tous les statuts dans la plage de dates.limitqueryTaille de page (1–5000, défaut 100).cursorqueryIdentifiant opaque de document pour la page suivante. Ne pas analyser. Suivre `meta.nextCursor` jusqu'à son absence.includeDeletedquerySi true, inclure les commandes supprimées marquées `deleted: true`. Défaut false.

Requête

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

Réponse

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