Schemi dei dati: Ordini

Schemi dei dati: Ordini. Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Schemi dei dati

Indirizzo di consegna

AddressData · Schema · Schemi dei dati: Ordini

address_line_1Stringa nullObbligatorio: Prima riga dell’indirizzo.
address_line_2Stringa nullObbligatorio: Informazioni aggiuntive sull’indirizzo.
cityStringa nullObbligatorio: Città o località.
country_codeStringa nullObbligatorio: Codice del paese.
first_nameStringa nullObbligatorio: Nome.
house_numberStringa nullObbligatorio: Numero civico o dell’edificio.
last_nameStringa nullObbligatorio: Cognome.
phoneStringa nullObbligatorio: Numero di telefono.
postal_codeStringa nullObbligatorio: Codice postale.
regionStringa nullObbligatorio: Regione amministrativa.
streetStringa nullObbligatorio: Nome della via.

Campi aggiuntivi: No

Elenca — Ordini — Risposta

ApiResponse_list_OrderSummaryData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataArray <OrderSummaryData > Obbligatorio: Esempio di risposta · ApiResponse_list_OrderSummaryData__.

Esempio: [{"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}}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio: Metadati della risposta.

Esempio: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campi aggiuntivi: No

Recupera — Ordini — Risposta

ApiResponse_OrderDetailData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataOrderDetailData Obbligatorio: Esempio di risposta · OrderDetailData.

Esempio: {"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}}}}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio: Metadati della risposta.

Esempio: {"request_id":"example-request"}

Campi aggiuntivi: No

Dati del cliente registrati per questa risorsa

CustomerData · Schema · Schemi dei dati: Ordini

emailStringaObbligatorio: Indirizzo email.

Esempio: "customer@example.invalid"
first_nameStringa nullObbligatorio: Nome.

Esempio: "Example"
last_nameStringa nullObbligatorio: Cognome.

Esempio: "Example"
phoneStringa nullObbligatorio: Numero di telefono.

Esempio: null

Campi aggiuntivi: No

Date di spedizione e consegna

DeliveryDatesData · 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.

dispatch_timezoneStringa nullObbligatorio: Fuso orario della spedizione (IANA; null).

Esempio: "Europe/Warsaw"
estimated_delivery_fromStringa nullObbligatorio: Inizio della consegna stimata (YYYY-MM-DD; null).

Stringa:format: "date"

Esempio: "2026-10-20"
estimated_delivery_toStringa nullObbligatorio: Fine della consegna stimata (YYYY-MM-DD; null).

Stringa:format: "date"

Esempio: "2026-10-21"
planned_dispatch_onStringa nullObbligatorio: Data di spedizione prevista (YYYY-MM-DD; null).

Stringa:format: "date"

Esempio: "2026-10-19"

Campi aggiuntivi: No

DeliveryPickupPointData

DeliveryPickupPointData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

addressPickupPointAddressData Obbligatorio

Indirizzo di consegna.

codeStringaObbligatorio

Codice stabile interpretabile dal software.

Vincoli

pattern: "^[A-Za-z0-9_-]{1,63}$"

coordinatesPickupPointCoordinatesData nullObbligatorio

Valore descritto dallo schema circostante.

country_codeStringaObbligatorio

Codice del paese.

Vincoli

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

environmentStringaObbligatorio

Informazioni sull’ambiente associate al record.

Vincoli

enum: ["live", "sandbox"]

kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["locker", "pickup_point"]

location_descriptionStringa nullObbligatorio

Descrizione nella lingua selezionata.

Stringa:maxLength: 1000

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 160

opening_hoursStringa nullObbligatorio

Opening hours

Stringa:maxLength: 500

operatorStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 63

verified_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"

Campi aggiuntivi: No

Informazioni sulla fattura

InvoiceData · Schema · Schemi dei dati: Ordini

address_line_1Stringa nullObbligatorio: Prima riga dell’indirizzo.
address_line_2Stringa nullObbligatorio: Informazioni aggiuntive sull’indirizzo.
cityStringa nullObbligatorio: Città o località.
company_nameStringa nullObbligatorio: Nome dell’azienda.
country_codeStringa nullObbligatorio: Codice del paese.
house_numberStringa nullObbligatorio: Numero civico o dell’edificio.
postal_codeStringa nullObbligatorio: Codice postale.
regionStringa nullObbligatorio: Regione amministrativa.
streetStringa nullObbligatorio: Nome della via.
tax_identifierStringa nullObbligatorio: Numero di identificazione fiscale.
tax_schemeStringa nullObbligatorio: Schema di calcolo delle imposte.

Campi aggiuntivi: No

Importo netto / Importo dell’imposta / Importo lordo

OrderAmountBreakdownData · 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.

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

Esempio: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullObbligatorio: Importo netto · Dopo gli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullObbligatorio: Importo dell’imposta · Dopo gli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"58.60","currency":"PLN","minor_units":2}

Campi aggiuntivi: No

Spedizione · Sconti

OrderDeliveryDiscountData · 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.

amountMoneyData Obbligatorio

Importo lordo · Spedizione · Sconti.

Esempio: {"amount":"24.60","currency":"PLN","minor_units":2}

campaign_idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

Esempio: "saved-coupon"

codeStringa nullObbligatorio

Codice stabile interpretabile dal software.

Esempio: "SAVE"

kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["coupon", "promotion"]

Esempio: "coupon"

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Saved coupon"

sequenceIntero nullObbligatorio

Posizione nella collezione ordinata.

Esempio: 1

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 3

Campi aggiuntivi: No

Recupera — Ordini — Risposta

OrderDetailData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

created_atStringaObbligatorio: Data e ora di creazione.

format: "date-time"

Esempio: "2026-10-19T10:00:00Z"
customerCustomerData Obbligatorio: Dati del cliente registrati per questa risorsa.

Esempio: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Obbligatorio: Metodo di consegna e informazioni associate.

Esempio: {"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_amountMoneyData Obbligatorio: Importo decimale codificato come stringa JSON; null solo dove consentito.

Esempio: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Obbligatorio: Sconti

Esempio: [{"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}]
idStringaObbligatorio: Identificativo della risorsa; conservalo come restituito. (OrderDetailData).

Esempio: "order-0000"
invoiceInvoiceData nullObbligatorio: Informazioni sulla fattura.

Esempio: null
invoice_requestedBooleanoObbligatorio: Indica se è stata richiesta una fattura.

Esempio: false
lifecycle_stateOrderLifecycleState Obbligatorio: Stato del ciclo di vita operativo.

Esempio: "placed"
linesArray <OrderLineData > Obbligatorio: Dati delle righe conservati nell’ordine.

Esempio: [{"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":[]}]
localeStringaObbligatorio: Lingua selezionata per questa richiesta.

Esempio: "pl"
market_idStringaObbligatorio: Identificativo del mercato restituito dall’endpoint del contesto.

Esempio: "market-pl"
numberStringaObbligatorio: Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "0001"
paymentPaymentData Obbligatorio: Dettagli del pagamento registrati per l’ordine.

Esempio: {"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_pointPickupPointData nullObbligatorio: Punto di ritiro

Esempio: null
prices_include_taxBooleanoObbligatorio: Indica se i prezzi elencati includono le imposte.

Esempio: true
shipping_addressAddressData nullObbligatorio: Indirizzo di consegna.

Esempio: null
shipping_discount_amountMoneyData Obbligatorio: Importo decimale codificato come stringa JSON; null solo dove consentito.

Esempio: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obbligatorio: Stato accettato da questa specifica operazione.

Esempio: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obbligatorio: Importo prima delle componenti aggiuntive indicate nella risposta.

Esempio: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obbligatorio: Informazioni fiscali.

Esempio: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Obbligatorio: Gruppi fiscali · source + tax_rate; unallocated_tax.

Esempio: {"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_codeStringa nullObbligatorio: Paese fiscale · Dati registrati dell’ordine · ISO 3166-1 alpha-2; null.

Esempio: "PL"
totalMoneyData Obbligatorio: Importo totale.

Esempio: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Obbligatorio: Totali · net / tax / gross; Prima degli sconti / Dopo gli sconti.

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

Campi aggiuntivi: No

Metadati e URL dell’immagine

OrderImageData · Schema · Schemi dei dati: Ordini

altStringa nullObbligatorio: Testo alternativo dell’immagine.
sourceStringaFacoltativo: Origine dell’attività registrata.

const: "current_catalog"

Valore predefinito: "current_catalog"
urlStringaObbligatorio: URL della risorsa.

Campi aggiuntivi: No

Stato del ciclo di vita operativo

OrderLifecycleState · Schema · Schemi dei dati: Ordini

Stringa

Vincoli

enum: ["placed", "cancelled", "fulfilled", "returned"]

Campi aggiuntivi: Sì

Dati delle righe conservati nell’ordine

OrderLineData · Schema · Schemi dei dati: Ordini

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

Esempio: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Obbligatorio: Importo lordo · Sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObbligatorio: Importo netto · Sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObbligatorio: Importo dell’imposta · Sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Obbligatorio: Sconti · net / tax / gross.

Esempio: [{"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}]
identifiersOggettoCampi aggiuntivi: StringaObbligatorio: Codici identificativi del prodotto.

Esempio: {}
imageOrderImageData nullObbligatorio: Metadati e URL dell’immagine.

Esempio: null
line_idStringaObbligatorio: Identificativo stabile della riga d’ordine.

Esempio: "saved-line-a"
manual_discountOrderManualDiscountData nullObbligatorio: Sconto manuale; null.

Esempio: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameStringaObbligatorio: Nome della risorsa nel contesto pertinente.

Esempio: "Saved A"
original_totalMoneyData Obbligatorio: Importo totale.

Esempio: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Obbligatorio: Importo lordo · Prodotti · Prima degli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullObbligatorio: Importo netto · Prodotti · Prima degli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullObbligatorio: Importo dell’imposta · Prodotti · Prima degli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"46.00","currency":"PLN","minor_units":2}
positionInteroObbligatorio: Posizione nella collezione ordinata.

Esempio: 1
product_idStringaObbligatorio: Identificativo del prodotto.

Esempio: "product-api"
quantityInteroObbligatorio: Numero di unità.

Esempio: 2
skuStringaObbligatorio: Codice di identificazione dell’articolo a magazzino.

Esempio: "A"
taxMoneyData nullObbligatorio: Importo dell’imposta · Una unità · Dati registrati dell’ordine; tax ≠ unit_tax; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idStringa nullObbligatorio: Identificativo della categoria fiscale · Dati registrati dell’ordine; null.

Esempio: "standard"
tax_category_nameStringa nullObbligatorio: Nome registrato della categoria fiscale; null.

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

Esempio: "0.23"
totalMoneyData Obbligatorio: Importo totale.

Esempio: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Obbligatorio: Importo lordo · Prodotti · Dopo gli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullObbligatorio: Importo netto · Prodotti · Dopo gli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullObbligatorio: Importo dell’imposta · Prodotti · Dopo gli sconti · Dati registrati dell’ordine; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Obbligatorio: Importo lordo · Una unità · Prima degli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullObbligatorio: Importo netto · Una unità · Prima degli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obbligatorio: Prezzo per unità.

Esempio: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullObbligatorio: Importo dell’imposta · Una unità · Prima degli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idStringa nullObbligatorio: Identificativo della variante del prodotto.

Esempio: null
variant_optionsArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Obbligatorio: Opzioni di variante associate al prodotto o ai dati storici salvati.

Esempio: []

Campi aggiuntivi: No

Sconto manuale

OrderManualDiscountData · 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.

amountMoneyData Obbligatorio

Importo lordo · Sconto manuale · Dati registrati dell’ordine.

Esempio: {"amount":"12.30","currency":"PLN","minor_units":2}

kindStringaObbligatorio

Tipo di sconto: percentage / fixed.

Vincoli

enum: ["percentage", "fixed"]

Esempio: "fixed"

valueStringaObbligatorio

Valore configurato: percentage "10" = 10%; fixed = Importo lordo.

Esempio: "12.30"

Campi aggiuntivi: No

Stato accettato da questa specifica operazione

OrderPaymentStatus · Schema · Schemi dei dati: Ordini

Stringa

Vincoli

enum: ["unpaid", "paid", "failed", "refunded"]

Campi aggiuntivi: Sì

Stato accettato da questa specifica operazione

OrderStatusData · Schema · Schemi dei dati: Ordini

idStringaObbligatorio: Identificativo della risorsa; conservalo come restituito. (OrderStatusData).

Esempio: "status-0"
nameStringaObbligatorio: Nome della risorsa nel contesto pertinente.

Esempio: "Status 0"
updated_atStringaObbligatorio: Data e ora dell’aggiornamento più recente.

format: "date-time"

Esempio: "2026-10-19T10:00:00Z"
versionInteroObbligatorio: Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Elenca · Stati — Ordini — Risposta

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

created_atStringaObbligatorio: Data e ora di creazione.

format: "date-time"

Esempio: "2026-01-01T12:00:00Z"
idStringaObbligatorio: Identificativo della risorsa; conservalo come restituito. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Esempio: "example"
is_initialBooleanoObbligatorio: Indica se è lo stato iniziale.

Esempio: false
nameStringaObbligatorio: Nome della risorsa nel contesto pertinente.

Esempio: "Example"
positionInteroObbligatorio: Posizione nella collezione ordinata.

Esempio: 1

Campi aggiuntivi: No

Elenca · Stati — Ordini — Risposta

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Obbligatorio: Esempio di risposta · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Esempio: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio: Metadati della risposta.

Esempio: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campi aggiuntivi: No

Aggiorna · Stato — Ordini — Corpo della richiesta

OrderStatusUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

expected_versionInteroObbligatorio

Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 9223372036854775807

Esempio: 1

status_idStringaObbligatorio

Identificativo ottenuto dal dizionario degli stati pertinente.

Vincoli

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

Esempio: "example"

Campi aggiuntivi: No

Elenca — Ordini — Risposta

OrderSummaryData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

created_atStringaObbligatorio: Data e ora di creazione.

format: "date-time"

Esempio: "2026-10-19T10:00:00Z"
customerCustomerData Obbligatorio: Dati del cliente registrati per questa risorsa.

Esempio: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Obbligatorio: Metodo di consegna e informazioni associate.

Esempio: {"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_amountMoneyData Obbligatorio: Importo decimale codificato come stringa JSON; null solo dove consentito.

Esempio: {"amount":"24.60","currency":"PLN","minor_units":2}
idStringaObbligatorio: Identificativo della risorsa; conservalo come restituito. (OrderSummaryData).

Esempio: "order-0000"
lifecycle_stateOrderLifecycleState Obbligatorio: Stato del ciclo di vita operativo.

Esempio: "placed"
localeStringaObbligatorio: Lingua selezionata per questa richiesta.

Esempio: "pl"
market_idStringaObbligatorio: Identificativo del mercato restituito dall’endpoint del contesto.

Esempio: "market-pl"
numberStringaObbligatorio: Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "0001"
paymentPaymentData Obbligatorio: Dettagli del pagamento registrati per l’ordine.

Esempio: {"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_taxBooleanoObbligatorio: Indica se i prezzi elencati includono le imposte.

Esempio: true
shipping_discount_amountMoneyData Obbligatorio: Importo decimale codificato come stringa JSON; null solo dove consentito.

Esempio: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obbligatorio: Stato accettato da questa specifica operazione.

Esempio: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obbligatorio: Importo prima delle componenti aggiuntive indicate nella risposta.

Esempio: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obbligatorio: Informazioni fiscali.

Esempio: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeStringa nullObbligatorio: Paese fiscale · Dati registrati dell’ordine · ISO 3166-1 alpha-2; null.

Esempio: "PL"
totalMoneyData Obbligatorio: Importo totale.

Esempio: {"amount":"329.40","currency":"PLN","minor_units":2}

Campi aggiuntivi: No

Ordine · Gruppi fiscali

OrderTaxBreakdownData · 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.

groupsArray <OrderTaxGroupData > Obbligatorio: Gruppi fiscali · source + tax_rate; Sconosciuto: null; zero noto: 0.

Esempio: [{"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_taxMoneyData Obbligatorio: Imposta non assegnata = order.tax − Σ groups.tax; ±.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2}

Campi aggiuntivi: No

Gruppi fiscali

OrderTaxGroupData · 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.

grossMoneyData Obbligatorio

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

Esempio: {"amount":"221.40","currency":"PLN","minor_units":2}

netMoneyData nullObbligatorio

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

Esempio: {"amount":"180.00","currency":"PLN","minor_units":2}

sourceStringaObbligatorio

Origine: products (Prodotti), shipping (Spedizione).

Vincoli

enum: ["products", "shipping"]

Esempio: "products"

taxMoneyData nullObbligatorio

Importo dell’imposta · Dopo gli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"41.40","currency":"PLN","minor_units":2}

tax_rateStringa nullObbligatorio

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

Esempio: "0.23"

Campi aggiuntivi: No

Ordine · Totali

OrderTotalsData · 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.

before_discountsOrderAmountBreakdownData Obbligatorio: Ordine · Prima degli sconti · net / tax / gross.

Esempio: {"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}}
discountsOrderAmountBreakdownData Obbligatorio: Sconti · net / tax / gross.

Esempio: {"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}}
orderOrderAmountBreakdownData Obbligatorio: Ordine · Dopo gli sconti · net / tax / gross.

Esempio: {"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_discountsOrderAmountBreakdownData Obbligatorio: Prodotti · Sconti · net / tax / gross.

Esempio: {"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}}
productsOrderAmountBreakdownData Obbligatorio: Prodotti · Dopo gli sconti · net / tax / gross.

Esempio: {"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_discountsOrderAmountBreakdownData Obbligatorio: Prodotti · Prima degli sconti · net / tax / gross.

Esempio: {"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}}
shippingOrderAmountBreakdownData Obbligatorio: Spedizione · Dopo gli sconti · net / tax / gross.

Esempio: {"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_discountsOrderAmountBreakdownData Obbligatorio: Spedizione · Prima degli sconti · net / tax / gross.

Esempio: {"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_discountsOrderAmountBreakdownData Obbligatorio: Spedizione · Sconti · net / tax / gross.

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

Campi aggiuntivi: No

Opzioni di variante associate al prodotto o ai dati storici salvati

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Schema · Schemi dei dati: Ordini

nameStringaObbligatorio: Nome della risorsa nel contesto pertinente.
valueStringaObbligatorio: Valore descritto dallo schema circostante.

Campi aggiuntivi: No

OrderDiscountData

OrderDiscountData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

amountMoneyData Obbligatorio

Importo lordo · Prodotti · Sconti.

Esempio: {"amount":"12.30","currency":"PLN","minor_units":2}

campaign_idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

Esempio: "saved-coupon"

codeStringa nullObbligatorio

Codice stabile interpretabile dal software.

Esempio: "SAVE"

kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["coupon", "promotion"]

Esempio: "coupon"

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Saved coupon"

sequenceIntero nullFacoltativo

Ordine di applicazione; null.

Esempio: 1

shipping_amountMoneyData nullFacoltativo

Importo lordo · Spedizione · Sconti; null.

Esempio: {"amount":"24.60","currency":"PLN","minor_units":2}

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 3

Campi aggiuntivi: No

Dettagli del pagamento registrati per l’ordine

PaymentData · Schema · Schemi dei dati: Ordini

amountMoneyData Obbligatorio

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

Esempio: {"amount":"329.40","currency":"PLN","minor_units":2}

environmentStringaObbligatorio

Informazioni sull’ambiente associate al record.

Vincoli

enum: ["live", "sandbox"]

Esempio: "live"

method_codeStringa nullObbligatorio

Codice del metodo di consegna o pagamento.

Esempio: "payment-old"

method_nameStringa nullObbligatorio

Nome del metodo di consegna o pagamento.

Esempio: "Historic method"

paid_atStringa nullObbligatorio

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

Stringa:format: "date-time"

Esempio: null

statusOrderPaymentStatus Obbligatorio

Stato accettato da questa specifica operazione.

Esempio: "unpaid"

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"

Esempio: "2026-10-19T10:00:00Z"

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 0

Campi aggiuntivi: No

Aggiorna · Stato del pagamento — Ordini — Corpo della richiesta

PaymentStatusUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

expected_versionInteroObbligatorio: Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 0maximum: 9223372036854775807

Esempio: 1
reasonStringaObbligatorio: Motivo registrato per la modifica.

minLength: 1maxLength: 500

Esempio: "Example"
statusPaymentStatus Obbligatorio: Stato accettato da questa specifica operazione.

Esempio: "paid"

Campi aggiuntivi: No

Stato accettato da questa specifica operazione

PaymentStatus · Schema · Schemi dei dati: Ordini

Stringa

Vincoli

enum: ["unpaid", "paid", "failed", "refunded"]

Campi aggiuntivi: Sì

PickupPointAddressData

PickupPointAddressData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

address_line_1StringaObbligatorio: Prima riga dell’indirizzo.

minLength: 1maxLength: 240
cityStringaObbligatorio: Città o località.

minLength: 1maxLength: 160
postal_codeStringaObbligatorio: Codice postale.

minLength: 1maxLength: 32

Campi aggiuntivi: No

PickupPointCoordinatesData

PickupPointCoordinatesData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

latitudeNumeroObbligatorio: WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeNumeroObbligatorio: WGS84 λ (°)

minimum: -180.0maximum: 180.0

Campi aggiuntivi: No

PickupPointData

PickupPointData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

address_line1StringaObbligatorio

Prima riga dell’indirizzo.

cityStringaObbligatorio

Città o località.

codeStringaObbligatorio

Codice stabile interpretabile dal software.

country_codeStringaObbligatorio

Codice del paese.

kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["locker", "pickup_point"]

latitudeNumero nullObbligatorio

WGS84 φ (°)

location_descriptionStringa nullObbligatorio

Descrizione nella lingua selezionata.

longitudeNumero nullObbligatorio

WGS84 λ (°)

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

opening_hoursStringa nullObbligatorio

Opening hours

operatorStringaObbligatorio

Nome della risorsa nel contesto pertinente.

postal_codeStringaObbligatorio

Codice postale.

Campi aggiuntivi: No

PickupPointSummaryData

PickupPointSummaryData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

codeStringaObbligatorio

Codice stabile interpretabile dal software.

Vincoli

pattern: "^[A-Za-z0-9_-]{1,63}$"

country_codeStringaObbligatorio

Codice del paese.

Vincoli

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

environmentStringaObbligatorio

Informazioni sull’ambiente associate al record.

Vincoli

enum: ["live", "sandbox"]

kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["locker", "pickup_point"]

operatorStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 63

Campi aggiuntivi: No

Dati del cliente registrati per questa risorsa

RequestCustomerData · Schema · Schemi dei dati: Ordini

emailStringaObbligatorio: Indirizzo email.

Esempio: "customer@example.invalid"
nameStringaObbligatorio: Nome della risorsa nel contesto pertinente.

Esempio: "Example"

Campi aggiuntivi: No

Metodo di consegna e informazioni associate

ShippingData · Schema · Schemi dei dati: Ordini

amountMoneyData Obbligatorio

Importo lordo della spedizione registrato nell’ordine come MoneyData. Le successive modifiche fiscali non cambiano questo importo storico.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2}

datesDeliveryDatesData Obbligatorio

Date di spedizione e consegna. 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.

Esempio:

{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

method_codeStringa nullObbligatorio

Codice del metodo di consegna o pagamento.

Esempio: "shipping-old"

method_nameStringa nullObbligatorio

Nome del metodo di consegna o pagamento.

Esempio: "Historic carrier"

pickup_pointPickupPointSummaryData nullObbligatorio

Punto di ritiro

Esempio: null

recipient_modeStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["full_address", "pickup_contact"]

Esempio: "full_address"

Campi aggiuntivi: No

ShippingDetailData

ShippingDetailData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

amountMoneyData Obbligatorio

Importo lordo della spedizione registrato nell’ordine come MoneyData. Le successive modifiche fiscali non cambiano questo importo storico.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2}

datesDeliveryDatesData Obbligatorio

Esempio:

{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

discount_grossMoneyData Obbligatorio

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

Esempio: {"amount":"24.60","currency":"PLN","minor_units":2}

discount_netMoneyData nullObbligatorio

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

Esempio: {"amount":"20.00","currency":"PLN","minor_units":2}

discount_taxMoneyData nullObbligatorio

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

Esempio: {"amount":"4.60","currency":"PLN","minor_units":2}

discountsArray <OrderDeliveryDiscountData > nullObbligatorio

Spedizione · Sconti; []: 0; null: Sconosciuto: null; zero noto: 0.

Esempio:

[{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}]

grossMoneyData Obbligatorio

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

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2}

method_codeStringa nullObbligatorio

Codice del metodo di consegna o pagamento.

Esempio: "shipping-old"

method_nameStringa nullObbligatorio

Nome del metodo di consegna o pagamento.

Esempio: "Historic carrier"

netMoneyData nullObbligatorio

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

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2}

original_grossMoneyData Obbligatorio

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

Esempio: {"amount":"24.60","currency":"PLN","minor_units":2}

original_netMoneyData nullObbligatorio

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

Esempio: {"amount":"20.00","currency":"PLN","minor_units":2}

original_taxMoneyData nullObbligatorio

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

Esempio: {"amount":"4.60","currency":"PLN","minor_units":2}

pickup_pointDeliveryPickupPointData nullObbligatorio

Punto di ritiro

Esempio: null

recipient_modeStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["full_address", "pickup_contact"]

Esempio: "full_address"

taxMoneyData nullObbligatorio

Importo dell’imposta · Dopo gli sconti; Sconosciuto: null; zero noto: 0.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2}

tax_category_idStringa nullObbligatorio

Identificativo della categoria fiscale · Dati registrati dell’ordine; null.

Esempio: "standard"

tax_category_nameStringa nullObbligatorio

Nome registrato della categoria fiscale; null.

Esempio: "VAT 23%"

tax_rateStringa nullObbligatorio

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

Esempio: "0.23"

Campi aggiuntivi: No