Elenca ordini

Elenca gli ordini. Richiede start e end. paymentState è opzionale. Dal più recente. Usa limit e cursor opzionale per paginare. Gli ordini eliminati sono esclusi salvo includeDeleted=true; in quel caso sono contrassegnati con deleted: true.

GET/orders

Autorizzazione

AuthorizationToken Bearer (chiave API) · headerobbligatorio

Chiave API dell'organizzazione.

Parametri query

startstring<date-time>obbligatorio

Inizio dell’intervallo orderDate, incluso. UTC con Z, ad es. 2024-01-01T00:00:00.000Z; offset come +02:00 vengono rifiutati.

endstring<date-time>obbligatorio

Fine dell’intervallo orderDate, inclusa. UTC con Z.

paymentStatestring

Filtro opzionale sullo stato del pagamento. Omettere per ottenere tutti gli stati nell'intervallo di date.

Consentiti:successfulcancelledtimeoutfailedpending

limitinteger

Dimensione della pagina (1–5000, predefinito 100).

min 1 · max 5000 · default: 100

cursorstring

Id documento opaco per la pagina successiva. Non analizzare. Seguire meta.nextCursor finché assente.

min length 1

includeDeletedboolean

Se true, include gli ordini eliminati contrassegnati con deleted: true. Predefinito false.

default: false

Risposte

200

Ordini con meta

dataOrder[]obbligatorio

Mostra proprietà

Array di Order

idstringobbligatorio

Identificativo

orderIdstring

orderDatestring<date-time>

transactionDatestring<date-time>

paymentMethodstring

paymentStatestring

Consentiti:successfulcancelledtimeoutfailedpending

paymentBrandstring

priceinteger

Totale dell'ordine in centesimi

storestring

Id del negozio

transactionMessagestring

giftcardIdstring

giftcardFunctionstring

deletedboolean

Presente se salvato. Gli elenchi includono gli ordini con deleted: true solo con includeDeleted=true; il recupero per id li restituisce sempre.

productsOrderLine[]obbligatorio

Mostra proprietà

Array di OrderLine

productIdstring

titlestring

priceinteger

Totale riga in centesimi.

netPriceinteger

Importo netto in centesimi.

depositinteger

Cauzione in centesimi.

costPriceinteger

quantitynumber

weightnumber

supplierstring

categorystring

taxinteger

Importo delle imposte in centesimi.

taxRatenumber

Aliquota IVA come frazione decimale (0.081 = 8,1%).

typestring

es. product, coupon, giftcard.

imageUrlstring

originalProductIdstring

originalPriceinteger

discountnumber

undiscountedPriceinteger

storestring

printTicketboolean

metaListMetaobbligatorio

Metadati dell'elenco. returned è la lunghezza di data. Le voci di catalogo eliminate (soft delete) sono escluse dagli elenchi — returned può essere minore di limit anche se esistono altre voci attive.

Mostra proprietà

totalintegerobbligatorio

Con ricerca prodotti (q): conteggio stimato dei risultati. Altrimenti uguale a returned. Può essere minore di limit quando voci eliminate sono state filtrate dalla pagina.

returnedintegerobbligatorio

Numero di elementi in data. Con includeDeleted=true (ordini) contano anche gli ordini eliminati.

limitintegerobbligatorio

Dimensione della pagina applicata.

offsetinteger

Solo per la ricerca prodotti con q.

nextCursorstring

Cursore opaco per la pagina successiva; passarlo invariato come cursor. Presente quando possono esistere altri risultati. Gli elementi eliminati (soft-delete) vengono filtrati dopo la lettura, quindi una pagina può essere più corta di limit anche con nextCursor presente. Mai restituito per categorie, fornitori e negozi, che non sono paginati.

400

Parametri o body non validi.

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

Momento dell’errore (UTC).

pathstringobbligatorio

URL della richiesta (percorso e query string).

403

Chiave API mancante, sconosciuta o inattiva, oppure chiave Read su un’operazione di scrittura.

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

Momento dell’errore (UTC).

pathstringobbligatorio

URL della richiesta (percorso e query string).

Prova

Server

URL di baseURL di base personalizzatoSostituisce il server selezionato se impostato.

Autorizzazione

Token Bearer (chiave API)Ricorda su questo dispositivoUsa i miei valori negli esempi

Parametri

startquery*Inizio dell’intervallo `orderDate`, incluso. UTC con `Z`, ad es. `2024-01-01T00:00:00.000Z`; offset come `+02:00` vengono rifiutati.endquery*Fine dell’intervallo `orderDate`, inclusa. UTC con `Z`.paymentStatequeryFiltro opzionale sullo stato del pagamento. Omettere per ottenere tutti gli stati nell'intervallo di date.limitqueryDimensione della pagina (1–5000, predefinito 100).cursorqueryId documento opaco per la pagina successiva. Non analizzare. Seguire `meta.nextCursor` finché assente.includeDeletedquerySe true, include gli ordini eliminati contrassegnati con `deleted: true`. Predefinito false.

Richiesta

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

Risposta

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