Ottieni ordine per ID

Ottieni un ordine per id, inclusi gli articoli in riga. Gli ordini eliminati vengono restituiti con deleted: true.

GET/orders/{orderId}

Autorizzazione

AuthorizationToken Bearer (chiave API) · headerobbligatorio

Chiave API dell'organizzazione.

Parametri path

orderIdstringobbligatorio

Risposte

200

Dettagli dell'ordine

dataOrderobbligatorio

Ordine. Le date sono ISO-8601. I campi monetari sono interi in centesimi.

Mostra proprietà

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

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

404

Nessun elemento con questo id.

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

orderIdpath*

Richiesta

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

Risposta

{
  "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": "Acqua minerale 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"
}