Elenca ordini

Elenca gli ordini. Richiede start, end e paymentState. Dal più recente. Usa limit e cursor opzionale per paginare.

GET/orders

Autorizzazione

AutorizzazioneToken Bearer (API key) · headerobbligatorio

Chiave API dell'organizzazione.

Parametri query

startstring<date-time>obbligatorio

Inizio dell'intervallo (ISO-8601).

endstring<date-time>obbligatorio

Fine dell'intervallo (ISO-8601).

paymentStatestringobbligatorio

Filtro sullo stato del pagamento.

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.

Risposte

200Ordini con meta

dataOrder[]obbligatorio

Mostra proprietà

Array of Order

idstring

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

productsOrderLine[]

Mostra proprietà

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

typestring

es. product, coupon, giftcard.

imageUrlstring

originalProductIdstring

originalPriceinteger

discountnumber

undiscountedPriceinteger

storestring

printTicketboolean

flagsany

Presente su get-by-id.

resolutionany

Opzionale; presente su get-by-id.

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 attivi in `data` (righe eliminate escluse).

limitintegerobbligatorio

Dimensione della pagina applicata.

offsetinteger

Solo per la ricerca prodotti con `q`.

nextCursorstring

Cursore opaco per la pagina successiva. Presente quando possono esistere altri risultati. Non analizzare; passare invariato come `cursor`. Con filtro soft-delete o `store`, `returned < limit` non significa fine elenco.

400Richiesta non valida

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

pathstringobbligatorio

Percorso della richiesta

403Non autorizzato

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

pathstringobbligatorio

Percorso della richiesta

Richiesta

curl -X GET "https://dashboard.scango.ch/api/v1/orders?start=2024-01-01T00%3A00%3A00Z&end=2024-01-01T00%3A00%3A00Z&paymentState=successful" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://dashboard.scango.ch/api/v1/orders?start=2024-01-01T00%3A00%3A00Z&end=2024-01-01T00%3A00%3A00Z&paymentState=successful", {
  method: "GET",
  headers: {
    "Autorizzazione": "Bearer YOUR_TOKEN"
  }
});

Risposta

{
  "data": [
    {
      "id": "string",
      "orderId": "string",
      "orderDate": "2024-01-01T00:00:00Z",
      "transactionDate": "2024-01-01T00:00:00Z",
      "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": "string",
      "resolution": "string"
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}