Recupera — Ordini

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

GET`/api/v1/orders/{order_id}`

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

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/example

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/example');
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/example', 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"
      },
      "discount_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discounts": [
        {
          "amount": {
            "amount": "24.60",
            "currency": "PLN",
            "minor_units": 2
          },
          "campaign_id": "saved-coupon",
          "code": "SAVE",
          "kind": "coupon",
          "name": "Saved coupon",
          "sequence": 1,
          "version": 3
        }
      ],
      "gross": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "method_code": "shipping-old",
      "method_name": "Historic carrier",
      "net": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "pickup_point": null,
      "recipient_mode": "full_address",
      "tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_category_id": "standard",
      "tax_category_name": "VAT 23%",
      "tax_rate": "0.23"
    },
    "discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "discounts": [
      {
        "amount": {
          "amount": "12.30",
          "currency": "PLN",
          "minor_units": 2
        },
        "campaign_id": "saved-coupon",
        "code": "SAVE",
        "kind": "coupon",
        "name": "Saved coupon",
        "sequence": 1,
        "shipping_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "version": 3
      }
    ],
    "id": "order-0000",
    "invoice": null,
    "invoice_requested": false,
    "lifecycle_state": "placed",
    "lines": [
      {
        "discount_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [
          {
            "amount": {
              "amount": "12.30",
              "currency": "PLN",
              "minor_units": 2
            },
            "campaign_id": "saved-coupon",
            "code": "SAVE",
            "kind": "coupon",
            "name": "Saved coupon",
            "sequence": 1,
            "shipping_amount": null,
            "version": 3
          }
        ],
        "identifiers": {},
        "image": null,
        "line_id": "saved-line-a",
        "manual_discount": {
          "amount": {
            "amount": "12.30",
            "currency": "PLN",
            "minor_units": 2
          },
          "kind": "fixed",
          "value": "12.30"
        },
        "name": "Saved A",
        "original_total": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "200.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "46.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 1,
        "product_id": "product-api",
        "quantity": 2,
        "sku": "A",
        "tax": {
          "amount": "20.70",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax_category_id": "standard",
        "tax_category_name": "VAT 23%",
        "tax_rate": "0.23",
        "total": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "180.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "41.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "23.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      },
      {
        "discount_amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [],
        "identifiers": {},
        "image": null,
        "line_id": "b548a171-c331-505f-98f8-db3a06070998",
        "manual_discount": null,
        "name": "Saved B",
        "original_total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 2,
        "product_id": "deleted-product",
        "quantity": 1,
        "sku": "B",
        "tax": null,
        "tax_category_id": "reduced",
        "tax_category_name": "VAT 8%",
        "tax_rate": "0.08",
        "total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      }
    ],
    "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
    },
    "pickup_point": null,
    "prices_include_tax": true,
    "shipping_address": null,
    "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_breakdown": {
      "groups": [
        {
          "gross": {
            "amount": "221.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "180.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "41.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        },
        {
          "gross": {
            "amount": "108.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "100.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "8.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.08"
        },
        {
          "gross": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "shipping",
          "tax": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        }
      ],
      "unallocated_tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      }
    },
    "tax_country_code": "PL",
    "total": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "totals": {
      "before_discounts": {
        "gross": {
          "amount": "378.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "320.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "58.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "discounts": {
        "gross": {
          "amount": "49.20",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "40.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "9.20",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "order": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "product_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products_before_discounts": {
        "gross": {
          "amount": "354.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "300.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "54.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping": {
        "gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_before_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      }
    }
  },
  "meta": {
    "request_id": "example-request"
  }
}

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.

Scritture sicure

Permessi e piani

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.

tax_country_code · Paese fiscale · Dati registrati dell’ordine · ISO 3166-1 alpha-2; null.
lines[].unit_* · Una unità · Prima degli sconti; lines[].original_total_* · Prima degli sconti; lines[].total_* · Dopo gli sconti.
lines[].discount_* · Sconti; manual_discount · Sconto manuale; percentage "10" = 10%.
delivery.net / tax / gross · Dopo gli sconti; delivery.original_* · Prima degli sconti; delivery.discount_* · Sconti.
tax_rate: "0.23" = 23%; "0" ≠ null. Sconosciuto: null; zero noto: 0.
totals · Totali; tax_breakdown.groups · Gruppi fiscali; Imposta non assegnata = order.tax − Σ groups.tax; ±.

payment.amount è il totale dell’ordine. Lo stato del pagamento non determina importi pagati, rimborsati o ancora dovuti.

Parametri

Parametri del percorso

order_idStringaObbligatorio

Identificativo dell’ordine collegato.

Vincoli

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Esempio: "example"

Questa operazione non accetta un corpo JSON.

Risposte

Risposta 200

Modello completo: ApiResponse_OrderDetailData_

dataOrderDetailData Obbligatorio

Contenuto di una risposta riuscita.

Campi · data

Modello completo: OrderDetailData

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"

customerCustomerData Obbligatorio

Dati del cliente registrati per questa risorsa.

Campi · customer

Modello completo: CustomerData

emailStringaObbligatorio: Indirizzo email.
first_nameStringa nullObbligatorio: Nome.
last_nameStringa nullObbligatorio: Cognome.
phoneStringa nullObbligatorio: Numero di telefono.

deliveryShippingDetailData Obbligatorio

Metodo di consegna e informazioni associate.

Campi · delivery

Modello completo: ShippingDetailData

amountMoneyData Obbligatorio

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

datesDeliveryDatesData Obbligatorio

Date di spedizione e consegna

discount_grossMoneyData Obbligatorio

Importo lordo · Sconti; Sconosciuto: null; zero noto: 0.

discount_netMoneyData nullObbligatorio

Importo netto · Sconti; Sconosciuto: null; zero noto: 0.

discount_taxMoneyData nullObbligatorio

Importo dell’imposta · Sconti; Sconosciuto: null; zero noto: 0.

discountsArray <OrderDeliveryDiscountData > nullObbligatorio

Sconti

grossMoneyData Obbligatorio

Importo lordo · Dopo gli sconti; Sconosciuto: null; zero noto: 0.

method_codeStringa nullObbligatorio

Codice del metodo di consegna o pagamento.

method_nameStringa nullObbligatorio

Nome del metodo di consegna o pagamento.

netMoneyData nullObbligatorio

Importo netto · Dopo gli sconti; Sconosciuto: null; zero noto: 0.

original_grossMoneyData Obbligatorio

Importo lordo · Spedizione · Prima degli sconti; Sconosciuto: null; zero noto: 0.

original_netMoneyData nullObbligatorio

Importo netto · Spedizione · Prima degli sconti; Sconosciuto: null; zero noto: 0.

original_taxMoneyData nullObbligatorio

Importo dell’imposta · Spedizione · Prima degli sconti; Sconosciuto: null; zero noto: 0.

pickup_pointDeliveryPickupPointData nullObbligatorio

Punto di ritiro

recipient_modeStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["full_address", "pickup_contact"]

taxMoneyData nullObbligatorio

Informazioni fiscali.

tax_category_idStringa nullObbligatorio

Identificativo della categoria fiscale.

tax_category_nameStringa nullObbligatorio

Nome registrato della categoria fiscale; null.

tax_rateStringa nullObbligatorio

tax_rate · Dati registrati dell’ordine: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Obbligatorio

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

Campi · discount_amount

Modello completo: MoneyData

amountStringaObbligatorio

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

currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli

pattern: "^[A-Z]{3}$"

minor_unitsInteroObbligatorio

Numero di cifre decimali usate dalla valuta.

minimum: 0maximum: 4

discountsArray <OrderDiscountData > Obbligatorio

Sconti

Campi · discounts

OrderDiscountData

Modello completo: OrderDiscountData

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

invoiceInvoiceData nullObbligatorio

Informazioni sulla fattura.

Campi · invoice

InvoiceData

Modello completo: InvoiceData

null

invoice_requestedBooleanoObbligatorio

Indica se è stata richiesta una fattura.

lifecycle_stateOrderLifecycleState Obbligatorio

Stato del ciclo di vita operativo.

linesArray <OrderLineData > Obbligatorio

Dati delle righe conservati nell’ordine.

Campi · lines

OrderLineData

Modello completo: OrderLineData

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.

Campi · payment

Modello completo: PaymentData

amountMoneyData Obbligatorio

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

environmentStringaObbligatorio

Informazioni sull’ambiente associate al record.

Vincoli

enum: ["live", "sandbox"]

method_codeStringa nullObbligatorio

Codice del metodo di consegna o pagamento.

method_nameStringa nullObbligatorio

Nome del metodo di consegna o pagamento.

paid_atStringa nullObbligatorio

Data e ora in cui il pagamento è stato contrassegnato come pagato.

Stringa:format: "date-time"

statusOrderPaymentStatus Obbligatorio

Stato accettato da questa specifica operazione.

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

pickup_pointPickupPointData nullObbligatorio

Punto di ritiro

Campi · pickup_point

PickupPointData

Modello completo: PickupPointData

null

prices_include_taxBooleanoObbligatorio

Indica se i prezzi elencati includono le imposte.

shipping_addressAddressData nullObbligatorio

Indirizzo di consegna.

Campi · shipping_address

AddressData

Modello completo: AddressData

null

shipping_discount_amountMoneyData Obbligatorio

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

Campi · shipping_discount_amount

Modello completo: MoneyData

amountStringaObbligatorio

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

currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli

pattern: "^[A-Z]{3}$"

minor_unitsInteroObbligatorio

Numero di cifre decimali usate dalla valuta.

minimum: 0maximum: 4

statusOrderStatusData Obbligatorio

Stato accettato da questa specifica operazione.

Campi · status

Modello completo: OrderStatusData

idStringaObbligatorio: Identificativo della risorsa; conservalo come restituito.
nameStringaObbligatorio: Nome della risorsa nel contesto pertinente.
updated_atStringaObbligatorio: Data e ora dell’aggiornamento più recente.
format: "date-time"
versionInteroObbligatorio: Versione della risorsa per il controllo della concorrenza.

subtotalMoneyData Obbligatorio

Importo prima delle componenti aggiuntive indicate nella risposta.

Campi · subtotal

Modello completo: MoneyData

amountStringaObbligatorio

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

currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli

pattern: "^[A-Z]{3}$"

minor_unitsInteroObbligatorio

Numero di cifre decimali usate dalla valuta.

minimum: 0maximum: 4

taxMoneyData Obbligatorio

Informazioni fiscali.

Campi · tax

Modello completo: MoneyData

amountStringaObbligatorio

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

currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli

pattern: "^[A-Z]{3}$"

minor_unitsInteroObbligatorio

Numero di cifre decimali usate dalla valuta.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Obbligatorio

Gruppi fiscali · source + tax_rate; unallocated_tax.

Campi · tax_breakdown

Modello completo: OrderTaxBreakdownData

groupsArray <OrderTaxGroupData > Obbligatorio: Gruppi fiscali · source + tax_rate; Sconosciuto: null; zero noto: 0.
unallocated_taxMoneyData Obbligatorio: Imposta non assegnata = order.tax − Σ groups.tax; ±.

tax_country_codeStringa nullObbligatorio

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

totalMoneyData Obbligatorio

Importo totale.

Campi · total

Modello completo: MoneyData

amountStringaObbligatorio

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

currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli

pattern: "^[A-Z]{3}$"

minor_unitsInteroObbligatorio

Numero di cifre decimali usate dalla valuta.

minimum: 0maximum: 4

totalsOrderTotalsData Obbligatorio

Totali · net / tax / gross; Prima degli sconti / Dopo gli sconti.

Campi · totals

Modello completo: OrderTotalsData

before_discountsOrderAmountBreakdownData Obbligatorio: Ordine · Prima degli sconti · net / tax / gross.
discountsOrderAmountBreakdownData Obbligatorio: Sconti
orderOrderAmountBreakdownData Obbligatorio: Ordine · Dopo gli sconti · net / tax / gross.
product_discountsOrderAmountBreakdownData Obbligatorio: Prodotti · Sconti · net / tax / gross.
productsOrderAmountBreakdownData Obbligatorio: Prodotti · Dopo gli sconti · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Obbligatorio: Prodotti · Prima degli sconti · net / tax / gross.
shippingOrderAmountBreakdownData Obbligatorio: Spedizione · Dopo gli sconti · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Obbligatorio: Spedizione · Prima degli sconti · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Obbligatorio: Spedizione · Sconti · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Campi · meta

ContextPageMeta

Modello completo: 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

Modello completo: 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

Modello completo: 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

Modello completo: 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

Catalogo degli errori · Scopri di più

GET/api/v1/orders/{order_id}

Esempi di codice

Esempio di richiesta

cURL

PHP

Python

Esempio di risposta 200

Principi

Ordine · Totali

Parametri

Parametri del percorso

Risposte

Risposta 200

Stato HTTP

GET`/api/v1/orders/{order_id}`