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

AutorisationJeton Bearer (API key) · headerobligatoire

Clé API de l’organisation.

Paramètres de requête

startstring<date-time>obligatoire

Début de la plage (ISO-8601).

endstring<date-time>obligatoire

Fin de la plage (ISO-8601).

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.

includeDeletedboolean

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

default: false

Réponses

200Commandes avec meta

dataOrder[]obligatoire

Afficher les propriétés

Array of Order

idstring

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

Supprimée lorsque true. Toujours présente à l'obtention par id ; en liste seulement avec `includeDeleted=true`.

productsOrderLine[]

Afficher les propriétés

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

typestring

p. ex. product, coupon, giftcard.

imageUrlstring

originalProductIdstring

originalPriceinteger

discountnumber

undiscountedPriceinteger

storestring

printTicketboolean

flagsany

Présent lors de l’obtention par id.

resolutionany

Optionnel ; présent lors de l’obtention par id.

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 actifs dans `data` (entrées supprimées exclues).

limitintegerobligatoire

Taille de page appliquée.

offsetinteger

Uniquement pour la recherche produit avec `q`.

nextCursorstring

Curseur opaque pour la page suivante. Présent lorsque d'autres résultats sont possibles. Ne pas analyser ; transmettre tel quel comme `cursor`. Avec filtre soft-delete ou `store`, `returned < limit` ne signifie pas la fin de la liste.

400Requête incorrecte

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

pathstringobligatoire

Chemin de la requête

403Non autorisé

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

pathstringobligatoire

Chemin de la requête

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"

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

Réponse

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