Scheme de date
Adresa de livrare
AddressData · Schemă · Scheme de date: Comenzi
address_line_1Șir de caractere nullObligatoriuPrima linie a adresei.
address_line_2Șir de caractere nullObligatoriuInformații suplimentare despre adresă.
cityȘir de caractere nullObligatoriuOrașul sau localitatea.
country_codeȘir de caractere nullObligatoriuCodul țării.
first_nameȘir de caractere nullObligatoriuPrenumele.
house_numberȘir de caractere nullObligatoriuNumărul clădirii sau al casei.
last_nameȘir de caractere nullObligatoriuNumele de familie.
phoneȘir de caractere nullObligatoriuNumărul de telefon.
postal_codeȘir de caractere nullObligatoriuCodul poștal.
regionȘir de caractere nullObligatoriuRegiunea administrativă.
streetȘir de caractere nullObligatoriuNumele străzii.
Câmpuri suplimentare: Nu
Listează — Comenzi — Răspuns
ApiResponse_list_OrderSummaryData__ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
dataTablou <OrderSummaryData> ObligatoriuExemplu de răspuns · ApiResponse_list_OrderSummaryData__.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatoriuMetadatele răspunsului.
Câmpuri suplimentare: Nu
Obține — Comenzi — Răspuns
ApiResponse_OrderDetailData_ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
dataOrderDetailDataObligatoriuExemplu de răspuns · OrderDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatoriuMetadatele răspunsului.
Câmpuri suplimentare: Nu
Datele clientului înregistrate pentru această resursă
CustomerData · Schemă · Scheme de date: Comenzi
emailȘir de caractereObligatoriuAdresa de e-mail.
first_nameȘir de caractere nullObligatoriuPrenumele.
last_nameȘir de caractere nullObligatoriuNumele de familie.
phoneȘir de caractere nullObligatoriuNumărul de telefon.
Câmpuri suplimentare: Nu
Date de expediere și livrare
DeliveryDatesData · Lista și detaliile comenzilor includ delivery.dates. Datele YYYY-MM-DD sunt planificate și nu confirmă expedierea. Datele curente au prioritate; comenzile vechi folosesc estimarea salvată. Valorile șterse sau necunoscute sunt null. Detaliile includ și toate pozițiile și imaginile produselor.
dispatch_timezoneȘir de caractere nullObligatoriuFusul orar al expedierii (IANA; null).
estimated_delivery_fromȘir de caractere nullObligatoriuÎnceputul livrării estimate (YYYY-MM-DD; null).
Șir de caractere:format:"date"estimated_delivery_toȘir de caractere nullObligatoriuSfârșitul livrării estimate (YYYY-MM-DD; null).
Șir de caractere:format:"date"planned_dispatch_onȘir de caractere nullObligatoriuData planificată a expedierii (YYYY-MM-DD; null).
Șir de caractere:format:"date"
Câmpuri suplimentare: Nu
DeliveryPickupPointData
DeliveryPickupPointData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
addressPickupPointAddressDataObligatoriuAdresa de livrare.
codeȘir de caractereObligatoriuCod stabil, destinat prelucrării automate.
Restricții
pattern"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesDatanullObligatoriuValoarea descrisă de schema în care apare.
country_codeȘir de caractereObligatoriuCodul țării.
Restricții
pattern"^[A-Z]{2}$"
environmentȘir de caractereObligatoriuInformații despre mediu asociate înregistrării.
Restricții
enum["live", "sandbox"]
kindȘir de caractereObligatoriuVarianta structurii de date, descrisă prin valorile permise.
Restricții
enum["locker", "pickup_point"]
location_descriptionȘir de caractere nullObligatoriuDescriere în limba selectată.
Șir de caractere:maxLength:1000nameȘir de caractereObligatoriuNumele resursei în contextul relevant.
minLength:1maxLength:160opening_hoursȘir de caractere nullObligatoriuOpening hours
Șir de caractere:maxLength:500operatorȘir de caractereObligatoriuNumele resursei în contextul relevant.
minLength:1maxLength:63verified_atȘir de caractereObligatoriuMomentul celei mai recente actualizări.
format:"date-time"
Câmpuri suplimentare: Nu
Informații despre factură
InvoiceData · Schemă · Scheme de date: Comenzi
address_line_1Șir de caractere nullObligatoriuPrima linie a adresei.
address_line_2Șir de caractere nullObligatoriuInformații suplimentare despre adresă.
cityȘir de caractere nullObligatoriuOrașul sau localitatea.
company_nameȘir de caractere nullObligatoriuDenumirea companiei.
country_codeȘir de caractere nullObligatoriuCodul țării.
house_numberȘir de caractere nullObligatoriuNumărul clădirii sau al casei.
postal_codeȘir de caractere nullObligatoriuCodul poștal.
regionȘir de caractere nullObligatoriuRegiunea administrativă.
streetȘir de caractere nullObligatoriuNumele străzii.
tax_identifierȘir de caractere nullObligatoriuNumărul de identificare fiscală.
tax_schemeȘir de caractere nullObligatoriuSchema de calcul al taxelor.
Câmpuri suplimentare: Nu
Sumă netă / Valoarea taxei / Sumă brută
OrderAmountBreakdownData · Sumele și cotele provin din comanda salvată, inclusiv corecturile pozițiilor. Datele istorice lipsă sunt null și nu sunt înlocuite cu taxele actuale din catalog. Sumele rămân șiruri zecimale.
grossMoneyDataObligatoriuSumă brută · După reduceri; Necunoscut: null; zero cunoscut: 0.
netMoneyDatanullObligatoriuSumă netă · După reduceri; Necunoscut: null; zero cunoscut: 0.
taxMoneyDatanullObligatoriuValoarea taxei · După reduceri; Necunoscut: null; zero cunoscut: 0.
Câmpuri suplimentare: Nu
Livrare · Reduceri
OrderDeliveryDiscountData · Sumele și cotele provin din comanda salvată, inclusiv corecturile pozițiilor. Datele istorice lipsă sunt null și nu sunt înlocuite cu taxele actuale din catalog. Sumele rămân șiruri zecimale.
amountMoneyDataObligatoriuSumă brută · Livrare · Reduceri.
campaign_idȘir de caractereObligatoriuIdentificatorul resursei; păstrați-l în forma returnată.
codeȘir de caractere nullObligatoriuCod stabil, destinat prelucrării automate.
kindȘir de caractereObligatoriuVarianta structurii de date, descrisă prin valorile permise.
Restricții
enum["coupon", "promotion"]
nameȘir de caractereObligatoriuNumele resursei în contextul relevant.
sequenceNumăr întreg nullObligatoriuPoziția în colecția ordonată.
versionNumăr întregObligatoriuVersiunea resursei folosită pentru controlul concurenței.
Câmpuri suplimentare: Nu
Obține — Comenzi — Răspuns
OrderDetailData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
created_atȘir de caractereObligatoriuMomentul creării.
format:"date-time"customerCustomerDataObligatoriuDatele clientului înregistrate pentru această resursă.
deliveryShippingDetailDataObligatoriuMetoda de livrare și informațiile asociate.
discount_amountMoneyDataObligatoriuSumă zecimală codificată ca șir JSON; null numai unde este permis.
discountsTablou <OrderDiscountData> ObligatoriuReduceri
idȘir de caractereObligatoriuIdentificatorul resursei; păstrați-l în forma returnată. (OrderDetailData).
invoiceInvoiceDatanullObligatoriuInformații despre factură.
invoice_requestedValoare booleanăObligatoriuIndică dacă a fost solicitată o factură.
lifecycle_stateOrderLifecycleStateObligatoriuStarea din ciclul de viață comercial.
linesTablou <OrderLineData> ObligatoriuDatele pozițiilor comenzii păstrate la înregistrarea acesteia.
localeȘir de caractereObligatoriuLimba selectată pentru această cerere.
market_idȘir de caractereObligatoriuIdentificatorul pieței returnat de endpointul de context.
numberȘir de caractereObligatoriuNumărul comenzii sau al solicitării, destinat utilizatorilor.
paymentPaymentDataObligatoriuDetaliile de plată înregistrate pentru comandă.
pickup_pointPickupPointDatanullObligatoriuPunct de ridicare
prices_include_taxValoare booleanăObligatoriuIndică dacă prețurile afișate includ taxele.
shipping_addressAddressDatanullObligatoriuAdresa de livrare.
shipping_discount_amountMoneyDataObligatoriuSumă zecimală codificată ca șir JSON; null numai unde este permis.
statusOrderStatusDataObligatoriuStarea acceptată de această operație specifică.
subtotalMoneyDataObligatoriuSuma înainte de componentele suplimentare prezentate în răspuns.
taxMoneyDataObligatoriuInformații despre taxe.
tax_breakdownOrderTaxBreakdownDataObligatoriuGrupuri fiscale · source + tax_rate; unallocated_tax.
tax_country_codeȘir de caractere nullObligatoriuȚară fiscală · Datele salvate ale comenzii · ISO 3166-1 alpha-2; null.
totalMoneyDataObligatoriuSuma totală.
totalsOrderTotalsDataObligatoriuTotaluri · net / tax / gross; Înainte de reduceri / După reduceri.
Câmpuri suplimentare: Nu
Metadatele și URL-ul imaginii
OrderImageData · Schemă · Scheme de date: Comenzi
altȘir de caractere nullObligatoriuText alternativ pentru o imagine.
sourceȘir de caractereOpționalSursa activității înregistrate.
const:"current_catalog"urlȘir de caractereObligatoriuURL-ul resursei.
Câmpuri suplimentare: Nu
Starea din ciclul de viață comercial
OrderLifecycleState · Schemă · Scheme de date: Comenzi
Șir de caractereRestricții
enum["placed", "cancelled", "fulfilled", "returned"]
Câmpuri suplimentare: Da
Datele pozițiilor comenzii păstrate la înregistrarea acesteia
OrderLineData · Schemă · Scheme de date: Comenzi
discount_amountMoneyDataObligatoriuSumă zecimală codificată ca șir JSON; null numai unde este permis.
discount_grossMoneyDataObligatoriuSumă brută · Reduceri; Necunoscut: null; zero cunoscut: 0.
discount_netMoneyDatanullObligatoriuSumă netă · Reduceri; Necunoscut: null; zero cunoscut: 0.
discount_taxMoneyDatanullObligatoriuValoarea taxei · Reduceri; Necunoscut: null; zero cunoscut: 0.
discountsTablou <OrderDiscountData> ObligatoriuReduceri · net / tax / gross.
identifiersObiectCâmpuri suplimentare: Șir de caractereObligatoriuCodurile de identificare ale produsului.
imageOrderImageDatanullObligatoriuMetadatele și URL-ul imaginii.
line_idȘir de caractereObligatoriuIdentificator stabil al poziției comenzii.
manual_discountOrderManualDiscountDatanullObligatoriuReducere manuală; null.
nameȘir de caractereObligatoriuNumele resursei în contextul relevant.
original_totalMoneyDataObligatoriuSuma totală.
original_total_grossMoneyDataObligatoriuSumă brută · Produse · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.
original_total_netMoneyDatanullObligatoriuSumă netă · Produse · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.
original_total_taxMoneyDatanullObligatoriuValoarea taxei · Produse · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.
positionNumăr întregObligatoriuPoziția în colecția ordonată.
product_idȘir de caractereObligatoriuIdentificatorul produsului.
quantityNumăr întregObligatoriuNumărul de unități.
skuȘir de caractereObligatoriuCodul unității de stoc.
taxMoneyDatanullObligatoriuValoarea taxei · O unitate · Datele salvate ale comenzii; tax ≠ unit_tax; Necunoscut: null; zero cunoscut: 0.
tax_category_idȘir de caractere nullObligatoriuIdentificatorul categoriei fiscale · Datele salvate ale comenzii; null.
tax_category_nameȘir de caractere nullObligatoriuNumele salvat al categoriei fiscale; null.
tax_rateȘir de caractere nullObligatoriutax_rate · Datele salvate ale comenzii: "0.23" = 23%; "0" ≠ null.
totalMoneyDataObligatoriuSuma totală.
total_grossMoneyDataObligatoriuSumă brută · Produse · După reduceri; Necunoscut: null; zero cunoscut: 0.
total_netMoneyDatanullObligatoriuSumă netă · Produse · După reduceri; Necunoscut: null; zero cunoscut: 0.
total_taxMoneyDatanullObligatoriuValoarea taxei · Produse · După reduceri · Datele salvate ale comenzii; Necunoscut: null; zero cunoscut: 0.
unit_grossMoneyDataObligatoriuSumă brută · O unitate · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.
unit_netMoneyDatanullObligatoriuSumă netă · O unitate · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.
unit_priceMoneyDataObligatoriuPrețul pentru o unitate.
unit_taxMoneyDatanullObligatoriuValoarea taxei · O unitate · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.
variant_idȘir de caractere nullObligatoriuIdentificatorul variantei de produs.
variant_optionsTablou <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData> ObligatoriuOpțiunile de variantă asociate produsului sau datelor sale păstrate.
Câmpuri suplimentare: Nu
Reducere manuală
OrderManualDiscountData · Sumele și cotele provin din comanda salvată, inclusiv corecturile pozițiilor. Datele istorice lipsă sunt null și nu sunt înlocuite cu taxele actuale din catalog. Sumele rămân șiruri zecimale.
amountMoneyDataObligatoriuSumă brută · Reducere manuală · Datele salvate ale comenzii.
kindȘir de caractereObligatoriuTipul reducerii: percentage / fixed.
Restricții
enum["percentage", "fixed"]
valueȘir de caractereObligatoriuValoare configurată: percentage "10" = 10%; fixed = Sumă brută.
Câmpuri suplimentare: Nu
Starea acceptată de această operație specifică
OrderPaymentStatus · Schemă · Scheme de date: Comenzi
Șir de caractereRestricții
enum["unpaid", "paid", "failed", "refunded"]
Câmpuri suplimentare: Da
Starea acceptată de această operație specifică
OrderStatusData · Schemă · Scheme de date: Comenzi
idȘir de caractereObligatoriuIdentificatorul resursei; păstrați-l în forma returnată. (OrderStatusData).
nameȘir de caractereObligatoriuNumele resursei în contextul relevant.
updated_atȘir de caractereObligatoriuMomentul celei mai recente actualizări.
format:"date-time"versionNumăr întregObligatoriuVersiunea resursei folosită pentru controlul concurenței.
Câmpuri suplimentare: Nu
Listează · Stări — Comenzi — Răspuns
shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
created_atȘir de caractereObligatoriuMomentul creării.
format:"date-time"idȘir de caractereObligatoriuIdentificatorul resursei; păstrați-l în forma returnată. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).
is_initialValoare booleanăObligatoriuIndică dacă aceasta este starea inițială.
nameȘir de caractereObligatoriuNumele resursei în contextul relevant.
positionNumăr întregObligatoriuPoziția în colecția ordonată.
Câmpuri suplimentare: Nu
Listează · Stări — Comenzi — Răspuns
shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
dataTablou <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData> ObligatoriuExemplu de răspuns · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatoriuMetadatele răspunsului.
Câmpuri suplimentare: Nu
Actualizează · Stare — Comenzi — Corpul cererii
OrderStatusUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
expected_versionNumăr întregObligatoriuVersiunea citită înainte de scriere; o neconcordanță respinge actualizarea.
minimum:1maximum:9223372036854775807status_idȘir de caractereObligatoriuIdentificator obținut din dicționarul de stări corespunzător.
Restricții
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Câmpuri suplimentare: Nu
Listează — Comenzi — Răspuns
OrderSummaryData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
created_atȘir de caractereObligatoriuMomentul creării.
format:"date-time"customerCustomerDataObligatoriuDatele clientului înregistrate pentru această resursă.
deliveryShippingDataObligatoriuMetoda de livrare și informațiile asociate.
discount_amountMoneyDataObligatoriuSumă zecimală codificată ca șir JSON; null numai unde este permis.
idȘir de caractereObligatoriuIdentificatorul resursei; păstrați-l în forma returnată. (OrderSummaryData).
lifecycle_stateOrderLifecycleStateObligatoriuStarea din ciclul de viață comercial.
localeȘir de caractereObligatoriuLimba selectată pentru această cerere.
market_idȘir de caractereObligatoriuIdentificatorul pieței returnat de endpointul de context.
numberȘir de caractereObligatoriuNumărul comenzii sau al solicitării, destinat utilizatorilor.
paymentPaymentDataObligatoriuDetaliile de plată înregistrate pentru comandă.
prices_include_taxValoare booleanăObligatoriuIndică dacă prețurile afișate includ taxele.
shipping_discount_amountMoneyDataObligatoriuSumă zecimală codificată ca șir JSON; null numai unde este permis.
statusOrderStatusDataObligatoriuStarea acceptată de această operație specifică.
subtotalMoneyDataObligatoriuSuma înainte de componentele suplimentare prezentate în răspuns.
taxMoneyDataObligatoriuInformații despre taxe.
tax_country_codeȘir de caractere nullObligatoriuȚară fiscală · Datele salvate ale comenzii · ISO 3166-1 alpha-2; null.
totalMoneyDataObligatoriuSuma totală.
Câmpuri suplimentare: Nu
Comandă · Grupuri fiscale
OrderTaxBreakdownData · Sumele și cotele provin din comanda salvată, inclusiv corecturile pozițiilor. Datele istorice lipsă sunt null și nu sunt înlocuite cu taxele actuale din catalog. Sumele rămân șiruri zecimale.
groupsTablou <OrderTaxGroupData> ObligatoriuGrupuri fiscale · source + tax_rate; Necunoscut: null; zero cunoscut: 0.
unallocated_taxMoneyDataObligatoriuTaxă nealocată = order.tax − Σ groups.tax; ±.
Câmpuri suplimentare: Nu
Grupuri fiscale
OrderTaxGroupData · Sumele și cotele provin din comanda salvată, inclusiv corecturile pozițiilor. Datele istorice lipsă sunt null și nu sunt înlocuite cu taxele actuale din catalog. Sumele rămân șiruri zecimale.
grossMoneyDataObligatoriuSumă brută · După reduceri; Necunoscut: null; zero cunoscut: 0.
netMoneyDatanullObligatoriuSumă netă · După reduceri; Necunoscut: null; zero cunoscut: 0.
sourceȘir de caractereObligatoriuSursă: products (Produse), shipping (Livrare).
Restricții
enum["products", "shipping"]
taxMoneyDatanullObligatoriuValoarea taxei · După reduceri; Necunoscut: null; zero cunoscut: 0.
tax_rateȘir de caractere nullObligatoriutax_rate · Datele salvate ale comenzii: "0.23" = 23%; "0" ≠ null.
Câmpuri suplimentare: Nu
Comandă · Totaluri
OrderTotalsData · Sumele și cotele provin din comanda salvată, inclusiv corecturile pozițiilor. Datele istorice lipsă sunt null și nu sunt înlocuite cu taxele actuale din catalog. Sumele rămân șiruri zecimale.
before_discountsOrderAmountBreakdownDataObligatoriuComandă · Înainte de reduceri · net / tax / gross.
discountsOrderAmountBreakdownDataObligatoriuReduceri · net / tax / gross.
orderOrderAmountBreakdownDataObligatoriuComandă · După reduceri · net / tax / gross.
product_discountsOrderAmountBreakdownDataObligatoriuProduse · Reduceri · net / tax / gross.
productsOrderAmountBreakdownDataObligatoriuProduse · După reduceri · net / tax / gross.
products_before_discountsOrderAmountBreakdownDataObligatoriuProduse · Înainte de reduceri · net / tax / gross.
shippingOrderAmountBreakdownDataObligatoriuLivrare · După reduceri · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownDataObligatoriuLivrare · Înainte de reduceri · net / tax / gross.
shipping_discountsOrderAmountBreakdownDataObligatoriuLivrare · Reduceri · net / tax / gross.
Câmpuri suplimentare: Nu
Opțiunile de variantă asociate produsului sau datelor sale păstrate
shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Schemă · Scheme de date: Comenzi
nameȘir de caractereObligatoriuNumele resursei în contextul relevant.
valueȘir de caractereObligatoriuValoarea descrisă de schema în care apare.
Câmpuri suplimentare: Nu
OrderDiscountData
OrderDiscountData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
amountMoneyDataObligatoriuSumă brută · Produse · Reduceri.
campaign_idȘir de caractereObligatoriuIdentificatorul resursei; păstrați-l în forma returnată.
codeȘir de caractere nullObligatoriuCod stabil, destinat prelucrării automate.
kindȘir de caractereObligatoriuVarianta structurii de date, descrisă prin valorile permise.
Restricții
enum["coupon", "promotion"]
nameȘir de caractereObligatoriuNumele resursei în contextul relevant.
sequenceNumăr întreg nullOpționalOrdinea aplicării; null.
shipping_amountMoneyDatanullOpționalSumă brută · Livrare · Reduceri; null.
versionNumăr întregObligatoriuVersiunea resursei folosită pentru controlul concurenței.
Câmpuri suplimentare: Nu
Detaliile de plată înregistrate pentru comandă
PaymentData · Schemă · Scheme de date: Comenzi
amountMoneyDataObligatoriupayment.amount este totalul comenzii. Starea plății nu determină sumele plătite, rambursate sau restante.
environmentȘir de caractereObligatoriuInformații despre mediu asociate înregistrării.
Restricții
enum["live", "sandbox"]
method_codeȘir de caractere nullObligatoriuCodul metodei de livrare sau de plată.
method_nameȘir de caractere nullObligatoriuNumele metodei de livrare sau de plată.
paid_atȘir de caractere nullObligatoriuData și ora la care plata a fost marcată ca efectuată.
Șir de caractere:format:"date-time"statusOrderPaymentStatusObligatoriuStarea acceptată de această operație specifică.
updated_atȘir de caractereObligatoriuMomentul celei mai recente actualizări.
format:"date-time"versionNumăr întregObligatoriuVersiunea resursei folosită pentru controlul concurenței.
Câmpuri suplimentare: Nu
Actualizează · Starea plății — Comenzi — Corpul cererii
PaymentStatusUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
expected_versionNumăr întregObligatoriuVersiunea citită înainte de scriere; o neconcordanță respinge actualizarea.
minimum:0maximum:9223372036854775807reasonȘir de caractereObligatoriuMotivul înregistrat pentru modificare.
minLength:1maxLength:500statusPaymentStatusObligatoriuStarea acceptată de această operație specifică.
Câmpuri suplimentare: Nu
Starea acceptată de această operație specifică
PaymentStatus · Schemă · Scheme de date: Comenzi
Șir de caractereRestricții
enum["unpaid", "paid", "failed", "refunded"]
Câmpuri suplimentare: Da
PickupPointAddressData
PickupPointAddressData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
address_line_1Șir de caractereObligatoriuPrima linie a adresei.
minLength:1maxLength:240cityȘir de caractereObligatoriuOrașul sau localitatea.
minLength:1maxLength:160postal_codeȘir de caractereObligatoriuCodul poștal.
minLength:1maxLength:32
Câmpuri suplimentare: Nu
PickupPointCoordinatesData
PickupPointCoordinatesData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
latitudeNumărObligatoriuWGS84 φ (°)
minimum:-90.0maximum:90.0longitudeNumărObligatoriuWGS84 λ (°)
minimum:-180.0maximum:180.0
Câmpuri suplimentare: Nu
PickupPointData
PickupPointData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
address_line1Șir de caractereObligatoriuPrima linie a adresei.
cityȘir de caractereObligatoriuOrașul sau localitatea.
codeȘir de caractereObligatoriuCod stabil, destinat prelucrării automate.
country_codeȘir de caractereObligatoriuCodul țării.
kindȘir de caractereObligatoriuVarianta structurii de date, descrisă prin valorile permise.
Restricții
enum["locker", "pickup_point"]
latitudeNumăr nullObligatoriuWGS84 φ (°)
location_descriptionȘir de caractere nullObligatoriuDescriere în limba selectată.
longitudeNumăr nullObligatoriuWGS84 λ (°)
nameȘir de caractereObligatoriuNumele resursei în contextul relevant.
opening_hoursȘir de caractere nullObligatoriuOpening hours
operatorȘir de caractereObligatoriuNumele resursei în contextul relevant.
postal_codeȘir de caractereObligatoriuCodul poștal.
Câmpuri suplimentare: Nu
PickupPointSummaryData
PickupPointSummaryData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
codeȘir de caractereObligatoriuCod stabil, destinat prelucrării automate.
Restricții
pattern"^[A-Za-z0-9_-]{1,63}$"
country_codeȘir de caractereObligatoriuCodul țării.
Restricții
pattern"^[A-Z]{2}$"
environmentȘir de caractereObligatoriuInformații despre mediu asociate înregistrării.
Restricții
enum["live", "sandbox"]
kindȘir de caractereObligatoriuVarianta structurii de date, descrisă prin valorile permise.
Restricții
enum["locker", "pickup_point"]
operatorȘir de caractereObligatoriuNumele resursei în contextul relevant.
minLength:1maxLength:63
Câmpuri suplimentare: Nu
Datele clientului înregistrate pentru această resursă
RequestCustomerData · Schemă · Scheme de date: Comenzi
emailȘir de caractereObligatoriuAdresa de e-mail.
nameȘir de caractereObligatoriuNumele resursei în contextul relevant.
Câmpuri suplimentare: Nu
Metoda de livrare și informațiile asociate
ShippingData · Schemă · Scheme de date: Comenzi
amountMoneyDataObligatoriuSuma brută a livrării înregistrată în comandă ca MoneyData. Modificările fiscale ulterioare nu schimbă această sumă istorică.
datesDeliveryDatesDataObligatoriuDate de expediere și livrare. Lista și detaliile comenzilor includ delivery.dates. Datele YYYY-MM-DD sunt planificate și nu confirmă expedierea. Datele curente au prioritate; comenzile vechi folosesc estimarea salvată. Valorile șterse sau necunoscute sunt null. Detaliile includ și toate pozițiile și imaginile produselor.
method_codeȘir de caractere nullObligatoriuCodul metodei de livrare sau de plată.
method_nameȘir de caractere nullObligatoriuNumele metodei de livrare sau de plată.
pickup_pointPickupPointSummaryDatanullObligatoriuPunct de ridicare
recipient_modeȘir de caractereObligatoriuVarianta structurii de date, descrisă prin valorile permise.
Restricții
enum["full_address", "pickup_contact"]
Câmpuri suplimentare: Nu
ShippingDetailData
ShippingDetailData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
amountMoneyDataObligatoriuSuma brută a livrării înregistrată în comandă ca MoneyData. Modificările fiscale ulterioare nu schimbă această sumă istorică.
datesDeliveryDatesDataObligatoriuDate de expediere și livrare. Lista și detaliile comenzilor includ delivery.dates. Datele YYYY-MM-DD sunt planificate și nu confirmă expedierea. Datele curente au prioritate; comenzile vechi folosesc estimarea salvată. Valorile șterse sau necunoscute sunt null. Detaliile includ și toate pozițiile și imaginile produselor.
discount_grossMoneyDataObligatoriuSumă brută · Reduceri; Necunoscut: null; zero cunoscut: 0.
discount_netMoneyDatanullObligatoriuSumă netă · Reduceri; Necunoscut: null; zero cunoscut: 0.
discount_taxMoneyDatanullObligatoriuValoarea taxei · Reduceri; Necunoscut: null; zero cunoscut: 0.
discountsTablou <OrderDeliveryDiscountData> nullObligatoriuLivrare · Reduceri; []: 0; null: Necunoscut: null; zero cunoscut: 0.
grossMoneyDataObligatoriuSumă brută · După reduceri; Necunoscut: null; zero cunoscut: 0.
method_codeȘir de caractere nullObligatoriuCodul metodei de livrare sau de plată.
method_nameȘir de caractere nullObligatoriuNumele metodei de livrare sau de plată.
netMoneyDatanullObligatoriuSumă netă · După reduceri; Necunoscut: null; zero cunoscut: 0.
original_grossMoneyDataObligatoriuSumă brută · Livrare · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.
original_netMoneyDatanullObligatoriuSumă netă · Livrare · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.
original_taxMoneyDatanullObligatoriuValoarea taxei · Livrare · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.
pickup_pointDeliveryPickupPointDatanullObligatoriuPunct de ridicare
recipient_modeȘir de caractereObligatoriuVarianta structurii de date, descrisă prin valorile permise.
Restricții
enum["full_address", "pickup_contact"]
taxMoneyDatanullObligatoriuValoarea taxei · După reduceri; Necunoscut: null; zero cunoscut: 0.
tax_category_idȘir de caractere nullObligatoriuIdentificatorul categoriei fiscale · Datele salvate ale comenzii; null.
tax_category_nameȘir de caractere nullObligatoriuNumele salvat al categoriei fiscale; null.
tax_rateȘir de caractere nullObligatoriutax_rate · Datele salvate ale comenzii: "0.23" = 23%; "0" ≠ null.
Câmpuri suplimentare: Nu