Preskočiť na obsah
ShopentlyLearn
Slovenčina

Dátové schémy: Objednávky

Dátové schémy: Objednávky. Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Dátové schémy

Doručovacia adresa

AddressData · Schéma · Dátové schémy: Objednávky
address_line_1Reťazec nullPovinné

Prvý riadok adresy.

address_line_2Reťazec nullPovinné

Doplňujúce údaje adresy.

cityReťazec nullPovinné

Mesto alebo obec.

country_codeReťazec nullPovinné

Kód krajiny.

first_nameReťazec nullPovinné

Meno.

house_numberReťazec nullPovinné

Číslo budovy alebo domu.

last_nameReťazec nullPovinné

Priezvisko.

phoneReťazec nullPovinné

Telefónne číslo.

postal_codeReťazec nullPovinné

Poštové smerovacie číslo.

regionReťazec nullPovinné

Správna oblasť.

streetReťazec nullPovinné

Názov ulice.

Ďalšie polia: Nie

ApiResponse_OrderFileListData_

ApiResponse_OrderFileListData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API. Po vytvorení upload_id odošlite súbory ako multipart/form-data a priraďte ich produktu. Stiahnutie vyžaduje token Bearer a oprávnenie pre category; odpoveď obsahuje bajty súboru bez verejnej adresy a hesla. Pre mode=period zvoľte days (1–3650) alebo doterajšie months, nikdy oboje. Podmienky sa uložia pri nákupe; vrátenie peňazí odoberie prístup iba vrátenej položke.
dataOrderFileListData Povinné

Obsah úspešnej odpovede.

Príklad: {"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 Povinné

Metaúdaje odpovede.

Príklad: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Ďalšie polia: Nie

ApiResponse_OrderReleaseListData_

ApiResponse_OrderReleaseListData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API. Po vytvorení upload_id odošlite súbory ako multipart/form-data a priraďte ich produktu. Stiahnutie vyžaduje token Bearer a oprávnenie pre category; odpoveď obsahuje bajty súboru bez verejnej adresy a hesla. Pre mode=period zvoľte days (1–3650) alebo doterajšie months, nikdy oboje. Podmienky sa uložia pri nákupe; vrátenie peňazí odoberie prístup iba vrátenej položke.
dataOrderReleaseListData Povinné

Obsah úspešnej odpovede.

Príklad: {"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 Povinné

Metaúdaje odpovede.

Príklad: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Ďalšie polia: Nie

Zobraziť zoznam — Objednávky — Odpoveď

ApiResponse_list_OrderSummaryData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataPole <OrderSummaryData > Povinné

Príklad odpovede · ApiResponse_list_OrderSummaryData__.

Príklad: [{"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 Povinné

Metaúdaje odpovede.

Príklad: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ďalšie polia: Nie

Načítať — Objednávky — Odpoveď

ApiResponse_OrderDetailData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataOrderDetailData Povinné

Príklad odpovede · OrderDetailData.

Príklad: {"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 Povinné

Metaúdaje odpovede.

Príklad: {"request_id":"example-request"}

Ďalšie polia: Nie

CurrentReleaseData

CurrentReleaseData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API. Po vytvorení upload_id odošlite súbory ako multipart/form-data a priraďte ich produktu. Stiahnutie vyžaduje token Bearer a oprávnenie pre category; odpoveď obsahuje bajty súboru bez verejnej adresy a hesla. Pre mode=period zvoľte days (1–3650) alebo doterajšie months, nikdy oboje. Podmienky sa uložia pri nákupe; vrátenie peňazí odoberie prístup iba vrátenej položke.
acquiredLogická hodnotaPovinné

Prístup po nákupe (true / false)

changelogReťazecPovinné

Popis zmien

covered_by_purchaseLogická hodnotaPovinné

Prístup po nákupe (true / false)

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.

published_atReťazecPovinné

Publikovať vydanie · UTC

format: "date-time"
requires_new_purchaseLogická hodnotaPovinné

Bez prístupu k súborom pridaným po nákupe · requires_new_purchase

sequenceCelé čísloPovinné

Pozícia v zoradenom zozname.

version_labelReťazecPovinné

Verzia

Ďalšie polia: Nie

Údaje zákazníka zaznamenané pri tomto zdroji

CustomerData · Schéma · Dátové schémy: Objednávky
emailReťazecPovinné

E-mailová adresa.

Príklad: "customer@example.invalid"
first_nameReťazec nullPovinné

Meno.

Príklad: "Example"
last_nameReťazec nullPovinné

Priezvisko.

Príklad: "Example"
phoneReťazec nullPovinné

Telefónne číslo.

Príklad: null

Ďalšie polia: Nie

DeliveryContentDeletion

DeliveryContentDeletion · Natrvalo zmažte obsah a zachovajte históriu. Kód sa nevracia do predajnej zásoby.
expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1
Príklad: 1
reasonReťazecPovinné

Dôvod zaznamenaný pri zmene.

minLength: 1maxLength: 500
Príklad: "Withdraw a revoked license"

Ďalšie polia: Nie

Dátumy odoslania a doručenia

DeliveryDatesData · Zoznam aj detail objednávky obsahujú delivery.dates. Plánované dátumy YYYY-MM-DD nepotvrdzujú odoslanie. Aktuálne dátumy majú prednosť; staršie objednávky používajú uložený odhad. Vymazané alebo neznáme hodnoty sú null. Detail obsahuje aj všetky položky a obrázky produktov.
dispatch_timezoneReťazec nullPovinné

Časové pásmo odoslania (IANA; null).

Príklad: "Europe/Warsaw"
estimated_delivery_fromReťazec nullPovinné

Začiatok odhadovaného doručenia (YYYY-MM-DD; null).

Reťazec:format: "date"
Príklad: "2026-10-20"
estimated_delivery_toReťazec nullPovinné

Koniec odhadovaného doručenia (YYYY-MM-DD; null).

Reťazec:format: "date"
Príklad: "2026-10-21"
planned_dispatch_onReťazec nullPovinné

Plánovaný dátum odoslania (YYYY-MM-DD; null).

Reťazec:format: "date"
Príklad: "2026-10-19"

Ďalšie polia: Nie

DeliveryReplacement

DeliveryReplacement · Vyberte existujúcu voľnú jednotku. Náhrada nezačne novú dobu uchovania.
expected_unit_versionCelé čísloPovinné

Aktuálna verzia voľnej náhradnej jednotky.

minimum: 1
Príklad: 1
expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1
Príklad: 1
reasonReťazecPovinné

Dôvod zaznamenaný pri zmene.

minLength: 1maxLength: 500
Príklad: "Replace an invalid activation code"
replacement_unit_idReťazecPovinné

ID existujúcej voľnej náhradnej jednotky.

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000008"

Ďalšie polia: Nie

DeliveryPickupPointData

DeliveryPickupPointData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
addressPickupPointAddressData Povinné

Doručovacia adresa.

codeReťazecPovinné

Stabilný strojovo čitateľný kód.

Obmedzenia
pattern
"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesData nullPovinné

Hodnota opísaná okolitou schémou.

country_codeReťazecPovinné

Kód krajiny.

Obmedzenia
pattern
"^[A-Z]{2}$"
environmentReťazecPovinné

Informácie o prostredí pripojené k záznamu.

Obmedzenia
enum
["live", "sandbox"]
kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["locker", "pickup_point"]
location_descriptionReťazec nullPovinné

Opis vo vybranom jazyku.

Reťazec:maxLength: 1000
nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

minLength: 1maxLength: 160
opening_hoursReťazec nullPovinné

Opening hours

Reťazec:maxLength: 500
operatorReťazecPovinné

Názov zdroja v príslušnom kontexte.

minLength: 1maxLength: 63
verified_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"

Ďalšie polia: Nie

ApiResponse[list[DeliveryData]]

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · Načítajte pridelené jednotky bez kódov. Vrátenie peňazí odoberie prístup iba dotknutým položkám.
dataPole <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > Povinné

Obsah úspešnej odpovede.

Príklad: [{"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 Povinné

Metaúdaje odpovede.

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

Ďalšie polia: Nie

DeliveryData

shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · Načítajte pridelené jednotky bez kódov. Vrátenie peňazí odoberie prístup iba dotknutým položkám.
can_downloadLogická hodnotaPovinné

Stiahnuť (true / false)

Príklad: true
content_stateReťazecPovinné

Stav obsahu: present / deleting / deleted.

Príklad: "present"
delete_due_atReťazec nullPovinné

Plánované zmazanie súboru; null ho vypne.

Reťazec:format: "date-time"
Príklad: null
filenameReťazec nullPovinné

Súbor

Príklad: null
first_available_atReťazec nullPovinné

Prvý prístup tohto nákupu; náhrada lehotu neobnovuje.

Reťazec:format: "date-time"
Príklad: "2026-11-03T12:00:00Z"
generationCelé čísloPovinné

Generácia pridelenia; pri náhrade sa zvyšuje.

Príklad: 1
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000005"
kindReťazec nullPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Príklad: "code"
line_idReťazecPovinné

Stály identifikátor položky objednávky.

Príklad: "line-example"
order_idReťazecPovinné

Identifikátor súvisiacej objednávky.

Príklad: "order-example"
payload_idReťazecPovinné

ID obsahu; nejde o verejný odkaz na stiahnutie.

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000012"
product_idReťazecPovinné

Identifikátor produktu.

Príklad: "example"
reasonReťazecPovinné

Dôvod zaznamenaný pri zmene.

Príklad: ""
size_bytesCelé číslo nullPovinné

Veľkosť v bajtoch

Príklad: null
stateReťazecPovinné

Stav

Príklad: "available"
unit_idReťazecPovinné

ID jedného individuálneho kódu alebo súboru.

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000011"
unit_ordinalCelé čísloPovinné

Číslo zakúpenej jednotky v položke objednávky.

Príklad: 1
variant_idReťazec nullPovinné

Identifikátor variantu produktu.

Príklad: null
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 2

Ďalšie polia: Nie

Fakturačné údaje

InvoiceData · Schéma · Dátové schémy: Objednávky
address_line_1Reťazec nullPovinné

Prvý riadok adresy.

address_line_2Reťazec nullPovinné

Doplňujúce údaje adresy.

cityReťazec nullPovinné

Mesto alebo obec.

company_nameReťazec nullPovinné

Názov spoločnosti.

country_codeReťazec nullPovinné

Kód krajiny.

house_numberReťazec nullPovinné

Číslo budovy alebo domu.

postal_codeReťazec nullPovinné

Poštové smerovacie číslo.

regionReťazec nullPovinné

Správna oblasť.

streetReťazec nullPovinné

Názov ulice.

tax_identifierReťazec nullPovinné

Daňové identifikačné číslo.

tax_schemeReťazec nullPovinné

Schéma výpočtu dane.

Ďalšie polia: Nie

Suma bez dane / Suma dane / Suma s daňou

OrderAmountBreakdownData · Sumy a sadzby pochádzajú z uloženej objednávky vrátane opráv položiek. Chýbajúce historické údaje sú null a nenahrádzajú sa aktuálnymi sadzbami katalógu. Sumy zostávajú desatinnými reťazcami.
grossMoneyData Povinné

Suma s daňou · Po zľavách; Neznáme: null; známa nula: 0.

Príklad: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullPovinné

Suma bez dane · Po zľavách; Neznáme: null; známa nula: 0.

Príklad: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullPovinné

Suma dane · Po zľavách; Neznáme: null; známa nula: 0.

Príklad: {"amount":"58.60","currency":"PLN","minor_units":2}

Ďalšie polia: Nie

Doprava · Zľavy

OrderDeliveryDiscountData · Sumy a sadzby pochádzajú z uloženej objednávky vrátane opráv položiek. Chýbajúce historické údaje sú null a nenahrádzajú sa aktuálnymi sadzbami katalógu. Sumy zostávajú desatinnými reťazcami.
amountMoneyData Povinné

Suma s daňou · Doprava · Zľavy.

Príklad: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.

Príklad: "saved-coupon"
codeReťazec nullPovinné

Stabilný strojovo čitateľný kód.

Príklad: "SAVE"
kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["coupon", "promotion"]
Príklad: "coupon"
nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Saved coupon"
sequenceCelé číslo nullPovinné

Pozícia v zoradenom zozname.

Príklad: 1
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 3

Ďalšie polia: Nie

Načítať — Objednávky — Odpoveď

OrderDetailData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
Príklad: "2026-10-19T10:00:00Z"
customerCustomerData Povinné

Údaje zákazníka zaznamenané pri tomto zdroji.

Príklad: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Povinné

Spôsob doručenia a súvisiace údaje.

Príklad: {"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 Povinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Príklad: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsPole <OrderDiscountData > Povinné

Zľavy

Príklad: [{"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}]
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (OrderDetailData).

Príklad: "order-0000"
invoiceInvoiceData nullPovinné

Fakturačné údaje.

Príklad: null
invoice_requestedLogická hodnotaPovinné

Či bola požadovaná faktúra.

Príklad: false
lifecycle_stateOrderLifecycleState Povinné

Stav obchodného životného cyklu.

Príklad: "placed"
linesPole <OrderLineData > Povinné

Uložené údaje položiek objednávky.

Príklad: [{"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":[]}]
localeReťazecPovinné

Jazyk vybraný pre túto požiadavku.

Príklad: "pl"
market_idReťazecPovinné

Identifikátor trhu vrátený koncovým bodom kontextu.

Príklad: "market-pl"
numberReťazecPovinné

Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

Príklad: "0001"
paymentPaymentData Povinné

Platobné údaje zaznamenané pri objednávke.

Príklad: {"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 nullPovinné

Výdajné miesto

Príklad: null
prices_include_taxLogická hodnotaPovinné

Či uvedené ceny zahŕňajú daň.

Príklad: true
shipping_addressAddressData nullPovinné

Doručovacia adresa.

Príklad: null
shipping_discount_amountMoneyData Povinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Príklad: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Povinné

Stav prijímaný touto konkrétnou operáciou.

Príklad: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Povinné

Suma pred ďalšími zložkami uvedenými v odpovedi.

Príklad: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Povinné

Daňové údaje.

Príklad: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Povinné

Daňové skupiny · source + tax_rate; unallocated_tax.

Príklad: {"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_codeReťazec nullPovinné

Daňová krajina · Uložená snímka objednávky · ISO 3166-1 alpha-2; null.

Príklad: "PL"
totalMoneyData Povinné

Celková suma.

Príklad: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Povinné

Súčty · net / tax / gross; Pred zľavami / Po zľavách.

Príklad: {"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}}}

Ďalšie polia: Nie

OrderFileData

OrderFileData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API. Po vytvorení upload_id odošlite súbory ako multipart/form-data a priraďte ich produktu. Stiahnutie vyžaduje token Bearer a oprávnenie pre category; odpoveď obsahuje bajty súboru bez verejnej adresy a hesla. Pre mode=period zvoľte days (1–3650) alebo doterajšie months, nikdy oboje. Podmienky sa uložia pri nákupe; vrátenie peňazí odoberie prístup iba vrátenej položke.
can_downloadLogická hodnotaPovinné

Stiahnuť (true / false)

Príklad: true
categoryFileCategory Povinné

Kategória súboru: internal / customer_document / digital

Príklad: "digital"
filenameReťazecPovinné

Súbor

Príklad: "manual.pdf"
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.

Príklad: "example"
labelReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Manual"
line_idReťazecPovinné

Stály identifikátor položky objednávky.

Príklad: "example"
mime_typeReťazecPovinné

Typ obsahu média.

Príklad: "application/pdf"
product_idReťazecPovinné

Identifikátor produktu.

Príklad: "example"
purchase_idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. · purchase_id

Príklad: "00000000-0000-4000-8000-000000000001"
reasonReťazecPovinné

Dôvod zaznamenaný pri zmene.

Príklad: "paid"
sha256ReťazecPovinné

SHA-256 (hex, 64)

Príklad: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesCelé čísloPovinné

Veľkosť v bajtoch

minimum: 1maximum: 262144000
Príklad: 46
source_file_idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. · source_file_id

Príklad: "00000000-0000-4000-8000-000000000001"
source_version_idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. · source_version_id

Príklad: "00000000-0000-4000-8000-000000000001"
source_version_numberCelé čísloPovinné

Verzia

minimum: 1
Príklad: 1
stateReťazecPovinné

Stav

Príklad: "active"

Ďalšie polia: Nie

OrderFileListData

OrderFileListData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API. Po vytvorení upload_id odošlite súbory ako multipart/form-data a priraďte ich produktu. Stiahnutie vyžaduje token Bearer a oprávnenie pre category; odpoveď obsahuje bajty súboru bez verejnej adresy a hesla. Pre mode=period zvoľte days (1–3650) alebo doterajšie months, nikdy oboje. Podmienky sa uložia pri nákupe; vrátenie peňazí odoberie prístup iba vrátenej položke.
filesPole <OrderFileData > Povinné

Súbory produktu

Príklad: [{"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_pendingLogická hodnotaPovinné

Prístup k budúcim súborom po nákupe · updates_pending

Príklad: false

Ďalšie polia: Nie

Metaúdaje a URL obrázka

OrderImageData · Schéma · Dátové schémy: Objednávky
altReťazec nullPovinné

Alternatívny text obrázka.

sourceReťazecVoliteľné

Zdroj zaznamenanej aktivity.

const: "current_catalog"
Predvolená hodnota: "current_catalog"
urlReťazecPovinné

URL zdroja.

Ďalšie polia: Nie

Stav obchodného životného cyklu

OrderLifecycleState · Schéma · Dátové schémy: Objednávky Reťazec
Obmedzenia
enum
["placed", "cancelled", "fulfilled", "returned"]

Ďalšie polia: Áno

Uložené údaje položiek objednávky

OrderLineData · Schéma · Dátové schémy: Objednávky
discount_amountMoneyData Povinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Príklad: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Povinné

Suma s daňou · Zľavy; Neznáme: null; známa nula: 0.

Príklad: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullPovinné

Suma bez dane · Zľavy; Neznáme: null; známa nula: 0.

Príklad: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullPovinné

Suma dane · Zľavy; Neznáme: null; známa nula: 0.

Príklad: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsPole <OrderDiscountData > Povinné

Zľavy · net / tax / gross.

Príklad: [{"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}]
identifiersObjektĎalšie polia: ReťazecPovinné

Identifikačné kódy produktu.

Príklad: {}
imageOrderImageData nullPovinné

Metaúdaje a URL obrázka.

Príklad: null
line_idReťazecPovinné

Stály identifikátor položky objednávky.

Príklad: "saved-line-a"
manual_discountOrderManualDiscountData nullPovinné

Ručná zľava; null.

Príklad: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Saved A"
original_totalMoneyData Povinné

Celková suma.

Príklad: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Povinné

Suma s daňou · Produkty · Pred zľavami; Neznáme: null; známa nula: 0.

Príklad: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullPovinné

Suma bez dane · Produkty · Pred zľavami; Neznáme: null; známa nula: 0.

Príklad: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullPovinné

Suma dane · Produkty · Pred zľavami; Neznáme: null; známa nula: 0.

Príklad: {"amount":"46.00","currency":"PLN","minor_units":2}
positionCelé čísloPovinné

Pozícia v zoradenom zozname.

Príklad: 1
product_idReťazecPovinné

Identifikátor produktu.

Príklad: "product-api"
quantityCelé čísloPovinné

Počet jednotiek.

Príklad: 2
skuReťazecPovinné

Skladový kód položky.

Príklad: "A"
taxMoneyData nullPovinné

Suma dane · Jedna jednotka · Uložená snímka objednávky; tax ≠ unit_tax; Neznáme: null; známa nula: 0.

Príklad: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idReťazec nullPovinné

Identifikátor daňovej kategórie · Uložená snímka objednávky; null.

Príklad: "standard"
tax_category_nameReťazec nullPovinné

Uložený názov daňovej kategórie; null.

Príklad: "VAT 23%"
tax_rateReťazec nullPovinné

tax_rate · Uložená snímka objednávky: "0.23" = 23%; "0" ≠ null.

Príklad: "0.23"
totalMoneyData Povinné

Celková suma.

Príklad: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Povinné

Suma s daňou · Produkty · Po zľavách; Neznáme: null; známa nula: 0.

Príklad: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullPovinné

Suma bez dane · Produkty · Po zľavách; Neznáme: null; známa nula: 0.

Príklad: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullPovinné

Suma dane · Produkty · Po zľavách · Uložená snímka objednávky; Neznáme: null; známa nula: 0.

Príklad: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Povinné

Suma s daňou · Jedna jednotka · Pred zľavami; Neznáme: null; známa nula: 0.

Príklad: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullPovinné

Suma bez dane · Jedna jednotka · Pred zľavami; Neznáme: null; známa nula: 0.

Príklad: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Povinné

Cena jednej jednotky.

Príklad: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullPovinné

Suma dane · Jedna jednotka · Pred zľavami; Neznáme: null; známa nula: 0.

Príklad: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idReťazec nullPovinné

Identifikátor variantu produktu.

Príklad: null
variant_optionsPole <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Povinné

Možnosti variantov priradené produktu alebo uloženému záznamu.

Príklad: []

Ďalšie polia: Nie

Ručná zľava

OrderManualDiscountData · Sumy a sadzby pochádzajú z uloženej objednávky vrátane opráv položiek. Chýbajúce historické údaje sú null a nenahrádzajú sa aktuálnymi sadzbami katalógu. Sumy zostávajú desatinnými reťazcami.
amountMoneyData Povinné

Suma s daňou · Ručná zľava · Uložená snímka objednávky.

Príklad: {"amount":"12.30","currency":"PLN","minor_units":2}
kindReťazecPovinné

Druh zľavy: percentage / fixed.

Obmedzenia
enum
["percentage", "fixed"]
Príklad: "fixed"
valueReťazecPovinné

Nastavená hodnota: percentage "10" = 10%; fixed = Suma s daňou.

Príklad: "12.30"

Ďalšie polia: Nie

Stav prijímaný touto konkrétnou operáciou

OrderPaymentStatus · Schéma · Dátové schémy: Objednávky Reťazec
Obmedzenia
enum
["unpaid", "paid", "failed", "refunded"]

Ďalšie polia: Áno

OrderReleaseData

OrderReleaseData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API. Po vytvorení upload_id odošlite súbory ako multipart/form-data a priraďte ich produktu. Stiahnutie vyžaduje token Bearer a oprávnenie pre category; odpoveď obsahuje bajty súboru bez verejnej adresy a hesla. Pre mode=period zvoľte days (1–3650) alebo doterajšie months, nikdy oboje. Podmienky sa uložia pri nákupe; vrátenie peňazí odoberie prístup iba vrátenej položke.
access_reasonReťazecPovinné

Prístup po nákupe · Dôvod zaznamenaný pri zmene.

Príklad: "paid"
access_stateReťazecPovinné

Prístup po nákupe · Stav

Príklad: "active"
current_releaseCurrentReleaseData nullPovinné

Digitálne vydania · current_release

Príklad: null
grant_reasonReťazecPovinné

Prístup po nákupe · Dôvod zaznamenaný pri zmene.

Príklad: "purchase"
granted_atReťazecPovinné

Prístup po nákupe · UTC

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.

Príklad: "example"
line_idReťazecPovinné

Stály identifikátor položky objednávky.

Príklad: "example"
manifest_sha256ReťazecPovinné

Digitálne vydania · SHA-256

Príklad: "1111111111111111111111111111111111111111111111111111111111111111"
product_idReťazecPovinné

Identifikátor produktu.

Príklad: "example"
published_atReťazecPovinné

Publikovať vydanie · UTC

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
purchase_idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. · purchase_id

Príklad: "00000000-0000-4000-8000-000000000001"
release_idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. · release_id

Príklad: "00000000-0000-4000-8000-000000000001"
release_sequenceCelé čísloPovinné

Digitálne vydania · Pozícia v zoradenom zozname.

Príklad: 1
update_daysCelé číslo nullPovinné

Počet dní (days; null)

Príklad: 365
update_modeReťazecPovinné

Prístup k budúcim súborom po nákupe: none / period / unlimited

Príklad: "period"
update_monthsCelé číslo nullPovinné

Mesiace (months; null)

Príklad: null
updates_untilReťazec nullPovinné

Prístup k budúcim súborom po nákupe · UTC

Reťazec:format: "date-time"
Príklad: "2027-01-01T12:00:00Z"
version_labelReťazecPovinné

Verzia

Príklad: "1.0"

Ďalšie polia: Nie

OrderReleaseListData

OrderReleaseListData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API. Po vytvorení upload_id odošlite súbory ako multipart/form-data a priraďte ich produktu. Stiahnutie vyžaduje token Bearer a oprávnenie pre category; odpoveď obsahuje bajty súboru bez verejnej adresy a hesla. Pre mode=period zvoľte days (1–3650) alebo doterajšie months, nikdy oboje. Podmienky sa uložia pri nákupe; vrátenie peňazí odoberie prístup iba vrátenej položke.
releasesPole <OrderReleaseData > Povinné

Digitálne vydania

Príklad: [{"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_pendingLogická hodnotaPovinné

Prístup k budúcim súborom po nákupe · updates_pending

Príklad: false

Ďalšie polia: Nie

Stav prijímaný touto konkrétnou operáciou

OrderStatusData · Schéma · Dátové schémy: Objednávky
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (OrderStatusData).

Príklad: "status-0"
nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Status 0"
updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"
Príklad: "2026-10-19T10:00:00Z"
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Zobraziť zoznam · Stavy — Objednávky — Odpoveď

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Príklad: "status-0"
is_initialLogická hodnotaPovinné

Či ide o počiatočný stav.

Príklad: true
nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "New"
positionCelé čísloPovinné

Pozícia v zoradenom zozname.

Príklad: 0

Ďalšie polia: Nie

Zobraziť zoznam · Stavy — Objednávky — Odpoveď

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataPole <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Povinné

Príklad odpovede · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Príklad: [{"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 Povinné

Metaúdaje odpovede.

Príklad: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ďalšie polia: Nie

Upraviť · Stav — Objednávky — Telo požiadavky

OrderStatusUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807
Príklad: 1
status_idReťazecPovinné

Identifikátor získaný z príslušného číselníka stavov.

Obmedzenia
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Príklad: "status-1"

Ďalšie polia: Nie

Zobraziť zoznam — Objednávky — Odpoveď

OrderSummaryData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
Príklad: "2026-10-19T10:00:00Z"
customerCustomerData Povinné

Údaje zákazníka zaznamenané pri tomto zdroji.

Príklad: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Povinné

Spôsob doručenia a súvisiace údaje.

Príklad: {"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 Povinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Príklad: {"amount":"24.60","currency":"PLN","minor_units":2}
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (OrderSummaryData).

Príklad: "order-0000"
lifecycle_stateOrderLifecycleState Povinné

Stav obchodného životného cyklu.

Príklad: "placed"
localeReťazecPovinné

Jazyk vybraný pre túto požiadavku.

Príklad: "pl"
market_idReťazecPovinné

Identifikátor trhu vrátený koncovým bodom kontextu.

Príklad: "market-pl"
numberReťazecPovinné

Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

Príklad: "0001"
paymentPaymentData Povinné

Platobné údaje zaznamenané pri objednávke.

Príklad: {"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_taxLogická hodnotaPovinné

Či uvedené ceny zahŕňajú daň.

Príklad: true
shipping_discount_amountMoneyData Povinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Príklad: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Povinné

Stav prijímaný touto konkrétnou operáciou.

Príklad: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Povinné

Suma pred ďalšími zložkami uvedenými v odpovedi.

Príklad: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Povinné

Daňové údaje.

Príklad: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeReťazec nullPovinné

Daňová krajina · Uložená snímka objednávky · ISO 3166-1 alpha-2; null.

Príklad: "PL"
totalMoneyData Povinné

Celková suma.

Príklad: {"amount":"329.40","currency":"PLN","minor_units":2}

Ďalšie polia: Nie

Objednávka · Daňové skupiny

OrderTaxBreakdownData · Sumy a sadzby pochádzajú z uloženej objednávky vrátane opráv položiek. Chýbajúce historické údaje sú null a nenahrádzajú sa aktuálnymi sadzbami katalógu. Sumy zostávajú desatinnými reťazcami.
groupsPole <OrderTaxGroupData > Povinné

Daňové skupiny · source + tax_rate; Neznáme: null; známa nula: 0.

Príklad: [{"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 Povinné

Nepriradená daň = order.tax − Σ groups.tax; ±.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}

Ďalšie polia: Nie

Daňové skupiny

OrderTaxGroupData · Sumy a sadzby pochádzajú z uloženej objednávky vrátane opráv položiek. Chýbajúce historické údaje sú null a nenahrádzajú sa aktuálnymi sadzbami katalógu. Sumy zostávajú desatinnými reťazcami.
grossMoneyData Povinné

Suma s daňou · Po zľavách; Neznáme: null; známa nula: 0.

Príklad: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullPovinné

Suma bez dane · Po zľavách; Neznáme: null; známa nula: 0.

Príklad: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceReťazecPovinné

Zdroj: products (Produkty), shipping (Doprava).

Obmedzenia
enum
["products", "shipping"]
Príklad: "products"
taxMoneyData nullPovinné

Suma dane · Po zľavách; Neznáme: null; známa nula: 0.

Príklad: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateReťazec nullPovinné

tax_rate · Uložená snímka objednávky: "0.23" = 23%; "0" ≠ null.

Príklad: "0.23"

Ďalšie polia: Nie

Objednávka · Súčty

OrderTotalsData · Sumy a sadzby pochádzajú z uloženej objednávky vrátane opráv položiek. Chýbajúce historické údaje sú null a nenahrádzajú sa aktuálnymi sadzbami katalógu. Sumy zostávajú desatinnými reťazcami.
before_discountsOrderAmountBreakdownData Povinné

Objednávka · Pred zľavami · net / tax / gross.

Príklad: {"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 Povinné

Zľavy · net / tax / gross.

Príklad: {"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 Povinné

Objednávka · Po zľavách · net / tax / gross.

Príklad: {"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 Povinné

Produkty · Zľavy · net / tax / gross.

Príklad: {"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 Povinné

Produkty · Po zľavách · net / tax / gross.

Príklad: {"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 Povinné

Produkty · Pred zľavami · net / tax / gross.

Príklad: {"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 Povinné

Doprava · Po zľavách · net / tax / gross.

Príklad: {"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 Povinné

Doprava · Pred zľavami · net / tax / gross.

Príklad: {"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 Povinné

Doprava · Zľavy · net / tax / gross.

Príklad: {"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}}

Ďalšie polia: Nie

Možnosti variantov priradené produktu alebo uloženému záznamu

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Schéma · Dátové schémy: Objednávky
nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

valueReťazecPovinné

Hodnota opísaná okolitou schémou.

Ďalšie polia: Nie

OrderDiscountData

OrderDiscountData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
amountMoneyData Povinné

Suma s daňou · Produkty · Zľavy.

Príklad: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.

Príklad: "saved-coupon"
codeReťazec nullPovinné

Stabilný strojovo čitateľný kód.

Príklad: "SAVE"
kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["coupon", "promotion"]
Príklad: "coupon"
nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Saved coupon"
sequenceCelé číslo nullVoliteľné

Poradie použitia; null.

Príklad: 1
shipping_amountMoneyData nullVoliteľné

Suma s daňou · Doprava · Zľavy; null.

Príklad: {"amount":"24.60","currency":"PLN","minor_units":2}
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 3

Ďalšie polia: Nie

Platobné údaje zaznamenané pri objednávke

PaymentData · Schéma · Dátové schémy: Objednávky
amountMoneyData Povinné

payment.amount je celková suma objednávky. Stav platby neurčuje zaplatené, vrátené ani dlžné sumy.

Príklad: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentReťazecPovinné

Informácie o prostredí pripojené k záznamu.

Obmedzenia
enum
["live", "sandbox"]
Príklad: "live"
method_codeReťazec nullPovinné

Kód spôsobu doručenia alebo platby.

Príklad: "payment-old"
method_nameReťazec nullPovinné

Názov spôsobu doručenia alebo platby.

Príklad: "Historic method"
paid_atReťazec nullPovinné

Dátum a čas označenia platby ako zaplatenej.

Reťazec:format: "date-time"
Príklad: null
statusOrderPaymentStatus Povinné

Stav prijímaný touto konkrétnou operáciou.

Príklad: "unpaid"
updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"
Príklad: "2026-10-19T10:00:00Z"
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 0

Ďalšie polia: Nie

Upraviť · Stav platby — Objednávky — Telo požiadavky

PaymentStatusUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 0maximum: 9223372036854775807
Príklad: 0
reasonReťazecPovinné

Dôvod zaznamenaný pri zmene.

minLength: 1maxLength: 500
Príklad: "Bank transfer confirmed"
statusPaymentStatus Povinné

Stav prijímaný touto konkrétnou operáciou. unpaid: nezaplatené; paid: zaplatené; failed: platba zlyhala; refunded: vrátené.

Príklad: "paid"

Ďalšie polia: Nie

Stav prijímaný touto konkrétnou operáciou

PaymentStatus · Schéma · Dátové schémy: Objednávky Reťazec
Obmedzenia
enum
["unpaid", "paid", "failed", "refunded"]

Ďalšie polia: Áno

PickupPointAddressData

PickupPointAddressData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
address_line_1ReťazecPovinné

Prvý riadok adresy.

minLength: 1maxLength: 240
cityReťazecPovinné

Mesto alebo obec.

minLength: 1maxLength: 160
postal_codeReťazecPovinné

Poštové smerovacie číslo.

minLength: 1maxLength: 32

Ďalšie polia: Nie

PickupPointCoordinatesData

PickupPointCoordinatesData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
latitudeČísloPovinné

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeČísloPovinné

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Ďalšie polia: Nie

PickupPointData

PickupPointData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
address_line1ReťazecPovinné

Prvý riadok adresy.

cityReťazecPovinné

Mesto alebo obec.

codeReťazecPovinné

Stabilný strojovo čitateľný kód.

country_codeReťazecPovinné

Kód krajiny.

kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["locker", "pickup_point"]
latitudeČíslo nullPovinné

WGS84 φ (°)

location_descriptionReťazec nullPovinné

Opis vo vybranom jazyku.

longitudeČíslo nullPovinné

WGS84 λ (°)

nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

opening_hoursReťazec nullPovinné

Opening hours

operatorReťazecPovinné

Názov zdroja v príslušnom kontexte.

postal_codeReťazecPovinné

Poštové smerovacie číslo.

Ďalšie polia: Nie

PickupPointSummaryData

PickupPointSummaryData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
codeReťazecPovinné

Stabilný strojovo čitateľný kód.

Obmedzenia
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeReťazecPovinné

Kód krajiny.

Obmedzenia
pattern
"^[A-Z]{2}$"
environmentReťazecPovinné

Informácie o prostredí pripojené k záznamu.

Obmedzenia
enum
["live", "sandbox"]
kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["locker", "pickup_point"]
operatorReťazecPovinné

Názov zdroja v príslušnom kontexte.

minLength: 1maxLength: 63

Ďalšie polia: Nie

Údaje zákazníka zaznamenané pri tomto zdroji

RequestCustomerData · Schéma · Dátové schémy: Objednávky
emailReťazecPovinné

E-mailová adresa.

Príklad: "customer@example.invalid"
nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Example"

Ďalšie polia: Nie

Spôsob doručenia a súvisiace údaje

ShippingData · Schéma · Dátové schémy: Objednávky
amountMoneyData Povinné

Hrubá suma dopravy uložená v objednávke ako MoneyData. Neskoršie zmeny dane túto historickú sumu nemenia.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Povinné

Dátumy odoslania a doručenia. Zoznam aj detail objednávky obsahujú delivery.dates. Plánované dátumy YYYY-MM-DD nepotvrdzujú odoslanie. Aktuálne dátumy majú prednosť; staršie objednávky používajú uložený odhad. Vymazané alebo neznáme hodnoty sú null. Detail obsahuje aj všetky položky a obrázky produktov.

Príklad: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
method_codeReťazec nullPovinné

Kód spôsobu doručenia alebo platby.

Príklad: "shipping-old"
method_nameReťazec nullPovinné

Názov spôsobu doručenia alebo platby.

Príklad: "Historic carrier"
pickup_pointPickupPointSummaryData nullPovinné

Výdajné miesto

Príklad: null
recipient_modeReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Príklad: "full_address"

Ďalšie polia: Nie

ShippingDetailData

ShippingDetailData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
amountMoneyData Povinné

Hrubá suma dopravy uložená v objednávke ako MoneyData. Neskoršie zmeny dane túto historickú sumu nemenia.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Povinné

Dátumy odoslania a doručenia. Zoznam aj detail objednávky obsahujú delivery.dates. Plánované dátumy YYYY-MM-DD nepotvrdzujú odoslanie. Aktuálne dátumy majú prednosť; staršie objednávky používajú uložený odhad. Vymazané alebo neznáme hodnoty sú null. Detail obsahuje aj všetky položky a obrázky produktov.

Príklad: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
discount_grossMoneyData Povinné

Suma s daňou · Zľavy; Neznáme: null; známa nula: 0.

Príklad: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullPovinné

Suma bez dane · Zľavy; Neznáme: null; známa nula: 0.

Príklad: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullPovinné

Suma dane · Zľavy; Neznáme: null; známa nula: 0.

Príklad: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsPole <OrderDeliveryDiscountData > nullPovinné

Doprava · Zľavy; []: 0; null: Neznáme: null; známa nula: 0.

Príklad: [{"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 Povinné

Suma s daňou · Po zľavách; Neznáme: null; známa nula: 0.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeReťazec nullPovinné

Kód spôsobu doručenia alebo platby.

Príklad: "shipping-old"
method_nameReťazec nullPovinné

Názov spôsobu doručenia alebo platby.

Príklad: "Historic carrier"
netMoneyData nullPovinné

Suma bez dane · Po zľavách; Neznáme: null; známa nula: 0.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Povinné

Suma s daňou · Doprava · Pred zľavami; Neznáme: null; známa nula: 0.

Príklad: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullPovinné

Suma bez dane · Doprava · Pred zľavami; Neznáme: null; známa nula: 0.

Príklad: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullPovinné

Suma dane · Doprava · Pred zľavami; Neznáme: null; známa nula: 0.

Príklad: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullPovinné

Výdajné miesto

Príklad: null
recipient_modeReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Príklad: "full_address"
taxMoneyData nullPovinné

Suma dane · Po zľavách; Neznáme: null; známa nula: 0.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idReťazec nullPovinné

Identifikátor daňovej kategórie · Uložená snímka objednávky; null.

Príklad: "standard"
tax_category_nameReťazec nullPovinné

Uložený názov daňovej kategórie; null.

Príklad: "VAT 23%"
tax_rateReťazec nullPovinné

tax_rate · Uložená snímka objednávky: "0.23" = 23%; "0" ≠ null.

Príklad: "0.23"

Ďalšie polia: Nie