Vai al contenuto
ShopentlyLearn

Elenca — Ordini

Leggi i dati di «Ordini». Il risultato dipende dai parametri di questa operazione.

GET/api/v1/orders

Autenticazione
Bearer
Disponibile dal piano
BASIC
Permessi necessari
orders.order:read

Esempi di codice

Esempio di richiesta

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"'/api/v1/orders?limit=20'

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/orders?limit=20');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'GET', base_url + '/api/v1/orders?limit=20', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

Esempio di risposta 200

JSON
{
  "data": [
    {
      "created_at": "2026-10-19T10:00:00Z",
      "customer": {
        "email": "customer@example.invalid",
        "first_name": "Example",
        "last_name": "Example",
        "phone": null
      },
      "delivery": {
        "amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "dates": {
          "dispatch_timezone": "Europe/Warsaw",
          "estimated_delivery_from": "2026-10-20",
          "estimated_delivery_to": "2026-10-21",
          "planned_dispatch_on": "2026-10-19"
        },
        "method_code": "shipping-old",
        "method_name": "Historic carrier",
        "pickup_point": null,
        "recipient_mode": "full_address"
      },
      "discount_amount": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "id": "order-0000",
      "lifecycle_state": "placed",
      "locale": "pl",
      "market_id": "market-pl",
      "number": "0001",
      "payment": {
        "amount": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "environment": "live",
        "method_code": "payment-old",
        "method_name": "Historic method",
        "paid_at": null,
        "status": "unpaid",
        "updated_at": "2026-10-19T10:00:00Z",
        "version": 0
      },
      "prices_include_tax": true,
      "shipping_discount_amount": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "status": {
        "id": "status-0",
        "name": "Status 0",
        "updated_at": "2026-10-19T10:00:00Z",
        "version": 1
      },
      "subtotal": {
        "amount": "329.40",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax": {
        "amount": "49.40",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_country_code": "PL",
      "total": {
        "amount": "329.40",
        "currency": "PLN",
        "minor_units": 2
      }
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "limit": 20,
      "next_cursor": null
    },
    "request_id": "example"
  }
}

Principi

  • La collezione offre riepiloghi e filtri per numero, stato, stato del pagamento e data di creazione.
  • Elenco e dettagli degli ordini includono delivery.dates. Le date YYYY-MM-DD sono pianificate e non confermano la spedizione. Le date attuali hanno priorità; gli ordini precedenti usano la stima salvata. I valori cancellati o sconosciuti sono null. I dettagli includono anche tutte le righe e le immagini dei prodotti.
  • Ottieni gli identificativi degli stati validi da /api/v1/order-statuses.
  • Stato dell’ordine e del pagamento hanno endpoint PATCH e permessi distinti.
  • Cambiare lo stato registrato del pagamento non addebita una carta e non esegue un rimborso tramite il fornitore di pagamenti.

Ordine · Totali

Importi e aliquote provengono dall’ordine salvato, comprese le correzioni delle righe. I dati storici mancanti sono null e non vengono sostituiti con le aliquote attuali del catalogo. Gli importi restano stringhe decimali.

L’elenco restituisce riepiloghi. Recupera GET /api/v1/orders/{order_id} per ogni risultato per esportare tutti i dettagli finanziari. I tentativi GET sono limitati e rispettano Retry-After. L’esportazione per data di creazione non sincronizza correzioni successive.

Parametri

Parametri di query

limitInteroFacoltativo

Numero massimo di record in questa pagina.

minimum: 1maximum: 100
Valore predefinito: 50Esempio: 20
cursorStringa nullFacoltativo

Valore opaco di continuazione restituito dalla pagina precedente.

Stringa:minLength: 1maxLength: 1024
numberStringa nullFacoltativo

Numero dell’ordine o della richiesta destinato alle persone.

Stringa:minLength: 1maxLength: 48
status_idStringa nullFacoltativo

Identificativo ottenuto dal dizionario degli stati pertinente.

Vincoli · Stringa 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
payment_statusStringa nullFacoltativo

Stato del pagamento registrato.

Vincoli · Stringa 1
enum
["unpaid", "paid", "failed", "refunded"]
created_fromStringa nullFacoltativo

Inizio del filtro per data di creazione.

Stringa:format: "date-time"
created_toStringa nullFacoltativo

Fine del filtro per data di creazione.

Stringa:format: "date-time"

Questa operazione non accetta un corpo JSON.

Risposte

Risposta 200

dataArray <OrderSummaryData > Obbligatorio

Contenuto di una risposta riuscita.

Campi · data

OrderSummaryData

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
customerCustomerData Obbligatorio

Dati del cliente registrati per questa risorsa.

deliveryShippingData Obbligatorio

Metodo di consegna e informazioni associate.

discount_amountMoneyData Obbligatorio

Importo decimale codificato come stringa JSON; null solo dove consentito.

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

lifecycle_stateOrderLifecycleState Obbligatorio

Stato del ciclo di vita operativo.

localeStringaObbligatorio

Lingua selezionata per questa richiesta.

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

paymentPaymentData Obbligatorio

Dettagli del pagamento registrati per l’ordine.

prices_include_taxBooleanoObbligatorio

Indica se i prezzi elencati includono le imposte.

shipping_discount_amountMoneyData Obbligatorio

Importo decimale codificato come stringa JSON; null solo dove consentito.

statusOrderStatusData Obbligatorio

Stato accettato da questa specifica operazione.

subtotalMoneyData Obbligatorio

Importo prima delle componenti aggiuntive indicate nella risposta.

taxMoneyData Obbligatorio

Informazioni fiscali.

tax_country_codeStringa nullObbligatorio

Paese fiscale · Dati registrati dell’ordine · ISO 3166-1 alpha-2; null.

totalMoneyData Obbligatorio

Importo totale.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Campi · meta

ContextPageMeta

localeStringaObbligatorio

Lingua selezionata per questa richiesta.

market_codeStringaObbligatorio

Codice del mercato restituito dall’endpoint del contesto.

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

paginationPagination Obbligatorio

Metadati della paginazione a cursore.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

ContextMeta

localeStringaObbligatorio

Lingua selezionata per questa richiesta.

market_codeStringaObbligatorio

Codice del mercato restituito dall’endpoint del contesto.

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obbligatorio

Metadati della paginazione a cursore.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100
Esempio di risposta

Stato HTTP

200
Risposta riuscita Schema
400
Richiesta non valida
401
Autenticazione richiesta
403
Permesso negato
404
Risorsa non trovata
409
Conflitto di versione
422
Validazione non riuscita
429
Limite di richieste superato
Altri stati HTTP (7)
405
Metodo non consentito
413
Richiesta troppo grande
415
Formato non supportato
500
Errore del server
502
Errore del gateway API
503
Servizio non disponibile
504
Tempo di attesa scaduto

Catalogo degli errori: ErrorResponse

Header

401

WWW-AuthenticateStringaFacoltativo

Schema di autenticazione richiesto dal server.

405

AllowStringaFacoltativo

Metodi HTTP supportati da questa risorsa.

429, 503

Retry-AfterInteroFacoltativo

Attesa minima prima di riprovare, in secondi.

minimum: 0