Treci la conținut
ShopentlyLearn
Română

Scheme de date: Comenzi

Scheme de date: Comenzi. Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

Scheme de date

Adresa de livrare

AddressData · Schemă · Scheme de date: Comenzi
address_line_1Șir de caractere nullObligatoriu

Prima linie a adresei.

address_line_2Șir de caractere nullObligatoriu

Informații suplimentare despre adresă.

cityȘir de caractere nullObligatoriu

Orașul sau localitatea.

country_codeȘir de caractere nullObligatoriu

Codul țării.

first_nameȘir de caractere nullObligatoriu

Prenumele.

house_numberȘir de caractere nullObligatoriu

Numărul clădirii sau al casei.

last_nameȘir de caractere nullObligatoriu

Numele de familie.

phoneȘir de caractere nullObligatoriu

Numărul de telefon.

postal_codeȘir de caractere nullObligatoriu

Codul poștal.

regionȘir de caractere nullObligatoriu

Regiunea administrativă.

streetȘir de caractere nullObligatoriu

Numele străzii.

Câmpuri suplimentare: Nu

ApiResponse_OrderFileListData_

ApiResponse_OrderFileListData_ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API. Trimite fișierele ca multipart/form-data după crearea upload_id, apoi asociază-le produsului. Descărcarea necesită un token Bearer și permisiunea pentru category; răspunsul conține octeții fișierului, fără adresă publică sau parolă. Pentru mode=period alege days (1–3650) sau vechiul months, niciodată ambele. Condițiile se păstrează la cumpărare; rambursarea retrage accesul doar pentru poziția rambursată.
dataOrderFileListData Obligatoriu

Datele unui răspuns reușit.

Exemplu: {"files":[{"can_download":true,"category":"digital","filename":"manual.pdf","id":"example","label":"Manual","line_id":"example","mime_type":"application/pdf","product_id":"example","purchase_id":"00000000-0000-4000-8000-000000000001","reason":"paid","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"source_file_id":"00000000-0000-4000-8000-000000000001","source_version_id":"00000000-0000-4000-8000-000000000001","source_version_number":1,"state":"active"}],"updates_pending":false}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriu

Metadatele răspunsului.

Exemplu: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Câmpuri suplimentare: Nu

ApiResponse_OrderReleaseListData_

ApiResponse_OrderReleaseListData_ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API. Trimite fișierele ca multipart/form-data după crearea upload_id, apoi asociază-le produsului. Descărcarea necesită un token Bearer și permisiunea pentru category; răspunsul conține octeții fișierului, fără adresă publică sau parolă. Pentru mode=period alege days (1–3650) sau vechiul months, niciodată ambele. Condițiile se păstrează la cumpărare; rambursarea retrage accesul doar pentru poziția rambursată.
dataOrderReleaseListData Obligatoriu

Datele unui răspuns reușit.

Exemplu: {"releases":[{"access_reason":"paid","access_state":"active","current_release":null,"grant_reason":"purchase","granted_at":"2026-01-01T12:00:00Z","id":"example","line_id":"example","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","product_id":"example","published_at":"2026-01-01T12:00:00Z","purchase_id":"00000000-0000-4000-8000-000000000001","release_id":"00000000-0000-4000-8000-000000000001","release_sequence":1,"update_days":365,"update_mode":"period","update_months":null,"updates_until":"2027-01-01T12:00:00Z","version_label":"1.0"}],"updates_pending":false}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriu

Metadatele răspunsului.

Exemplu: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

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 > Obligatoriu

Exemplu de răspuns · ApiResponse_list_OrderSummaryData__.

Exemplu: [{"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 Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

Obține — Comenzi — Răspuns

ApiResponse_OrderDetailData_ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
dataOrderDetailData Obligatoriu

Exemplu de răspuns · OrderDetailData.

Exemplu: {"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 Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

CurrentReleaseData

CurrentReleaseData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API. Trimite fișierele ca multipart/form-data după crearea upload_id, apoi asociază-le produsului. Descărcarea necesită un token Bearer și permisiunea pentru category; răspunsul conține octeții fișierului, fără adresă publică sau parolă. Pentru mode=period alege days (1–3650) sau vechiul months, niciodată ambele. Condițiile se păstrează la cumpărare; rambursarea retrage accesul doar pentru poziția rambursată.
acquiredValoare booleanăObligatoriu

Acces după cumpărare (true / false)

changelogȘir de caractereObligatoriu

Descrierea modificărilor

covered_by_purchaseValoare booleanăObligatoriu

Acces după cumpărare (true / false)

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

published_atȘir de caractereObligatoriu

Publică ediția · UTC

format: "date-time"
requires_new_purchaseValoare booleanăObligatoriu

Fără acces la fișiere adăugate după cumpărare · requires_new_purchase

sequenceNumăr întregObligatoriu

Poziția în colecția ordonată.

version_labelȘir de caractereObligatoriu

Versiune

Câmpuri suplimentare: Nu

Datele clientului înregistrate pentru această resursă

CustomerData · Schemă · Scheme de date: Comenzi
emailȘir de caractereObligatoriu

Adresa de e-mail.

Exemplu: "customer@example.invalid"
first_nameȘir de caractere nullObligatoriu

Prenumele.

Exemplu: "Example"
last_nameȘir de caractere nullObligatoriu

Numele de familie.

Exemplu: "Example"
phoneȘir de caractere nullObligatoriu

Numărul de telefon.

Exemplu: null

Câmpuri suplimentare: Nu

DeliveryContentDeletion

DeliveryContentDeletion · Șterge definitiv conținutul și păstrează istoricul. Codul nu revine în stocul de vânzare.
expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1
Exemplu: 1
reasonȘir de caractereObligatoriu

Motivul înregistrat pentru modificare.

minLength: 1maxLength: 500
Exemplu: "Withdraw a revoked license"

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 nullObligatoriu

Fusul orar al expedierii (IANA; null).

Exemplu: "Europe/Warsaw"
estimated_delivery_fromȘir de caractere nullObligatoriu

Începutul livrării estimate (YYYY-MM-DD; null).

Șir de caractere:format: "date"
Exemplu: "2026-10-20"
estimated_delivery_toȘir de caractere nullObligatoriu

Sfârșitul livrării estimate (YYYY-MM-DD; null).

Șir de caractere:format: "date"
Exemplu: "2026-10-21"
planned_dispatch_onȘir de caractere nullObligatoriu

Data planificată a expedierii (YYYY-MM-DD; null).

Șir de caractere:format: "date"
Exemplu: "2026-10-19"

Câmpuri suplimentare: Nu

DeliveryReplacement

DeliveryReplacement · Alege o unitate liberă existentă. Înlocuirea nu reîncepe perioada de păstrare.
expected_unit_versionNumăr întregObligatoriu

Versiunea curentă a unității libere de înlocuire.

minimum: 1
Exemplu: 1
expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1
Exemplu: 1
reasonȘir de caractereObligatoriu

Motivul înregistrat pentru modificare.

minLength: 1maxLength: 500
Exemplu: "Replace an invalid activation code"
replacement_unit_idȘir de caractereObligatoriu

ID-ul unei unități libere existente pentru înlocuire.

format: "uuid"
Exemplu: "00000000-0000-4000-8000-000000000008"

Câmpuri suplimentare: Nu

DeliveryPickupPointData

DeliveryPickupPointData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
addressPickupPointAddressData Obligatoriu

Adresa de livrare.

codeȘir de caractereObligatoriu

Cod stabil, destinat prelucrării automate.

Restricții
pattern
"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesData nullObligatoriu

Valoarea descrisă de schema în care apare.

country_codeȘir de caractereObligatoriu

Codul țării.

Restricții
pattern
"^[A-Z]{2}$"
environmentȘir de caractereObligatoriu

Informații despre mediu asociate înregistrării.

Restricții
enum
["live", "sandbox"]
kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții
enum
["locker", "pickup_point"]
location_descriptionȘir de caractere nullObligatoriu

Descriere în limba selectată.

Șir de caractere:maxLength: 1000
nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

minLength: 1maxLength: 160
opening_hoursȘir de caractere nullObligatoriu

Opening hours

Șir de caractere:maxLength: 500
operatorȘir de caractereObligatoriu

Numele resursei în contextul relevant.

minLength: 1maxLength: 63
verified_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

Câmpuri suplimentare: Nu

ApiResponse[list[DeliveryData]]

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · Consultă unitățile atribuite fără coduri. Rambursarea retrage accesul doar pentru pozițiile afectate.
dataTablou <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > Obligatoriu

Datele unui răspuns reușit.

Exemplu: [{"can_download":true,"content_state":"present","delete_due_at":null,"filename":null,"first_available_at":"2026-11-03T12:00:00Z","generation":1,"id":"00000000-0000-4000-8000-000000000005","kind":"code","line_id":"line-example","order_id":"order-example","payload_id":"00000000-0000-4000-8000-000000000012","product_id":"example","reason":"","size_bytes":null,"state":"available","unit_id":"00000000-0000-4000-8000-000000000011","unit_ordinal":1,"variant_id":null,"version":2}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriu

Metadatele răspunsului.

Exemplu: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Câmpuri suplimentare: Nu

DeliveryData

shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · Consultă unitățile atribuite fără coduri. Rambursarea retrage accesul doar pentru pozițiile afectate.
can_downloadValoare booleanăObligatoriu

Descarcă (true / false)

Exemplu: true
content_stateȘir de caractereObligatoriu

Starea conținutului: present / deleting / deleted.

Exemplu: "present"
delete_due_atȘir de caractere nullObligatoriu

Ștergerea programată a fișierului; null o dezactivează.

Șir de caractere:format: "date-time"
Exemplu: null
filenameȘir de caractere nullObligatoriu

Fișier

Exemplu: null
first_available_atȘir de caractere nullObligatoriu

Primul acces al achiziției; înlocuirea nu reîncepe termenul.

Șir de caractere:format: "date-time"
Exemplu: "2026-11-03T12:00:00Z"
generationNumăr întregObligatoriu

Generația atribuirii; crește la înlocuire.

Exemplu: 1
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

format: "uuid"
Exemplu: "00000000-0000-4000-8000-000000000005"
kindȘir de caractere nullObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Exemplu: "code"
line_idȘir de caractereObligatoriu

Identificator stabil al poziției comenzii.

Exemplu: "line-example"
order_idȘir de caractereObligatoriu

Identificatorul comenzii asociate.

Exemplu: "order-example"
payload_idȘir de caractereObligatoriu

ID-ul conținutului; nu este un URL public de descărcare.

format: "uuid"
Exemplu: "00000000-0000-4000-8000-000000000012"
product_idȘir de caractereObligatoriu

Identificatorul produsului.

Exemplu: "example"
reasonȘir de caractereObligatoriu

Motivul înregistrat pentru modificare.

Exemplu: ""
size_bytesNumăr întreg nullObligatoriu

Dimensiune în octeți

Exemplu: null
stateȘir de caractereObligatoriu

Stare

Exemplu: "available"
unit_idȘir de caractereObligatoriu

ID-ul unui cod sau fișier individual.

format: "uuid"
Exemplu: "00000000-0000-4000-8000-000000000011"
unit_ordinalNumăr întregObligatoriu

Numărul unității cumpărate în linia comenzii.

Exemplu: 1
variant_idȘir de caractere nullObligatoriu

Identificatorul variantei de produs.

Exemplu: null
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 2

Câmpuri suplimentare: Nu

Informații despre factură

InvoiceData · Schemă · Scheme de date: Comenzi
address_line_1Șir de caractere nullObligatoriu

Prima linie a adresei.

address_line_2Șir de caractere nullObligatoriu

Informații suplimentare despre adresă.

cityȘir de caractere nullObligatoriu

Orașul sau localitatea.

company_nameȘir de caractere nullObligatoriu

Denumirea companiei.

country_codeȘir de caractere nullObligatoriu

Codul țării.

house_numberȘir de caractere nullObligatoriu

Numărul clădirii sau al casei.

postal_codeȘir de caractere nullObligatoriu

Codul poștal.

regionȘir de caractere nullObligatoriu

Regiunea administrativă.

streetȘir de caractere nullObligatoriu

Numele străzii.

tax_identifierȘir de caractere nullObligatoriu

Numărul de identificare fiscală.

tax_schemeȘir de caractere nullObligatoriu

Schema 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.
grossMoneyData Obligatoriu

Sumă brută · După reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullObligatoriu

Sumă netă · După reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullObligatoriu

Valoarea taxei · După reduceri; Necunoscut: null; zero cunoscut: 0.

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

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.
amountMoneyData Obligatoriu

Sumă brută · Livrare · Reduceri.

Exemplu: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

Exemplu: "saved-coupon"
codeȘir de caractere nullObligatoriu

Cod stabil, destinat prelucrării automate.

Exemplu: "SAVE"
kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții
enum
["coupon", "promotion"]
Exemplu: "coupon"
nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Saved coupon"
sequenceNumăr întreg nullObligatoriu

Poziția în colecția ordonată.

Exemplu: 1
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 3

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 caractereObligatoriu

Momentul creării.

format: "date-time"
Exemplu: "2026-10-19T10:00:00Z"
customerCustomerData Obligatoriu

Datele clientului înregistrate pentru această resursă.

Exemplu: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Obligatoriu

Metoda de livrare și informațiile asociate.

Exemplu: {"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 Obligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

Exemplu: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsTablou <OrderDiscountData > Obligatoriu

Reduceri

Exemplu: [{"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Șir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (OrderDetailData).

Exemplu: "order-0000"
invoiceInvoiceData nullObligatoriu

Informații despre factură.

Exemplu: null
invoice_requestedValoare booleanăObligatoriu

Indică dacă a fost solicitată o factură.

Exemplu: false
lifecycle_stateOrderLifecycleState Obligatoriu

Starea din ciclul de viață comercial.

Exemplu: "placed"
linesTablou <OrderLineData > Obligatoriu

Datele pozițiilor comenzii păstrate la înregistrarea acesteia.

Exemplu: [{"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Șir de caractereObligatoriu

Limba selectată pentru această cerere.

Exemplu: "pl"
market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

Exemplu: "market-pl"
numberȘir de caractereObligatoriu

Numărul comenzii sau al solicitării, destinat utilizatorilor.

Exemplu: "0001"
paymentPaymentData Obligatoriu

Detaliile de plată înregistrate pentru comandă.

Exemplu: {"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 nullObligatoriu

Punct de ridicare

Exemplu: null
prices_include_taxValoare booleanăObligatoriu

Indică dacă prețurile afișate includ taxele.

Exemplu: true
shipping_addressAddressData nullObligatoriu

Adresa de livrare.

Exemplu: null
shipping_discount_amountMoneyData Obligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

Exemplu: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligatoriu

Starea acceptată de această operație specifică.

Exemplu: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obligatoriu

Suma înainte de componentele suplimentare prezentate în răspuns.

Exemplu: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligatoriu

Informații despre taxe.

Exemplu: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Obligatoriu

Grupuri fiscale · source + tax_rate; unallocated_tax.

Exemplu: {"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Șir de caractere nullObligatoriu

Țară fiscală · Datele salvate ale comenzii · ISO 3166-1 alpha-2; null.

Exemplu: "PL"
totalMoneyData Obligatoriu

Suma totală.

Exemplu: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Obligatoriu

Totaluri · net / tax / gross; Înainte de reduceri / După reduceri.

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

Câmpuri suplimentare: Nu

OrderFileData

OrderFileData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API. Trimite fișierele ca multipart/form-data după crearea upload_id, apoi asociază-le produsului. Descărcarea necesită un token Bearer și permisiunea pentru category; răspunsul conține octeții fișierului, fără adresă publică sau parolă. Pentru mode=period alege days (1–3650) sau vechiul months, niciodată ambele. Condițiile se păstrează la cumpărare; rambursarea retrage accesul doar pentru poziția rambursată.
can_downloadValoare booleanăObligatoriu

Descarcă (true / false)

Exemplu: true
categoryFileCategory Obligatoriu

Categoria fișierului: internal / customer_document / digital

Exemplu: "digital"
filenameȘir de caractereObligatoriu

Fișier

Exemplu: "manual.pdf"
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

Exemplu: "example"
labelȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Manual"
line_idȘir de caractereObligatoriu

Identificator stabil al poziției comenzii.

Exemplu: "example"
mime_typeȘir de caractereObligatoriu

Tipul conținutului media.

Exemplu: "application/pdf"
product_idȘir de caractereObligatoriu

Identificatorul produsului.

Exemplu: "example"
purchase_idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. · purchase_id

Exemplu: "00000000-0000-4000-8000-000000000001"
reasonȘir de caractereObligatoriu

Motivul înregistrat pentru modificare.

Exemplu: "paid"
sha256Șir de caractereObligatoriu

SHA-256 (hex, 64)

Exemplu: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesNumăr întregObligatoriu

Dimensiune în octeți

minimum: 1maximum: 262144000
Exemplu: 46
source_file_idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. · source_file_id

Exemplu: "00000000-0000-4000-8000-000000000001"
source_version_idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. · source_version_id

Exemplu: "00000000-0000-4000-8000-000000000001"
source_version_numberNumăr întregObligatoriu

Versiune

minimum: 1
Exemplu: 1
stateȘir de caractereObligatoriu

Stare

Exemplu: "active"

Câmpuri suplimentare: Nu

OrderFileListData

OrderFileListData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API. Trimite fișierele ca multipart/form-data după crearea upload_id, apoi asociază-le produsului. Descărcarea necesită un token Bearer și permisiunea pentru category; răspunsul conține octeții fișierului, fără adresă publică sau parolă. Pentru mode=period alege days (1–3650) sau vechiul months, niciodată ambele. Condițiile se păstrează la cumpărare; rambursarea retrage accesul doar pentru poziția rambursată.
filesTablou <OrderFileData > Obligatoriu

Fișierele produsului

Exemplu: [{"can_download":true,"category":"digital","filename":"manual.pdf","id":"example","label":"Manual","line_id":"example","mime_type":"application/pdf","product_id":"example","purchase_id":"00000000-0000-4000-8000-000000000001","reason":"paid","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"source_file_id":"00000000-0000-4000-8000-000000000001","source_version_id":"00000000-0000-4000-8000-000000000001","source_version_number":1,"state":"active"}]
updates_pendingValoare booleanăObligatoriu

Acces la fișiere viitoare după cumpărare · updates_pending

Exemplu: false

Câmpuri suplimentare: Nu

Metadatele și URL-ul imaginii

OrderImageData · Schemă · Scheme de date: Comenzi
altȘir de caractere nullObligatoriu

Text alternativ pentru o imagine.

sourceȘir de caractereOpțional

Sursa activității înregistrate.

const: "current_catalog"
Valoare implicită: "current_catalog"
urlȘir de caractereObligatoriu

URL-ul resursei.

Câmpuri suplimentare: Nu

Starea din ciclul de viață comercial

OrderLifecycleState · Schemă · Scheme de date: Comenzi Șir de caractere
Restricț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_amountMoneyData Obligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

Exemplu: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Obligatoriu

Sumă brută · Reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObligatoriu

Sumă netă · Reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObligatoriu

Valoarea taxei · Reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsTablou <OrderDiscountData > Obligatoriu

Reduceri · net / tax / gross.

Exemplu: [{"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}]
identifiersObiectCâmpuri suplimentare: Șir de caractereObligatoriu

Codurile de identificare ale produsului.

Exemplu: {}
imageOrderImageData nullObligatoriu

Metadatele și URL-ul imaginii.

Exemplu: null
line_idȘir de caractereObligatoriu

Identificator stabil al poziției comenzii.

Exemplu: "saved-line-a"
manual_discountOrderManualDiscountData nullObligatoriu

Reducere manuală; null.

Exemplu: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Saved A"
original_totalMoneyData Obligatoriu

Suma totală.

Exemplu: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Obligatoriu

Sumă brută · Produse · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullObligatoriu

Sumă netă · Produse · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullObligatoriu

Valoarea taxei · Produse · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"46.00","currency":"PLN","minor_units":2}
positionNumăr întregObligatoriu

Poziția în colecția ordonată.

Exemplu: 1
product_idȘir de caractereObligatoriu

Identificatorul produsului.

Exemplu: "product-api"
quantityNumăr întregObligatoriu

Numărul de unități.

Exemplu: 2
skuȘir de caractereObligatoriu

Codul unității de stoc.

Exemplu: "A"
taxMoneyData nullObligatoriu

Valoarea taxei · O unitate · Datele salvate ale comenzii; tax ≠ unit_tax; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idȘir de caractere nullObligatoriu

Identificatorul categoriei fiscale · Datele salvate ale comenzii; null.

Exemplu: "standard"
tax_category_nameȘir de caractere nullObligatoriu

Numele salvat al categoriei fiscale; null.

Exemplu: "VAT 23%"
tax_rateȘir de caractere nullObligatoriu

tax_rate · Datele salvate ale comenzii: "0.23" = 23%; "0" ≠ null.

Exemplu: "0.23"
totalMoneyData Obligatoriu

Suma totală.

Exemplu: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Obligatoriu

Sumă brută · Produse · După reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullObligatoriu

Sumă netă · Produse · După reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullObligatoriu

Valoarea taxei · Produse · După reduceri · Datele salvate ale comenzii; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Obligatoriu

Sumă brută · O unitate · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullObligatoriu

Sumă netă · O unitate · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obligatoriu

Prețul pentru o unitate.

Exemplu: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullObligatoriu

Valoarea taxei · O unitate · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idȘir de caractere nullObligatoriu

Identificatorul variantei de produs.

Exemplu: null
variant_optionsTablou <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Obligatoriu

Opțiunile de variantă asociate produsului sau datelor sale păstrate.

Exemplu: []

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.
amountMoneyData Obligatoriu

Sumă brută · Reducere manuală · Datele salvate ale comenzii.

Exemplu: {"amount":"12.30","currency":"PLN","minor_units":2}
kindȘir de caractereObligatoriu

Tipul reducerii: percentage / fixed.

Restricții
enum
["percentage", "fixed"]
Exemplu: "fixed"
valueȘir de caractereObligatoriu

Valoare configurată: percentage "10" = 10%; fixed = Sumă brută.

Exemplu: "12.30"

Câmpuri suplimentare: Nu

Starea acceptată de această operație specifică

OrderPaymentStatus · Schemă · Scheme de date: Comenzi Șir de caractere
Restricții
enum
["unpaid", "paid", "failed", "refunded"]

Câmpuri suplimentare: Da

OrderReleaseData

OrderReleaseData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API. Trimite fișierele ca multipart/form-data după crearea upload_id, apoi asociază-le produsului. Descărcarea necesită un token Bearer și permisiunea pentru category; răspunsul conține octeții fișierului, fără adresă publică sau parolă. Pentru mode=period alege days (1–3650) sau vechiul months, niciodată ambele. Condițiile se păstrează la cumpărare; rambursarea retrage accesul doar pentru poziția rambursată.
access_reasonȘir de caractereObligatoriu

Acces după cumpărare · Motivul înregistrat pentru modificare.

Exemplu: "paid"
access_stateȘir de caractereObligatoriu

Acces după cumpărare · Stare

Exemplu: "active"
current_releaseCurrentReleaseData nullObligatoriu

Ediții digitale · current_release

Exemplu: null
grant_reasonȘir de caractereObligatoriu

Acces după cumpărare · Motivul înregistrat pentru modificare.

Exemplu: "purchase"
granted_atȘir de caractereObligatoriu

Acces după cumpărare · UTC

format: "date-time"
Exemplu: "2026-01-01T12:00:00Z"
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

Exemplu: "example"
line_idȘir de caractereObligatoriu

Identificator stabil al poziției comenzii.

Exemplu: "example"
manifest_sha256Șir de caractereObligatoriu

Ediții digitale · SHA-256

Exemplu: "1111111111111111111111111111111111111111111111111111111111111111"
product_idȘir de caractereObligatoriu

Identificatorul produsului.

Exemplu: "example"
published_atȘir de caractereObligatoriu

Publică ediția · UTC

format: "date-time"
Exemplu: "2026-01-01T12:00:00Z"
purchase_idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. · purchase_id

Exemplu: "00000000-0000-4000-8000-000000000001"
release_idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. · release_id

Exemplu: "00000000-0000-4000-8000-000000000001"
release_sequenceNumăr întregObligatoriu

Ediții digitale · Poziția în colecția ordonată.

Exemplu: 1
update_daysNumăr întreg nullObligatoriu

Număr de zile (days; null)

Exemplu: 365
update_modeȘir de caractereObligatoriu

Acces la fișiere viitoare după cumpărare: none / period / unlimited

Exemplu: "period"
update_monthsNumăr întreg nullObligatoriu

Luni (months; null)

Exemplu: null
updates_untilȘir de caractere nullObligatoriu

Acces la fișiere viitoare după cumpărare · UTC

Șir de caractere:format: "date-time"
Exemplu: "2027-01-01T12:00:00Z"
version_labelȘir de caractereObligatoriu

Versiune

Exemplu: "1.0"

Câmpuri suplimentare: Nu

OrderReleaseListData

OrderReleaseListData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API. Trimite fișierele ca multipart/form-data după crearea upload_id, apoi asociază-le produsului. Descărcarea necesită un token Bearer și permisiunea pentru category; răspunsul conține octeții fișierului, fără adresă publică sau parolă. Pentru mode=period alege days (1–3650) sau vechiul months, niciodată ambele. Condițiile se păstrează la cumpărare; rambursarea retrage accesul doar pentru poziția rambursată.
releasesTablou <OrderReleaseData > Obligatoriu

Ediții digitale

Exemplu: [{"access_reason":"paid","access_state":"active","current_release":null,"grant_reason":"purchase","granted_at":"2026-01-01T12:00:00Z","id":"example","line_id":"example","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","product_id":"example","published_at":"2026-01-01T12:00:00Z","purchase_id":"00000000-0000-4000-8000-000000000001","release_id":"00000000-0000-4000-8000-000000000001","release_sequence":1,"update_days":365,"update_mode":"period","update_months":null,"updates_until":"2027-01-01T12:00:00Z","version_label":"1.0"}]
updates_pendingValoare booleanăObligatoriu

Acces la fișiere viitoare după cumpărare · updates_pending

Exemplu: false

Câmpuri suplimentare: Nu

Starea acceptată de această operație specifică

OrderStatusData · Schemă · Scheme de date: Comenzi
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (OrderStatusData).

Exemplu: "status-0"
nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Status 0"
updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
Exemplu: "2026-10-19T10:00:00Z"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

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 caractereObligatoriu

Momentul creării.

format: "date-time"
Exemplu: "2026-01-01T12:00:00Z"
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Exemplu: "status-0"
is_initialValoare booleanăObligatoriu

Indică dacă aceasta este starea inițială.

Exemplu: true
nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "New"
positionNumăr întregObligatoriu

Poziția în colecția ordonată.

Exemplu: 0

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 > Obligatoriu

Exemplu de răspuns · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Exemplu: [{"created_at":"2026-01-01T12:00:00Z","id":"status-0","is_initial":true,"name":"New","position":0},{"created_at":"2026-01-01T12:00:00Z","id":"status-1","is_initial":false,"name":"Processing","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriu

Metadatele răspunsului.

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

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 întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807
Exemplu: 1
status_idȘir de caractereObligatoriu

Identificator obținut din dicționarul de stări corespunzător.

Restricții
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exemplu: "status-1"

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 caractereObligatoriu

Momentul creării.

format: "date-time"
Exemplu: "2026-10-19T10:00:00Z"
customerCustomerData Obligatoriu

Datele clientului înregistrate pentru această resursă.

Exemplu: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Obligatoriu

Metoda de livrare și informațiile asociate.

Exemplu: {"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 Obligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

Exemplu: {"amount":"24.60","currency":"PLN","minor_units":2}
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (OrderSummaryData).

Exemplu: "order-0000"
lifecycle_stateOrderLifecycleState Obligatoriu

Starea din ciclul de viață comercial.

Exemplu: "placed"
localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

Exemplu: "pl"
market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

Exemplu: "market-pl"
numberȘir de caractereObligatoriu

Numărul comenzii sau al solicitării, destinat utilizatorilor.

Exemplu: "0001"
paymentPaymentData Obligatoriu

Detaliile de plată înregistrate pentru comandă.

Exemplu: {"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_taxValoare booleanăObligatoriu

Indică dacă prețurile afișate includ taxele.

Exemplu: true
shipping_discount_amountMoneyData Obligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

Exemplu: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligatoriu

Starea acceptată de această operație specifică.

Exemplu: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obligatoriu

Suma înainte de componentele suplimentare prezentate în răspuns.

Exemplu: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligatoriu

Informații despre taxe.

Exemplu: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeȘir de caractere nullObligatoriu

Țară fiscală · Datele salvate ale comenzii · ISO 3166-1 alpha-2; null.

Exemplu: "PL"
totalMoneyData Obligatoriu

Suma totală.

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

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 > Obligatoriu

Grupuri fiscale · source + tax_rate; Necunoscut: null; zero cunoscut: 0.

Exemplu: [{"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 Obligatoriu

Taxă nealocată = order.tax − Σ groups.tax; ±.

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

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.
grossMoneyData Obligatoriu

Sumă brută · După reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullObligatoriu

Sumă netă · După reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceȘir de caractereObligatoriu

Sursă: products (Produse), shipping (Livrare).

Restricții
enum
["products", "shipping"]
Exemplu: "products"
taxMoneyData nullObligatoriu

Valoarea taxei · După reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateȘir de caractere nullObligatoriu

tax_rate · Datele salvate ale comenzii: "0.23" = 23%; "0" ≠ null.

Exemplu: "0.23"

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_discountsOrderAmountBreakdownData Obligatoriu

Comandă · Înainte de reduceri · net / tax / gross.

Exemplu: {"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 Obligatoriu

Reduceri · net / tax / gross.

Exemplu: {"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 Obligatoriu

Comandă · După reduceri · net / tax / gross.

Exemplu: {"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 Obligatoriu

Produse · Reduceri · net / tax / gross.

Exemplu: {"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 Obligatoriu

Produse · După reduceri · net / tax / gross.

Exemplu: {"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 Obligatoriu

Produse · Înainte de reduceri · net / tax / gross.

Exemplu: {"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 Obligatoriu

Livrare · După reduceri · net / tax / gross.

Exemplu: {"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 Obligatoriu

Livrare · Înainte de reduceri · net / tax / gross.

Exemplu: {"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 Obligatoriu

Livrare · Reduceri · net / tax / gross.

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

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 caractereObligatoriu

Numele resursei în contextul relevant.

valueȘir de caractereObligatoriu

Valoarea descrisă de schema în care apare.

Câmpuri suplimentare: Nu

OrderDiscountData

OrderDiscountData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
amountMoneyData Obligatoriu

Sumă brută · Produse · Reduceri.

Exemplu: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

Exemplu: "saved-coupon"
codeȘir de caractere nullObligatoriu

Cod stabil, destinat prelucrării automate.

Exemplu: "SAVE"
kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții
enum
["coupon", "promotion"]
Exemplu: "coupon"
nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Saved coupon"
sequenceNumăr întreg nullOpțional

Ordinea aplicării; null.

Exemplu: 1
shipping_amountMoneyData nullOpțional

Sumă brută · Livrare · Reduceri; null.

Exemplu: {"amount":"24.60","currency":"PLN","minor_units":2}
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 3

Câmpuri suplimentare: Nu

Detaliile de plată înregistrate pentru comandă

PaymentData · Schemă · Scheme de date: Comenzi
amountMoneyData Obligatoriu

payment.amount este totalul comenzii. Starea plății nu determină sumele plătite, rambursate sau restante.

Exemplu: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentȘir de caractereObligatoriu

Informații despre mediu asociate înregistrării.

Restricții
enum
["live", "sandbox"]
Exemplu: "live"
method_codeȘir de caractere nullObligatoriu

Codul metodei de livrare sau de plată.

Exemplu: "payment-old"
method_nameȘir de caractere nullObligatoriu

Numele metodei de livrare sau de plată.

Exemplu: "Historic method"
paid_atȘir de caractere nullObligatoriu

Data și ora la care plata a fost marcată ca efectuată.

Șir de caractere:format: "date-time"
Exemplu: null
statusOrderPaymentStatus Obligatoriu

Starea acceptată de această operație specifică.

Exemplu: "unpaid"
updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
Exemplu: "2026-10-19T10:00:00Z"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 0

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 întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 0maximum: 9223372036854775807
Exemplu: 0
reasonȘir de caractereObligatoriu

Motivul înregistrat pentru modificare.

minLength: 1maxLength: 500
Exemplu: "Bank transfer confirmed"
statusPaymentStatus Obligatoriu

Starea acceptată de această operație specifică. unpaid: neplătit; paid: plătit; failed: plată eșuată; refunded: rambursat.

Exemplu: "paid"

Câmpuri suplimentare: Nu

Starea acceptată de această operație specifică

PaymentStatus · Schemă · Scheme de date: Comenzi Șir de caractere
Restricț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 caractereObligatoriu

Prima linie a adresei.

minLength: 1maxLength: 240
cityȘir de caractereObligatoriu

Orașul sau localitatea.

minLength: 1maxLength: 160
postal_codeȘir de caractereObligatoriu

Codul poștal.

minLength: 1maxLength: 32

Câmpuri suplimentare: Nu

PickupPointCoordinatesData

PickupPointCoordinatesData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
latitudeNumărObligatoriu

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeNumărObligatoriu

WGS84 λ (°)

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 caractereObligatoriu

Prima linie a adresei.

cityȘir de caractereObligatoriu

Orașul sau localitatea.

codeȘir de caractereObligatoriu

Cod stabil, destinat prelucrării automate.

country_codeȘir de caractereObligatoriu

Codul țării.

kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții
enum
["locker", "pickup_point"]
latitudeNumăr nullObligatoriu

WGS84 φ (°)

location_descriptionȘir de caractere nullObligatoriu

Descriere în limba selectată.

longitudeNumăr nullObligatoriu

WGS84 λ (°)

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

opening_hoursȘir de caractere nullObligatoriu

Opening hours

operatorȘir de caractereObligatoriu

Numele resursei în contextul relevant.

postal_codeȘir de caractereObligatoriu

Codul poștal.

Câmpuri suplimentare: Nu

PickupPointSummaryData

PickupPointSummaryData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
codeȘir de caractereObligatoriu

Cod stabil, destinat prelucrării automate.

Restricții
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeȘir de caractereObligatoriu

Codul țării.

Restricții
pattern
"^[A-Z]{2}$"
environmentȘir de caractereObligatoriu

Informații despre mediu asociate înregistrării.

Restricții
enum
["live", "sandbox"]
kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții
enum
["locker", "pickup_point"]
operatorȘir de caractereObligatoriu

Numele 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 caractereObligatoriu

Adresa de e-mail.

Exemplu: "customer@example.invalid"
nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Example"

Câmpuri suplimentare: Nu

Metoda de livrare și informațiile asociate

ShippingData · Schemă · Scheme de date: Comenzi
amountMoneyData Obligatoriu

Suma brută a livrării înregistrată în comandă ca MoneyData. Modificările fiscale ulterioare nu schimbă această sumă istorică.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Obligatoriu

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

Exemplu: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
method_codeȘir de caractere nullObligatoriu

Codul metodei de livrare sau de plată.

Exemplu: "shipping-old"
method_nameȘir de caractere nullObligatoriu

Numele metodei de livrare sau de plată.

Exemplu: "Historic carrier"
pickup_pointPickupPointSummaryData nullObligatoriu

Punct de ridicare

Exemplu: null
recipient_modeȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Exemplu: "full_address"

Câmpuri suplimentare: Nu

ShippingDetailData

ShippingDetailData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
amountMoneyData Obligatoriu

Suma brută a livrării înregistrată în comandă ca MoneyData. Modificările fiscale ulterioare nu schimbă această sumă istorică.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Obligatoriu

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

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

Sumă brută · Reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObligatoriu

Sumă netă · Reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObligatoriu

Valoarea taxei · Reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsTablou <OrderDeliveryDiscountData > nullObligatoriu

Livrare · Reduceri; []: 0; null: Necunoscut: null; zero cunoscut: 0.

Exemplu: [{"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 Obligatoriu

Sumă brută · După reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeȘir de caractere nullObligatoriu

Codul metodei de livrare sau de plată.

Exemplu: "shipping-old"
method_nameȘir de caractere nullObligatoriu

Numele metodei de livrare sau de plată.

Exemplu: "Historic carrier"
netMoneyData nullObligatoriu

Sumă netă · După reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Obligatoriu

Sumă brută · Livrare · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullObligatoriu

Sumă netă · Livrare · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullObligatoriu

Valoarea taxei · Livrare · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullObligatoriu

Punct de ridicare

Exemplu: null
recipient_modeȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Exemplu: "full_address"
taxMoneyData nullObligatoriu

Valoarea taxei · După reduceri; Necunoscut: null; zero cunoscut: 0.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idȘir de caractere nullObligatoriu

Identificatorul categoriei fiscale · Datele salvate ale comenzii; null.

Exemplu: "standard"
tax_category_nameȘir de caractere nullObligatoriu

Numele salvat al categoriei fiscale; null.

Exemplu: "VAT 23%"
tax_rateȘir de caractere nullObligatoriu

tax_rate · Datele salvate ale comenzii: "0.23" = 23%; "0" ≠ null.

Exemplu: "0.23"

Câmpuri suplimentare: Nu