Preskoči na sadržaj
ShopentlyLearn

Sheme podataka: Narudžbe

Sheme podataka: Narudžbe. Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

Sheme podataka

Adresa dostave

AddressData · Shema · Sheme podataka: Narudžbe
address_line_1Niz znakova nullObvezno

Prvi redak adrese.

address_line_2Niz znakova nullObvezno

Dodatni podaci o adresi.

cityNiz znakova nullObvezno

Grad ili mjesto.

country_codeNiz znakova nullObvezno

Kod države.

first_nameNiz znakova nullObvezno

Ime.

house_numberNiz znakova nullObvezno

Broj zgrade ili kuće.

last_nameNiz znakova nullObvezno

Prezime.

phoneNiz znakova nullObvezno

Telefonski broj.

postal_codeNiz znakova nullObvezno

Poštanski broj.

regionNiz znakova nullObvezno

Upravna regija.

streetNiz znakova nullObvezno

Naziv ulice.

Dodatna polja: Ne

Popis — Narudžbe — Odgovor

ApiResponse_list_OrderSummaryData__ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
dataPolje vrijednosti <OrderSummaryData > Obvezno

Primjer odgovora · ApiResponse_list_OrderSummaryData__.

Primjer: [{"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 Obvezno

Metapodaci odgovora.

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

Dodatna polja: Ne

Dohvati — Narudžbe — Odgovor

ApiResponse_OrderDetailData_ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
dataOrderDetailData Obvezno

Primjer odgovora · OrderDetailData.

Primjer: {"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 Obvezno

Metapodaci odgovora.

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

Dodatna polja: Ne

Podaci kupca zabilježeni za ovaj resurs

CustomerData · Shema · Sheme podataka: Narudžbe
emailNiz znakovaObvezno

Adresa e-pošte.

Primjer: "customer@example.invalid"
first_nameNiz znakova nullObvezno

Ime.

Primjer: "Example"
last_nameNiz znakova nullObvezno

Prezime.

Primjer: "Example"
phoneNiz znakova nullObvezno

Telefonski broj.

Primjer: null

Dodatna polja: Ne

Datumi otpreme i dostave

DeliveryDatesData · Popis i pojedinosti narudžbe sadrže delivery.dates. Planirani datumi YYYY-MM-DD ne potvrđuju otpremu. Trenutačni datumi imaju prednost; starije narudžbe koriste spremljenu procjenu. Izbrisane ili nepoznate vrijednosti su null. Pojedinosti sadrže i sve stavke i slike proizvoda.
dispatch_timezoneNiz znakova nullObvezno

Vremenska zona otpreme (IANA; null).

Primjer: "Europe/Warsaw"
estimated_delivery_fromNiz znakova nullObvezno

Početak procijenjene dostave (YYYY-MM-DD; null).

Niz znakova:format: "date"
Primjer: "2026-10-20"
estimated_delivery_toNiz znakova nullObvezno

Kraj procijenjene dostave (YYYY-MM-DD; null).

Niz znakova:format: "date"
Primjer: "2026-10-21"
planned_dispatch_onNiz znakova nullObvezno

Planirani datum otpreme (YYYY-MM-DD; null).

Niz znakova:format: "date"
Primjer: "2026-10-19"

Dodatna polja: Ne

DeliveryPickupPointData

DeliveryPickupPointData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
addressPickupPointAddressData Obvezno

Adresa dostave.

codeNiz znakovaObvezno

Stabilan strojno čitljiv kod.

Ograničenja
pattern
"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesData nullObvezno

Vrijednost opisana okolnom shemom.

country_codeNiz znakovaObvezno

Kod države.

Ograničenja
pattern
"^[A-Z]{2}$"
environmentNiz znakovaObvezno

Podaci o okruženju pridruženi zapisu.

Ograničenja
enum
["live", "sandbox"]
kindNiz znakovaObvezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja
enum
["locker", "pickup_point"]
location_descriptionNiz znakova nullObvezno

Opis na odabranom jeziku.

Niz znakova:maxLength: 1000
nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160
opening_hoursNiz znakova nullObvezno

Opening hours

Niz znakova:maxLength: 500
operatorNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 63
verified_atNiz znakovaObvezno

Vrijeme posljednjeg ažuriranja.

format: "date-time"

Dodatna polja: Ne

Podaci računa

InvoiceData · Shema · Sheme podataka: Narudžbe
address_line_1Niz znakova nullObvezno

Prvi redak adrese.

address_line_2Niz znakova nullObvezno

Dodatni podaci o adresi.

cityNiz znakova nullObvezno

Grad ili mjesto.

company_nameNiz znakova nullObvezno

Naziv tvrtke.

country_codeNiz znakova nullObvezno

Kod države.

house_numberNiz znakova nullObvezno

Broj zgrade ili kuće.

postal_codeNiz znakova nullObvezno

Poštanski broj.

regionNiz znakova nullObvezno

Upravna regija.

streetNiz znakova nullObvezno

Naziv ulice.

tax_identifierNiz znakova nullObvezno

Porezni identifikacijski broj.

tax_schemeNiz znakova nullObvezno

Shema izračuna poreza.

Dodatna polja: Ne

Neto iznos / Iznos poreza / Bruto iznos

OrderAmountBreakdownData · Iznosi i stope dolaze iz spremljene narudžbe, uključujući ispravke stavki. Nepoznati povijesni podaci su null i ne zamjenjuju se trenutačnim stopama iz kataloga. Iznosi ostaju decimalni nizovi.
grossMoneyData Obvezno

Bruto iznos · Nakon popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullObvezno

Neto iznos · Nakon popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullObvezno

Iznos poreza · Nakon popusta; Nepoznato: null; poznata nula: 0.

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

Dodatna polja: Ne

Dostava · Popusti

OrderDeliveryDiscountData · Iznosi i stope dolaze iz spremljene narudžbe, uključujući ispravke stavki. Nepoznati povijesni podaci su null i ne zamjenjuju se trenutačnim stopama iz kataloga. Iznosi ostaju decimalni nizovi.
amountMoneyData Obvezno

Bruto iznos · Dostava · Popusti.

Primjer: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku.

Primjer: "saved-coupon"
codeNiz znakova nullObvezno

Stabilan strojno čitljiv kod.

Primjer: "SAVE"
kindNiz znakovaObvezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja
enum
["coupon", "promotion"]
Primjer: "coupon"
nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Saved coupon"
sequenceCijeli broj nullObvezno

Položaj u uređenoj zbirci.

Primjer: 1
versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

Primjer: 3

Dodatna polja: Ne

Dohvati — Narudžbe — Odgovor

OrderDetailData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
created_atNiz znakovaObvezno

Vrijeme izrade.

format: "date-time"
Primjer: "2026-10-19T10:00:00Z"
customerCustomerData Obvezno

Podaci kupca zabilježeni za ovaj resurs.

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

Način dostave i povezani podaci.

Primjer: {"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 Obvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

Primjer: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsPolje vrijednosti <OrderDiscountData > Obvezno

Popusti

Primjer: [{"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}]
idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (OrderDetailData).

Primjer: "order-0000"
invoiceInvoiceData nullObvezno

Podaci računa.

Primjer: null
invoice_requestedLogička vrijednostObvezno

Je li zatražen račun.

Primjer: false
lifecycle_stateOrderLifecycleState Obvezno

Stanje poslovnog životnog ciklusa.

Primjer: "placed"
linesPolje vrijednosti <OrderLineData > Obvezno

Snimke stanja stavki narudžbe.

Primjer: [{"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":[]}]
localeNiz znakovaObvezno

Jezik odabran za ovaj zahtjev.

Primjer: "pl"
market_idNiz znakovaObvezno

Identifikator tržišta vraćen s krajnje točke konteksta.

Primjer: "market-pl"
numberNiz znakovaObvezno

Broj narudžbe ili zahtjeva namijenjen korisniku.

Primjer: "0001"
paymentPaymentData Obvezno

Podaci o plaćanju zabilježeni za narudžbu.

Primjer: {"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 nullObvezno

Mjesto preuzimanja

Primjer: null
prices_include_taxLogička vrijednostObvezno

Uključuju li navedene cijene porez.

Primjer: true
shipping_addressAddressData nullObvezno

Adresa dostave.

Primjer: null
shipping_discount_amountMoneyData Obvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

Primjer: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obvezno

Status prihvaćen za ovu određenu operaciju.

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

Iznos prije dodatnih sastavnica prikazanih u odgovoru.

Primjer: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obvezno

Porezni podaci.

Primjer: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Obvezno

Porezne skupine · source + tax_rate; unallocated_tax.

Primjer: {"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_codeNiz znakova nullObvezno

Porezna država · Spremljeni podaci narudžbe · ISO 3166-1 alpha-2; null.

Primjer: "PL"
totalMoneyData Obvezno

Ukupan iznos.

Primjer: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Obvezno

Ukupni iznosi · net / tax / gross; Prije popusta / Nakon popusta.

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

Dodatna polja: Ne

Metapodaci i URL slike

OrderImageData · Shema · Sheme podataka: Narudžbe
altNiz znakova nullObvezno

Zamjenski tekst slike.

sourceNiz znakovaNeobavezno

Izvor zabilježene aktivnosti.

const: "current_catalog"
Zadano: "current_catalog"
urlNiz znakovaObvezno

URL resursa.

Dodatna polja: Ne

Stanje poslovnog životnog ciklusa

OrderLifecycleState · Shema · Sheme podataka: Narudžbe
Niz znakova
Ograničenja
enum
["placed", "cancelled", "fulfilled", "returned"]

Dodatna polja: Da

Snimke stanja stavki narudžbe

OrderLineData · Shema · Sheme podataka: Narudžbe
discount_amountMoneyData Obvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

Primjer: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Obvezno

Bruto iznos · Popusti; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObvezno

Neto iznos · Popusti; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObvezno

Iznos poreza · Popusti; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsPolje vrijednosti <OrderDiscountData > Obvezno

Popusti · net / tax / gross.

Primjer: [{"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}]
identifiersObjektDodatna polja: Niz znakovaObvezno

Identifikacijski kodovi proizvoda.

Primjer: {}
imageOrderImageData nullObvezno

Metapodaci i URL slike.

Primjer: null
line_idNiz znakovaObvezno

Stalni identifikator stavke narudžbe.

Primjer: "saved-line-a"
manual_discountOrderManualDiscountData nullObvezno

Ručni popust; null.

Primjer: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Saved A"
original_totalMoneyData Obvezno

Ukupan iznos.

Primjer: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Obvezno

Bruto iznos · Proizvodi · Prije popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullObvezno

Neto iznos · Proizvodi · Prije popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullObvezno

Iznos poreza · Proizvodi · Prije popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"46.00","currency":"PLN","minor_units":2}
positionCijeli brojObvezno

Položaj u uređenoj zbirci.

Primjer: 1
product_idNiz znakovaObvezno

Identifikator proizvoda.

Primjer: "product-api"
quantityCijeli brojObvezno

Broj jedinica.

Primjer: 2
skuNiz znakovaObvezno

Šifra skladišne jedinice.

Primjer: "A"
taxMoneyData nullObvezno

Iznos poreza · Jedna jedinica · Spremljeni podaci narudžbe; tax ≠ unit_tax; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idNiz znakova nullObvezno

Identifikator porezne kategorije · Spremljeni podaci narudžbe; null.

Primjer: "standard"
tax_category_nameNiz znakova nullObvezno

Spremljeni naziv porezne kategorije; null.

Primjer: "VAT 23%"
tax_rateNiz znakova nullObvezno

tax_rate · Spremljeni podaci narudžbe: "0.23" = 23%; "0" ≠ null.

Primjer: "0.23"
totalMoneyData Obvezno

Ukupan iznos.

Primjer: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Obvezno

Bruto iznos · Proizvodi · Nakon popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullObvezno

Neto iznos · Proizvodi · Nakon popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullObvezno

Iznos poreza · Proizvodi · Nakon popusta · Spremljeni podaci narudžbe; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Obvezno

Bruto iznos · Jedna jedinica · Prije popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullObvezno

Neto iznos · Jedna jedinica · Prije popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obvezno

Cijena jedne jedinice.

Primjer: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullObvezno

Iznos poreza · Jedna jedinica · Prije popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idNiz znakova nullObvezno

Identifikator varijante proizvoda.

Primjer: null
variant_optionsPolje vrijednosti <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Obvezno

Opcije varijante povezane s proizvodom ili snimkom stanja.

Primjer: []

Dodatna polja: Ne

Ručni popust

OrderManualDiscountData · Iznosi i stope dolaze iz spremljene narudžbe, uključujući ispravke stavki. Nepoznati povijesni podaci su null i ne zamjenjuju se trenutačnim stopama iz kataloga. Iznosi ostaju decimalni nizovi.
amountMoneyData Obvezno

Bruto iznos · Ručni popust · Spremljeni podaci narudžbe.

Primjer: {"amount":"12.30","currency":"PLN","minor_units":2}
kindNiz znakovaObvezno

Vrsta popusta: percentage / fixed.

Ograničenja
enum
["percentage", "fixed"]
Primjer: "fixed"
valueNiz znakovaObvezno

Postavljena vrijednost: percentage "10" = 10%; fixed = Bruto iznos.

Primjer: "12.30"

Dodatna polja: Ne

Status prihvaćen za ovu određenu operaciju

OrderPaymentStatus · Shema · Sheme podataka: Narudžbe
Niz znakova
Ograničenja
enum
["unpaid", "paid", "failed", "refunded"]

Dodatna polja: Da

Status prihvaćen za ovu određenu operaciju

OrderStatusData · Shema · Sheme podataka: Narudžbe
idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (OrderStatusData).

Primjer: "status-0"
nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Status 0"
updated_atNiz znakovaObvezno

Vrijeme posljednjeg ažuriranja.

format: "date-time"
Primjer: "2026-10-19T10:00:00Z"
versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

Primjer: 1

Dodatna polja: Ne

Popis · Statusi — Narudžbe — Odgovor

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
created_atNiz znakovaObvezno

Vrijeme izrade.

format: "date-time"
Primjer: "2026-01-01T12:00:00Z"
idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Primjer: "example"
is_initialLogička vrijednostObvezno

Je li ovo početni status.

Primjer: false
nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Example"
positionCijeli brojObvezno

Položaj u uređenoj zbirci.

Primjer: 1

Dodatna polja: Ne

Popis · Statusi — Narudžbe — Odgovor

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
dataPolje vrijednosti <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Obvezno

Primjer odgovora · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Primjer: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obvezno

Metapodaci odgovora.

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

Dodatna polja: Ne

Ažuriraj · Status — Narudžbe — Tijelo zahtjeva

OrderStatusUpdate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
expected_versionCijeli brojObvezno

Verzija pročitana prije upisa; nepodudaranje odbija ažuriranje.

minimum: 1maximum: 9223372036854775807
Primjer: 1
status_idNiz znakovaObvezno

Identifikator dobiven iz odgovarajućeg šifrarnika statusa.

Ograničenja
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primjer: "example"

Dodatna polja: Ne

Popis — Narudžbe — Odgovor

OrderSummaryData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
created_atNiz znakovaObvezno

Vrijeme izrade.

format: "date-time"
Primjer: "2026-10-19T10:00:00Z"
customerCustomerData Obvezno

Podaci kupca zabilježeni za ovaj resurs.

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

Način dostave i povezani podaci.

Primjer: {"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 Obvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

Primjer: {"amount":"24.60","currency":"PLN","minor_units":2}
idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (OrderSummaryData).

Primjer: "order-0000"
lifecycle_stateOrderLifecycleState Obvezno

Stanje poslovnog životnog ciklusa.

Primjer: "placed"
localeNiz znakovaObvezno

Jezik odabran za ovaj zahtjev.

Primjer: "pl"
market_idNiz znakovaObvezno

Identifikator tržišta vraćen s krajnje točke konteksta.

Primjer: "market-pl"
numberNiz znakovaObvezno

Broj narudžbe ili zahtjeva namijenjen korisniku.

Primjer: "0001"
paymentPaymentData Obvezno

Podaci o plaćanju zabilježeni za narudžbu.

Primjer: {"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_taxLogička vrijednostObvezno

Uključuju li navedene cijene porez.

Primjer: true
shipping_discount_amountMoneyData Obvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

Primjer: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obvezno

Status prihvaćen za ovu određenu operaciju.

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

Iznos prije dodatnih sastavnica prikazanih u odgovoru.

Primjer: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obvezno

Porezni podaci.

Primjer: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeNiz znakova nullObvezno

Porezna država · Spremljeni podaci narudžbe · ISO 3166-1 alpha-2; null.

Primjer: "PL"
totalMoneyData Obvezno

Ukupan iznos.

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

Dodatna polja: Ne

Narudžba · Porezne skupine

OrderTaxBreakdownData · Iznosi i stope dolaze iz spremljene narudžbe, uključujući ispravke stavki. Nepoznati povijesni podaci su null i ne zamjenjuju se trenutačnim stopama iz kataloga. Iznosi ostaju decimalni nizovi.
groupsPolje vrijednosti <OrderTaxGroupData > Obvezno

Porezne skupine · source + tax_rate; Nepoznato: null; poznata nula: 0.

Primjer: [{"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 Obvezno

Neraspoređeni porez = order.tax − Σ groups.tax; ±.

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

Dodatna polja: Ne

Porezne skupine

OrderTaxGroupData · Iznosi i stope dolaze iz spremljene narudžbe, uključujući ispravke stavki. Nepoznati povijesni podaci su null i ne zamjenjuju se trenutačnim stopama iz kataloga. Iznosi ostaju decimalni nizovi.
grossMoneyData Obvezno

Bruto iznos · Nakon popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullObvezno

Neto iznos · Nakon popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceNiz znakovaObvezno

Izvor: products (Proizvodi), shipping (Dostava).

Ograničenja
enum
["products", "shipping"]
Primjer: "products"
taxMoneyData nullObvezno

Iznos poreza · Nakon popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateNiz znakova nullObvezno

tax_rate · Spremljeni podaci narudžbe: "0.23" = 23%; "0" ≠ null.

Primjer: "0.23"

Dodatna polja: Ne

Narudžba · Ukupni iznosi

OrderTotalsData · Iznosi i stope dolaze iz spremljene narudžbe, uključujući ispravke stavki. Nepoznati povijesni podaci su null i ne zamjenjuju se trenutačnim stopama iz kataloga. Iznosi ostaju decimalni nizovi.
before_discountsOrderAmountBreakdownData Obvezno

Narudžba · Prije popusta · net / tax / gross.

Primjer: {"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 Obvezno

Popusti · net / tax / gross.

Primjer: {"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 Obvezno

Narudžba · Nakon popusta · net / tax / gross.

Primjer: {"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 Obvezno

Proizvodi · Popusti · net / tax / gross.

Primjer: {"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 Obvezno

Proizvodi · Nakon popusta · net / tax / gross.

Primjer: {"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 Obvezno

Proizvodi · Prije popusta · net / tax / gross.

Primjer: {"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 Obvezno

Dostava · Nakon popusta · net / tax / gross.

Primjer: {"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 Obvezno

Dostava · Prije popusta · net / tax / gross.

Primjer: {"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 Obvezno

Dostava · Popusti · net / tax / gross.

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

Dodatna polja: Ne

Opcije varijante povezane s proizvodom ili snimkom stanja

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Shema · Sheme podataka: Narudžbe
nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

valueNiz znakovaObvezno

Vrijednost opisana okolnom shemom.

Dodatna polja: Ne

OrderDiscountData

OrderDiscountData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
amountMoneyData Obvezno

Bruto iznos · Proizvodi · Popusti.

Primjer: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku.

Primjer: "saved-coupon"
codeNiz znakova nullObvezno

Stabilan strojno čitljiv kod.

Primjer: "SAVE"
kindNiz znakovaObvezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja
enum
["coupon", "promotion"]
Primjer: "coupon"
nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Saved coupon"
sequenceCijeli broj nullNeobavezno

Redoslijed primjene; null.

Primjer: 1
shipping_amountMoneyData nullNeobavezno

Bruto iznos · Dostava · Popusti; null.

Primjer: {"amount":"24.60","currency":"PLN","minor_units":2}
versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

Primjer: 3

Dodatna polja: Ne

Podaci o plaćanju zabilježeni za narudžbu

PaymentData · Shema · Sheme podataka: Narudžbe
amountMoneyData Obvezno

payment.amount je ukupni iznos narudžbe. Status plaćanja ne određuje plaćene, vraćene ili nepodmirene iznose.

Primjer: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentNiz znakovaObvezno

Podaci o okruženju pridruženi zapisu.

Ograničenja
enum
["live", "sandbox"]
Primjer: "live"
method_codeNiz znakova nullObvezno

Kod načina dostave ili plaćanja.

Primjer: "payment-old"
method_nameNiz znakova nullObvezno

Naziv načina dostave ili plaćanja.

Primjer: "Historic method"
paid_atNiz znakova nullObvezno

Datum i vrijeme kada je plaćanje označeno kao plaćeno.

Niz znakova:format: "date-time"
Primjer: null
statusOrderPaymentStatus Obvezno

Status prihvaćen za ovu određenu operaciju.

Primjer: "unpaid"
updated_atNiz znakovaObvezno

Vrijeme posljednjeg ažuriranja.

format: "date-time"
Primjer: "2026-10-19T10:00:00Z"
versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

Primjer: 0

Dodatna polja: Ne

Ažuriraj · Status plaćanja — Narudžbe — Tijelo zahtjeva

PaymentStatusUpdate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
expected_versionCijeli brojObvezno

Verzija pročitana prije upisa; nepodudaranje odbija ažuriranje.

minimum: 0maximum: 9223372036854775807
Primjer: 1
reasonNiz znakovaObvezno

Razlog zabilježen za promjenu.

minLength: 1maxLength: 500
Primjer: "Example"
statusPaymentStatus Obvezno

Status prihvaćen za ovu određenu operaciju.

Primjer: "paid"

Dodatna polja: Ne

Status prihvaćen za ovu određenu operaciju

PaymentStatus · Shema · Sheme podataka: Narudžbe
Niz znakova
Ograničenja
enum
["unpaid", "paid", "failed", "refunded"]

Dodatna polja: Da

PickupPointAddressData

PickupPointAddressData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
address_line_1Niz znakovaObvezno

Prvi redak adrese.

minLength: 1maxLength: 240
cityNiz znakovaObvezno

Grad ili mjesto.

minLength: 1maxLength: 160
postal_codeNiz znakovaObvezno

Poštanski broj.

minLength: 1maxLength: 32

Dodatna polja: Ne

PickupPointCoordinatesData

PickupPointCoordinatesData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
latitudeBrojObvezno

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeBrojObvezno

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Dodatna polja: Ne

PickupPointData

PickupPointData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
address_line1Niz znakovaObvezno

Prvi redak adrese.

cityNiz znakovaObvezno

Grad ili mjesto.

codeNiz znakovaObvezno

Stabilan strojno čitljiv kod.

country_codeNiz znakovaObvezno

Kod države.

kindNiz znakovaObvezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja
enum
["locker", "pickup_point"]
latitudeBroj nullObvezno

WGS84 φ (°)

location_descriptionNiz znakova nullObvezno

Opis na odabranom jeziku.

longitudeBroj nullObvezno

WGS84 λ (°)

nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

opening_hoursNiz znakova nullObvezno

Opening hours

operatorNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

postal_codeNiz znakovaObvezno

Poštanski broj.

Dodatna polja: Ne

PickupPointSummaryData

PickupPointSummaryData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
codeNiz znakovaObvezno

Stabilan strojno čitljiv kod.

Ograničenja
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeNiz znakovaObvezno

Kod države.

Ograničenja
pattern
"^[A-Z]{2}$"
environmentNiz znakovaObvezno

Podaci o okruženju pridruženi zapisu.

Ograničenja
enum
["live", "sandbox"]
kindNiz znakovaObvezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja
enum
["locker", "pickup_point"]
operatorNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 63

Dodatna polja: Ne

Podaci kupca zabilježeni za ovaj resurs

RequestCustomerData · Shema · Sheme podataka: Narudžbe
emailNiz znakovaObvezno

Adresa e-pošte.

Primjer: "customer@example.invalid"
nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Example"

Dodatna polja: Ne

Način dostave i povezani podaci

ShippingData · Shema · Sheme podataka: Narudžbe
amountMoneyData Obvezno

Bruto iznos dostave spremljen u narudžbi kao MoneyData. Naknadne promjene poreza ne mijenjaju taj povijesni iznos.

Primjer: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Obvezno

Datumi otpreme i dostave. Popis i pojedinosti narudžbe sadrže delivery.dates. Planirani datumi YYYY-MM-DD ne potvrđuju otpremu. Trenutačni datumi imaju prednost; starije narudžbe koriste spremljenu procjenu. Izbrisane ili nepoznate vrijednosti su null. Pojedinosti sadrže i sve stavke i slike proizvoda.

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

Kod načina dostave ili plaćanja.

Primjer: "shipping-old"
method_nameNiz znakova nullObvezno

Naziv načina dostave ili plaćanja.

Primjer: "Historic carrier"
pickup_pointPickupPointSummaryData nullObvezno

Mjesto preuzimanja

Primjer: null
recipient_modeNiz znakovaObvezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja
enum
["full_address", "pickup_contact"]
Primjer: "full_address"

Dodatna polja: Ne

ShippingDetailData

ShippingDetailData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
amountMoneyData Obvezno

Bruto iznos dostave spremljen u narudžbi kao MoneyData. Naknadne promjene poreza ne mijenjaju taj povijesni iznos.

Primjer: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Obvezno

Datumi otpreme i dostave. Popis i pojedinosti narudžbe sadrže delivery.dates. Planirani datumi YYYY-MM-DD ne potvrđuju otpremu. Trenutačni datumi imaju prednost; starije narudžbe koriste spremljenu procjenu. Izbrisane ili nepoznate vrijednosti su null. Pojedinosti sadrže i sve stavke i slike proizvoda.

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

Bruto iznos · Popusti; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObvezno

Neto iznos · Popusti; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObvezno

Iznos poreza · Popusti; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsPolje vrijednosti <OrderDeliveryDiscountData > nullObvezno

Dostava · Popusti; []: 0; null: Nepoznato: null; poznata nula: 0.

Primjer: [{"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 Obvezno

Bruto iznos · Nakon popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeNiz znakova nullObvezno

Kod načina dostave ili plaćanja.

Primjer: "shipping-old"
method_nameNiz znakova nullObvezno

Naziv načina dostave ili plaćanja.

Primjer: "Historic carrier"
netMoneyData nullObvezno

Neto iznos · Nakon popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Obvezno

Bruto iznos · Dostava · Prije popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullObvezno

Neto iznos · Dostava · Prije popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullObvezno

Iznos poreza · Dostava · Prije popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullObvezno

Mjesto preuzimanja

Primjer: null
recipient_modeNiz znakovaObvezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja
enum
["full_address", "pickup_contact"]
Primjer: "full_address"
taxMoneyData nullObvezno

Iznos poreza · Nakon popusta; Nepoznato: null; poznata nula: 0.

Primjer: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idNiz znakova nullObvezno

Identifikator porezne kategorije · Spremljeni podaci narudžbe; null.

Primjer: "standard"
tax_category_nameNiz znakova nullObvezno

Spremljeni naziv porezne kategorije; null.

Primjer: "VAT 23%"
tax_rateNiz znakova nullObvezno

tax_rate · Spremljeni podaci narudžbe: "0.23" = 23%; "0" ≠ null.

Primjer: "0.23"

Dodatna polja: Ne