Přejít na obsah
ShopentlyLearn
Čeština

Datová schémata: Objednávky

Datová schémata: Objednávky. Pole, typy a omezení dat přijímaných nebo vracených API.

Datová schémata

Doručovací adresa

AddressData · Schéma · Datová schémata: Objednávky
address_line_1Řetězec nullPovinné

První řádek adresy.

address_line_2Řetězec nullPovinné

Doplňující údaje adresy.

cityŘetězec nullPovinné

Město nebo obec.

country_codeŘetězec nullPovinné

Kód země.

first_nameŘetězec nullPovinné

Jméno.

house_numberŘetězec nullPovinné

Číslo budovy nebo domu.

last_nameŘetězec nullPovinné

Příjmení.

phoneŘetězec nullPovinné

Telefonní číslo.

postal_codeŘetězec nullPovinné

Poštovní směrovací číslo.

regionŘetězec nullPovinné

Správní oblast.

streetŘetězec nullPovinné

Název ulice.

Další pole: Ne

Vypsat — Objednávky — Odpověď

ApiResponse_list_OrderSummaryData__ · Pole, typy a omezení dat přijímaných nebo vracených API.
dataPole <OrderSummaryData > Povinné

Příklad odpovědi · ApiResponse_list_OrderSummaryData__.

Pří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é

Metadata odpovědi.

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

Další pole: Ne

Načíst — Objednávky — Odpověď

ApiResponse_OrderDetailData_ · Pole, typy a omezení dat přijímaných nebo vracených API.
dataOrderDetailData Povinné

Příklad odpovědi · OrderDetailData.

Pří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é

Metadata odpovědi.

Příklad: {"request_id":"example-request"}

Další pole: Ne

Údaje zákazníka zaznamenané u tohoto zdroje

CustomerData · Schéma · Datová schémata: Objednávky
emailŘetězecPovinné

E-mailová adresa.

Příklad: "customer@example.invalid"
first_nameŘetězec nullPovinné

Jméno.

Příklad: "Example"
last_nameŘetězec nullPovinné

Příjmení.

Příklad: "Example"
phoneŘetězec nullPovinné

Telefonní číslo.

Příklad: null

Další pole: Ne

Data odeslání a doručení

DeliveryDatesData · Seznam i detail objednávky obsahují delivery.dates. Plánovaná data YYYY-MM-DD nepotvrzují odeslání. Aktuální data mají přednost; starší objednávky používají uložený odhad. Vymazané nebo neznámé hodnoty jsou null. Detail obsahuje také všechny položky a obrázky produktů.
dispatch_timezoneŘetězec nullPovinné

Časové pásmo odeslání (IANA; null).

Příklad: "Europe/Warsaw"
estimated_delivery_fromŘetězec nullPovinné

Začátek odhadovaného doručení (YYYY-MM-DD; null).

Řetězec:format: "date"
Příklad: "2026-10-20"
estimated_delivery_toŘetězec nullPovinné

Konec odhadovaného doručení (YYYY-MM-DD; null).

Řetězec:format: "date"
Příklad: "2026-10-21"
planned_dispatch_onŘetězec nullPovinné

Plánované datum odeslání (YYYY-MM-DD; null).

Řetězec:format: "date"
Příklad: "2026-10-19"

Další pole: Ne

DeliveryPickupPointData

DeliveryPickupPointData · Pole, typy a omezení dat přijímaných nebo vracených API.
addressPickupPointAddressData Povinné

Doručovací adresa.

codeŘetězecPovinné

Stabilní strojově čitelný kód.

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

Hodnota popsaná okolním schématem.

country_codeŘetězecPovinné

Kód země.

Omezení
pattern
"^[A-Z]{2}$"
environmentŘetězecPovinné

Informace o prostředí připojené k záznamu.

Omezení
enum
["live", "sandbox"]
kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["locker", "pickup_point"]
location_descriptionŘetězec nullPovinné

Popis ve vybraném jazyce.

Řetězec:maxLength: 1000
nameŘetězecPovinné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 160
opening_hoursŘetězec nullPovinné

Opening hours

Řetězec:maxLength: 500
operatorŘetězecPovinné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 63
verified_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"

Další pole: Ne

Fakturační údaje

InvoiceData · Schéma · Datová schémata: Objednávky
address_line_1Řetězec nullPovinné

První řádek adresy.

address_line_2Řetězec nullPovinné

Doplňující údaje adresy.

cityŘetězec nullPovinné

Město nebo obec.

company_nameŘetězec nullPovinné

Název společnosti.

country_codeŘetězec nullPovinné

Kód země.

house_numberŘetězec nullPovinné

Číslo budovy nebo domu.

postal_codeŘetězec nullPovinné

Poštovní směrovací číslo.

regionŘetězec nullPovinné

Správní oblast.

streetŘetězec nullPovinné

Název ulice.

tax_identifierŘetězec nullPovinné

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

tax_schemeŘetězec nullPovinné

Schéma výpočtu daně.

Další pole: Ne

Částka bez daně / Částka daně / Částka s daní

OrderAmountBreakdownData · Částky a sazby pocházejí z uložené objednávky včetně oprav položek. Chybějící historické údaje jsou null a nenahrazují se aktuálními sazbami katalogu. Částky zůstávají desetinnými řetězci.
grossMoneyData Povinné

Částka s daní · Po slevách; Neznámé: null; známá nula: 0.

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

Částka bez daně · Po slevách; Neznámé: null; známá nula: 0.

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

Částka daně · Po slevách; Neznámé: null; známá nula: 0.

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

Další pole: Ne

Doprava · Slevy

OrderDeliveryDiscountData · Částky a sazby pocházejí z uložené objednávky včetně oprav položek. Chybějící historické údaje jsou null a nenahrazují se aktuálními sazbami katalogu. Částky zůstávají desetinnými řetězci.
amountMoneyData Povinné

Částka s daní · Doprava · Slevy.

Příklad: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

Příklad: "saved-coupon"
codeŘetězec nullPovinné

Stabilní strojově čitelný kód.

Příklad: "SAVE"
kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["coupon", "promotion"]
Příklad: "coupon"
nameŘetězecPovinné

Název zdroje v příslušném kontextu.

Příklad: "Saved coupon"
sequenceCelé číslo nullPovinné

Pozice v seřazeném seznamu.

Příklad: 1
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 3

Další pole: Ne

Načíst — Objednávky — Odpověď

OrderDetailData · Pole, typy a omezení dat přijímaných nebo vracených API.
created_atŘetězecPovinné

Čas vytvoření.

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

Údaje zákazníka zaznamenané u tohoto zdroje.

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

Způsob doručení a související údaje.

Pří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é

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

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

Slevy

Pří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}]
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (OrderDetailData).

Příklad: "order-0000"
invoiceInvoiceData nullPovinné

Fakturační údaje.

Příklad: null
invoice_requestedLogická hodnotaPovinné

Zda byla požadována faktura.

Příklad: false
lifecycle_stateOrderLifecycleState Povinné

Stav obchodního životního cyklu.

Příklad: "placed"
linesPole <OrderLineData > Povinné

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

Pří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":[]}]
localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

Příklad: "pl"
market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

Příklad: "market-pl"
numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

Příklad: "0001"
paymentPaymentData Povinné

Platební údaje zaznamenané u objednávky.

Pří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ýdejní místo

Příklad: null
prices_include_taxLogická hodnotaPovinné

Zda uvedené ceny zahrnují daň.

Příklad: true
shipping_addressAddressData nullPovinné

Doručovací adresa.

Příklad: null
shipping_discount_amountMoneyData Povinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

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

Stav přijímaný touto konkrétní operací.

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

Částka před dalšími složkami uvedenými v odpovědi.

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

Daňové údaje.

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

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

Pří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_codeŘetězec nullPovinné

Daňová země · Uložený snímek objednávky · ISO 3166-1 alpha-2; null.

Příklad: "PL"
totalMoneyData Povinné

Celková částka.

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

Součty · net / tax / gross; Před slevami / Po slevách.

Pří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}}}

Další pole: Ne

Metadata a URL obrázku

OrderImageData · Schéma · Datová schémata: Objednávky
altŘetězec nullPovinné

Alternativní text obrázku.

sourceŘetězecVolitelné

Zdroj zaznamenané aktivity.

const: "current_catalog"
Výchozí hodnota: "current_catalog"
urlŘetězecPovinné

URL zdroje.

Další pole: Ne

Stav obchodního životního cyklu

OrderLifecycleState · Schéma · Datová schémata: Objednávky Řetězec
Omezení
enum
["placed", "cancelled", "fulfilled", "returned"]

Další pole: Ano

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

OrderLineData · Schéma · Datová schémata: Objednávky
discount_amountMoneyData Povinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

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

Částka s daní · Slevy; Neznámé: null; známá nula: 0.

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

Částka bez daně · Slevy; Neznámé: null; známá nula: 0.

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

Částka daně · Slevy; Neznámé: null; známá nula: 0.

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

Slevy · net / tax / gross.

Pří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}]
identifiersObjektDalší pole: ŘetězecPovinné

Identifikační kódy produktu.

Příklad: {}
imageOrderImageData nullPovinné

Metadata a URL obrázku.

Příklad: null
line_idŘetězecPovinné

Stálý identifikátor položky objednávky.

Příklad: "saved-line-a"
manual_discountOrderManualDiscountData nullPovinné

Ruční sleva; null.

Příklad: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameŘetězecPovinné

Název zdroje v příslušném kontextu.

Příklad: "Saved A"
original_totalMoneyData Povinné

Celková částka.

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

Částka s daní · Produkty · Před slevami; Neznámé: null; známá nula: 0.

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

Částka bez daně · Produkty · Před slevami; Neznámé: null; známá nula: 0.

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

Částka daně · Produkty · Před slevami; Neznámé: null; známá nula: 0.

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

Pozice v seřazeném seznamu.

Příklad: 1
product_idŘetězecPovinné

Identifikátor produktu.

Příklad: "product-api"
quantityCelé čísloPovinné

Počet jednotek.

Příklad: 2
skuŘetězecPovinné

Skladový kód položky.

Příklad: "A"
taxMoneyData nullPovinné

Částka daně · Jedna jednotka · Uložený snímek objednávky; tax ≠ unit_tax; Neznámé: null; známá nula: 0.

Příklad: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idŘetězec nullPovinné

Identifikátor daňové kategorie · Uložený snímek objednávky; null.

Příklad: "standard"
tax_category_nameŘetězec nullPovinné

Uložený název daňové kategorie; null.

Příklad: "VAT 23%"
tax_rateŘetězec nullPovinné

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

Příklad: "0.23"
totalMoneyData Povinné

Celková částka.

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

Částka s daní · Produkty · Po slevách; Neznámé: null; známá nula: 0.

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

Částka bez daně · Produkty · Po slevách; Neznámé: null; známá nula: 0.

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

Částka daně · Produkty · Po slevách · Uložený snímek objednávky; Neznámé: null; známá nula: 0.

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

Částka s daní · Jedna jednotka · Před slevami; Neznámé: null; známá nula: 0.

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

Částka bez daně · Jedna jednotka · Před slevami; Neznámé: null; známá nula: 0.

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

Cena jedné jednotky.

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

Částka daně · Jedna jednotka · Před slevami; Neznámé: null; známá nula: 0.

Příklad: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idŘetězec nullPovinné

Identifikátor varianty produktu.

Příklad: null
variant_optionsPole <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Povinné

Možnosti variant přiřazené produktu nebo uloženému záznamu.

Příklad: []

Další pole: Ne

Ruční sleva

OrderManualDiscountData · Částky a sazby pocházejí z uložené objednávky včetně oprav položek. Chybějící historické údaje jsou null a nenahrazují se aktuálními sazbami katalogu. Částky zůstávají desetinnými řetězci.
amountMoneyData Povinné

Částka s daní · Ruční sleva · Uložený snímek objednávky.

Příklad: {"amount":"12.30","currency":"PLN","minor_units":2}
kindŘetězecPovinné

Druh slevy: percentage / fixed.

Omezení
enum
["percentage", "fixed"]
Příklad: "fixed"
valueŘetězecPovinné

Nastavená hodnota: percentage "10" = 10%; fixed = Částka s daní.

Příklad: "12.30"

Další pole: Ne

Stav přijímaný touto konkrétní operací

OrderPaymentStatus · Schéma · Datová schémata: Objednávky Řetězec
Omezení
enum
["unpaid", "paid", "failed", "refunded"]

Další pole: Ano

Stav přijímaný touto konkrétní operací

OrderStatusData · Schéma · Datová schémata: Objednávky
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (OrderStatusData).

Příklad: "status-0"
nameŘetězecPovinné

Název zdroje v příslušném kontextu.

Příklad: "Status 0"
updated_atŘetězecPovinné

Čas poslední aktualizace.

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

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Vypsat · Stavy — Objednávky — Odpověď

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Pole, typy a omezení dat přijímaných nebo vracených API.
created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Příklad: "example"
is_initialLogická hodnotaPovinné

Zda jde o počáteční stav.

Příklad: false
nameŘetězecPovinné

Název zdroje v příslušném kontextu.

Příklad: "Example"
positionCelé čísloPovinné

Pozice v seřazeném seznamu.

Příklad: 1

Další pole: Ne

Vypsat · Stavy — Objednávky — Odpověď

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Pole, typy a omezení dat přijímaných nebo vracených API.
dataPole <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Povinné

Příklad odpovědi · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Příklad: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metadata odpovědi.

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

Další pole: Ne

Upravit · Stav — Objednávky — Tělo požadavku

OrderStatusUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.
expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807
Příklad: 1
status_idŘetězecPovinné

Identifikátor získaný z příslušného číselníku stavů.

Omezení
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "example"

Další pole: Ne

Vypsat — Objednávky — Odpověď

OrderSummaryData · Pole, typy a omezení dat přijímaných nebo vracených API.
created_atŘetězecPovinné

Čas vytvoření.

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

Údaje zákazníka zaznamenané u tohoto zdroje.

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

Způsob doručení a související údaje.

Pří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é

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

Příklad: {"amount":"24.60","currency":"PLN","minor_units":2}
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (OrderSummaryData).

Příklad: "order-0000"
lifecycle_stateOrderLifecycleState Povinné

Stav obchodního životního cyklu.

Příklad: "placed"
localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

Příklad: "pl"
market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

Příklad: "market-pl"
numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

Příklad: "0001"
paymentPaymentData Povinné

Platební údaje zaznamenané u objednávky.

Pří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é

Zda uvedené ceny zahrnují daň.

Příklad: true
shipping_discount_amountMoneyData Povinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

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

Stav přijímaný touto konkrétní operací.

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

Částka před dalšími složkami uvedenými v odpovědi.

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

Daňové údaje.

Příklad: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeŘetězec nullPovinné

Daňová země · Uložený snímek objednávky · ISO 3166-1 alpha-2; null.

Příklad: "PL"
totalMoneyData Povinné

Celková částka.

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

Další pole: Ne

Objednávka · Daňové skupiny

OrderTaxBreakdownData · Částky a sazby pocházejí z uložené objednávky včetně oprav položek. Chybějící historické údaje jsou null a nenahrazují se aktuálními sazbami katalogu. Částky zůstávají desetinnými řetězci.
groupsPole <OrderTaxGroupData > Povinné

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

Pří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é

Nepřiřazená daň = order.tax − Σ groups.tax; ±.

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

Další pole: Ne

Daňové skupiny

OrderTaxGroupData · Částky a sazby pocházejí z uložené objednávky včetně oprav položek. Chybějící historické údaje jsou null a nenahrazují se aktuálními sazbami katalogu. Částky zůstávají desetinnými řetězci.
grossMoneyData Povinné

Částka s daní · Po slevách; Neznámé: null; známá nula: 0.

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

Částka bez daně · Po slevách; Neznámé: null; známá nula: 0.

Příklad: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceŘetězecPovinné

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

Omezení
enum
["products", "shipping"]
Příklad: "products"
taxMoneyData nullPovinné

Částka daně · Po slevách; Neznámé: null; známá nula: 0.

Příklad: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateŘetězec nullPovinné

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

Příklad: "0.23"

Další pole: Ne

Objednávka · Součty

OrderTotalsData · Částky a sazby pocházejí z uložené objednávky včetně oprav položek. Chybějící historické údaje jsou null a nenahrazují se aktuálními sazbami katalogu. Částky zůstávají desetinnými řetězci.
before_discountsOrderAmountBreakdownData Povinné

Objednávka · Před slevami · net / tax / gross.

Pří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é

Slevy · net / tax / gross.

Pří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 slevách · net / tax / gross.

Pří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 · Slevy · net / tax / gross.

Pří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 slevách · net / tax / gross.

Pří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 · Před slevami · net / tax / gross.

Pří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 slevách · net / tax / gross.

Pří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 · Před slevami · net / tax / gross.

Pří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 · Slevy · net / tax / gross.

Pří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}}

Další pole: Ne

Možnosti variant přiřazené produktu nebo uloženému záznamu

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Schéma · Datová schémata: Objednávky
nameŘetězecPovinné

Název zdroje v příslušném kontextu.

valueŘetězecPovinné

Hodnota popsaná okolním schématem.

Další pole: Ne

OrderDiscountData

OrderDiscountData · Pole, typy a omezení dat přijímaných nebo vracených API.
amountMoneyData Povinné

Částka s daní · Produkty · Slevy.

Příklad: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

Příklad: "saved-coupon"
codeŘetězec nullPovinné

Stabilní strojově čitelný kód.

Příklad: "SAVE"
kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["coupon", "promotion"]
Příklad: "coupon"
nameŘetězecPovinné

Název zdroje v příslušném kontextu.

Příklad: "Saved coupon"
sequenceCelé číslo nullVolitelné

Pořadí použití; null.

Příklad: 1
shipping_amountMoneyData nullVolitelné

Částka s daní · Doprava · Slevy; null.

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

Verze zdroje používaná k řízení souběžných změn.

Příklad: 3

Další pole: Ne

Platební údaje zaznamenané u objednávky

PaymentData · Schéma · Datová schémata: Objednávky
amountMoneyData Povinné

payment.amount je celková částka objednávky. Stav platby neurčuje zaplacené, vrácené ani dlužné částky.

Příklad: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentŘetězecPovinné

Informace o prostředí připojené k záznamu.

Omezení
enum
["live", "sandbox"]
Příklad: "live"
method_codeŘetězec nullPovinné

Kód způsobu doručení nebo platby.

Příklad: "payment-old"
method_nameŘetězec nullPovinné

Název způsobu doručení nebo platby.

Příklad: "Historic method"
paid_atŘetězec nullPovinné

Datum a čas označení platby jako zaplacené.

Řetězec:format: "date-time"
Příklad: null
statusOrderPaymentStatus Povinné

Stav přijímaný touto konkrétní operací.

Příklad: "unpaid"
updated_atŘetězecPovinné

Čas poslední aktualizace.

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

Verze zdroje používaná k řízení souběžných změn.

Příklad: 0

Další pole: Ne

Upravit · Stav platby — Objednávky — Tělo požadavku

PaymentStatusUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.
expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 0maximum: 9223372036854775807
Příklad: 1
reasonŘetězecPovinné

Důvod zaznamenaný u změny.

minLength: 1maxLength: 500
Příklad: "Example"
statusPaymentStatus Povinné

Stav přijímaný touto konkrétní operací.

Příklad: "paid"

Další pole: Ne

Stav přijímaný touto konkrétní operací

PaymentStatus · Schéma · Datová schémata: Objednávky Řetězec
Omezení
enum
["unpaid", "paid", "failed", "refunded"]

Další pole: Ano

PickupPointAddressData

PickupPointAddressData · Pole, typy a omezení dat přijímaných nebo vracených API.
address_line_1ŘetězecPovinné

První řádek adresy.

minLength: 1maxLength: 240
cityŘetězecPovinné

Město nebo obec.

minLength: 1maxLength: 160
postal_codeŘetězecPovinné

Poštovní směrovací číslo.

minLength: 1maxLength: 32

Další pole: Ne

PickupPointCoordinatesData

PickupPointCoordinatesData · Pole, typy a omezení dat přijímaných nebo vracených API.
latitudeČísloPovinné

WGS84 φ (°)

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

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Další pole: Ne

PickupPointData

PickupPointData · Pole, typy a omezení dat přijímaných nebo vracených API.
address_line1ŘetězecPovinné

První řádek adresy.

cityŘetězecPovinné

Město nebo obec.

codeŘetězecPovinné

Stabilní strojově čitelný kód.

country_codeŘetězecPovinné

Kód země.

kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

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

WGS84 φ (°)

location_descriptionŘetězec nullPovinné

Popis ve vybraném jazyce.

longitudeČíslo nullPovinné

WGS84 λ (°)

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

opening_hoursŘetězec nullPovinné

Opening hours

operatorŘetězecPovinné

Název zdroje v příslušném kontextu.

postal_codeŘetězecPovinné

Poštovní směrovací číslo.

Další pole: Ne

PickupPointSummaryData

PickupPointSummaryData · Pole, typy a omezení dat přijímaných nebo vracených API.
codeŘetězecPovinné

Stabilní strojově čitelný kód.

Omezení
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeŘetězecPovinné

Kód země.

Omezení
pattern
"^[A-Z]{2}$"
environmentŘetězecPovinné

Informace o prostředí připojené k záznamu.

Omezení
enum
["live", "sandbox"]
kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["locker", "pickup_point"]
operatorŘetězecPovinné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 63

Další pole: Ne

Údaje zákazníka zaznamenané u tohoto zdroje

RequestCustomerData · Schéma · Datová schémata: Objednávky
emailŘetězecPovinné

E-mailová adresa.

Příklad: "customer@example.invalid"
nameŘetězecPovinné

Název zdroje v příslušném kontextu.

Příklad: "Example"

Další pole: Ne

Způsob doručení a související údaje

ShippingData · Schéma · Datová schémata: Objednávky
amountMoneyData Povinné

Hrubá částka dopravy uložená v objednávce jako MoneyData. Pozdější změny daně tuto historickou částku nemění.

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

Data odeslání a doručení. Seznam i detail objednávky obsahují delivery.dates. Plánovaná data YYYY-MM-DD nepotvrzují odeslání. Aktuální data mají přednost; starší objednávky používají uložený odhad. Vymazané nebo neznámé hodnoty jsou null. Detail obsahuje také všechny položky a obrázky produktů.

Příklad: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
method_codeŘetězec nullPovinné

Kód způsobu doručení nebo platby.

Příklad: "shipping-old"
method_nameŘetězec nullPovinné

Název způsobu doručení nebo platby.

Příklad: "Historic carrier"
pickup_pointPickupPointSummaryData nullPovinné

Výdejní místo

Příklad: null
recipient_modeŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["full_address", "pickup_contact"]
Příklad: "full_address"

Další pole: Ne

ShippingDetailData

ShippingDetailData · Pole, typy a omezení dat přijímaných nebo vracených API.
amountMoneyData Povinné

Hrubá částka dopravy uložená v objednávce jako MoneyData. Pozdější změny daně tuto historickou částku nemění.

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

Data odeslání a doručení. Seznam i detail objednávky obsahují delivery.dates. Plánovaná data YYYY-MM-DD nepotvrzují odeslání. Aktuální data mají přednost; starší objednávky používají uložený odhad. Vymazané nebo neznámé hodnoty jsou null. Detail obsahuje také všechny položky a obrázky produktů.

Pří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é

Částka s daní · Slevy; Neznámé: null; známá nula: 0.

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

Částka bez daně · Slevy; Neznámé: null; známá nula: 0.

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

Částka daně · Slevy; Neznámé: null; známá nula: 0.

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

Doprava · Slevy; []: 0; null: Neznámé: null; známá nula: 0.

Pří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é

Částka s daní · Po slevách; Neznámé: null; známá nula: 0.

Příklad: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeŘetězec nullPovinné

Kód způsobu doručení nebo platby.

Příklad: "shipping-old"
method_nameŘetězec nullPovinné

Název způsobu doručení nebo platby.

Příklad: "Historic carrier"
netMoneyData nullPovinné

Částka bez daně · Po slevách; Neznámé: null; známá nula: 0.

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

Částka s daní · Doprava · Před slevami; Neznámé: null; známá nula: 0.

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

Částka bez daně · Doprava · Před slevami; Neznámé: null; známá nula: 0.

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

Částka daně · Doprava · Před slevami; Neznámé: null; známá nula: 0.

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

Výdejní místo

Příklad: null
recipient_modeŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["full_address", "pickup_contact"]
Příklad: "full_address"
taxMoneyData nullPovinné

Částka daně · Po slevách; Neznámé: null; známá nula: 0.

Příklad: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idŘetězec nullPovinné

Identifikátor daňové kategorie · Uložený snímek objednávky; null.

Příklad: "standard"
tax_category_nameŘetězec nullPovinné

Uložený název daňové kategorie; null.

Příklad: "VAT 23%"
tax_rateŘetězec nullPovinné

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

Příklad: "0.23"

Další pole: Ne