Preskoči na vsebino
ShopentlyLearn

Podatkovne sheme: Naročila

Podatkovne sheme: Naročila. Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

Podatkovne sheme

Naslov za dostavo

AddressData · Shema · Podatkovne sheme: Naročila
address_line_1Niz nullObvezno

Prva vrstica naslova.

address_line_2Niz nullObvezno

Dodatni podatki naslova.

cityNiz nullObvezno

Mesto ali kraj.

country_codeNiz nullObvezno

Koda države.

first_nameNiz nullObvezno

Ime.

house_numberNiz nullObvezno

Številka stavbe ali hiše.

last_nameNiz nullObvezno

Priimek.

phoneNiz nullObvezno

Telefonska številka.

postal_codeNiz nullObvezno

Poštna številka.

regionNiz nullObvezno

Upravna regija.

streetNiz nullObvezno

Ime ulice.

Dodatna polja: Ne

Prikaži seznam — Naročila — Odgovor

ApiResponse_list_OrderSummaryData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataPolje elementov <OrderSummaryData > Obvezno

Primer odgovora · ApiResponse_list_OrderSummaryData__.

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

Metapodatki odgovora.

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

Dodatna polja: Ne

Pridobi — Naročila — Odgovor

ApiResponse_OrderDetailData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataOrderDetailData Obvezno

Primer odgovora · OrderDetailData.

Primer: {"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

Metapodatki odgovora.

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

Dodatna polja: Ne

Podatki stranke, zabeleženi za ta vir

CustomerData · Shema · Podatkovne sheme: Naročila
emailNizObvezno

E-poštni naslov.

Primer: "customer@example.invalid"
first_nameNiz nullObvezno

Ime.

Primer: "Example"
last_nameNiz nullObvezno

Priimek.

Primer: "Example"
phoneNiz nullObvezno

Telefonska številka.

Primer: null

Dodatna polja: Ne

Datumi odpreme in dostave

DeliveryDatesData · Seznam in podrobnosti naročila vsebujejo delivery.dates. Načrtovani datumi YYYY-MM-DD ne potrjujejo odpreme. Trenutni datumi imajo prednost; starejša naročila uporabljajo shranjeno oceno. Izbrisane ali neznane vrednosti so null. Podrobnosti vsebujejo tudi vse postavke in slike izdelkov.
dispatch_timezoneNiz nullObvezno

Časovni pas odpreme (IANA; null).

Primer: "Europe/Warsaw"
estimated_delivery_fromNiz nullObvezno

Začetek predvidene dostave (YYYY-MM-DD; null).

Niz:format: "date"
Primer: "2026-10-20"
estimated_delivery_toNiz nullObvezno

Konec predvidene dostave (YYYY-MM-DD; null).

Niz:format: "date"
Primer: "2026-10-21"
planned_dispatch_onNiz nullObvezno

Načrtovani datum odpreme (YYYY-MM-DD; null).

Niz:format: "date"
Primer: "2026-10-19"

Dodatna polja: Ne

DeliveryPickupPointData

DeliveryPickupPointData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
addressPickupPointAddressData Obvezno

Naslov za dostavo.

codeNizObvezno

Stabilna strojno berljiva koda.

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

Vrednost, opisana z okoliško shemo.

country_codeNizObvezno

Koda države.

Omejitve
pattern
"^[A-Z]{2}$"
environmentNizObvezno

Podatki o okolju, dodani zapisu.

Omejitve
enum
["live", "sandbox"]
kindNizObvezno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["locker", "pickup_point"]
location_descriptionNiz nullObvezno

Opis v izbranem jeziku.

Niz:maxLength: 1000
nameNizObvezno

Ime vira v ustreznem kontekstu.

minLength: 1maxLength: 160
opening_hoursNiz nullObvezno

Opening hours

Niz:maxLength: 500
operatorNizObvezno

Ime vira v ustreznem kontekstu.

minLength: 1maxLength: 63
verified_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"

Dodatna polja: Ne

Podatki računa

InvoiceData · Shema · Podatkovne sheme: Naročila
address_line_1Niz nullObvezno

Prva vrstica naslova.

address_line_2Niz nullObvezno

Dodatni podatki naslova.

cityNiz nullObvezno

Mesto ali kraj.

company_nameNiz nullObvezno

Ime podjetja.

country_codeNiz nullObvezno

Koda države.

house_numberNiz nullObvezno

Številka stavbe ali hiše.

postal_codeNiz nullObvezno

Poštna številka.

regionNiz nullObvezno

Upravna regija.

streetNiz nullObvezno

Ime ulice.

tax_identifierNiz nullObvezno

Davčna identifikacijska številka.

tax_schemeNiz nullObvezno

Način izračuna davka.

Dodatna polja: Ne

Neto znesek / Znesek davka / Bruto znesek

OrderAmountBreakdownData · Zneski in stopnje izvirajo iz shranjenega naročila, vključno s popravki postavk. Manjkajoči pretekli podatki so null in se ne nadomestijo s trenutnimi stopnjami kataloga. Zneski ostanejo decimalni nizi.
grossMoneyData Obvezno

Bruto znesek · Po popustih; Neznano: null; znana ničla: 0.

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

Neto znesek · Po popustih; Neznano: null; znana ničla: 0.

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

Znesek davka · Po popustih; Neznano: null; znana ničla: 0.

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

Dodatna polja: Ne

Dostava · Popusti

OrderDeliveryDiscountData · Zneski in stopnje izvirajo iz shranjenega naročila, vključno s popravki postavk. Manjkajoči pretekli podatki so null in se ne nadomestijo s trenutnimi stopnjami kataloga. Zneski ostanejo decimalni nizi.
amountMoneyData Obvezno

Bruto znesek · Dostava · Popusti.

Primer: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki.

Primer: "saved-coupon"
codeNiz nullObvezno

Stabilna strojno berljiva koda.

Primer: "SAVE"
kindNizObvezno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["coupon", "promotion"]
Primer: "coupon"
nameNizObvezno

Ime vira v ustreznem kontekstu.

Primer: "Saved coupon"
sequenceCelo število nullObvezno

Položaj v urejeni zbirki.

Primer: 1
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 3

Dodatna polja: Ne

Pridobi — Naročila — Odgovor

OrderDetailData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
created_atNizObvezno

Čas nastanka.

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

Podatki stranke, zabeleženi za ta vir.

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

Način dostave in povezani podatki.

Primer: {"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 znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

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

Popusti

Primer: [{"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}]
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (OrderDetailData).

Primer: "order-0000"
invoiceInvoiceData nullObvezno

Podatki računa.

Primer: null
invoice_requestedLogična vrednostObvezno

Ali je bil zahtevan račun.

Primer: false
lifecycle_stateOrderLifecycleState Obvezno

Stanje poslovnega življenjskega cikla.

Primer: "placed"
linesPolje elementov <OrderLineData > Obvezno

Posnetki postavk naročila.

Primer: [{"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":[]}]
localeNizObvezno

Jezik, izbran za to zahtevo.

Primer: "pl"
market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

Primer: "market-pl"
numberNizObvezno

Uporabniku prikazana številka naročila ali zahtevka.

Primer: "0001"
paymentPaymentData Obvezno

Podrobnosti plačila, zabeležene za naročilo.

Primer: {"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

Prevzemno mesto

Primer: null
prices_include_taxLogična vrednostObvezno

Ali navedene cene vključujejo davek.

Primer: true
shipping_addressAddressData nullObvezno

Naslov za dostavo.

Primer: null
shipping_discount_amountMoneyData Obvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

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

Status, ki ga sprejema ta operacija.

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

Znesek pred dodatnimi postavkami, prikazanimi v odgovoru.

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

Davčni podatki.

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

Davčne skupine · source + tax_rate; unallocated_tax.

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

Davčna država · Shranjeni podatki naročila · ISO 3166-1 alpha-2; null.

Primer: "PL"
totalMoneyData Obvezno

Skupni znesek.

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

Skupni zneski · net / tax / gross; Pred popusti / Po popustih.

Primer: {"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

Metapodatki in URL slike

OrderImageData · Shema · Podatkovne sheme: Naročila
altNiz nullObvezno

Nadomestno besedilo slike.

sourceNizIzbirno

Vir zabeležene dejavnosti.

const: "current_catalog"
Privzeto: "current_catalog"
urlNizObvezno

URL vira.

Dodatna polja: Ne

Stanje poslovnega življenjskega cikla

OrderLifecycleState · Shema · Podatkovne sheme: Naročila
Niz
Omejitve
enum
["placed", "cancelled", "fulfilled", "returned"]

Dodatna polja: Da

Posnetki postavk naročila

OrderLineData · Shema · Podatkovne sheme: Naročila
discount_amountMoneyData Obvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

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

Bruto znesek · Popusti; Neznano: null; znana ničla: 0.

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

Neto znesek · Popusti; Neznano: null; znana ničla: 0.

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

Znesek davka · Popusti; Neznano: null; znana ničla: 0.

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

Popusti · net / tax / gross.

Primer: [{"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: NizObvezno

Identifikacijske kode izdelka.

Primer: {}
imageOrderImageData nullObvezno

Metapodatki in URL slike.

Primer: null
line_idNizObvezno

Stalni identifikator postavke naročila.

Primer: "saved-line-a"
manual_discountOrderManualDiscountData nullObvezno

Ročni popust; null.

Primer: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameNizObvezno

Ime vira v ustreznem kontekstu.

Primer: "Saved A"
original_totalMoneyData Obvezno

Skupni znesek.

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

Bruto znesek · Izdelki · Pred popusti; Neznano: null; znana ničla: 0.

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

Neto znesek · Izdelki · Pred popusti; Neznano: null; znana ničla: 0.

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

Znesek davka · Izdelki · Pred popusti; Neznano: null; znana ničla: 0.

Primer: {"amount":"46.00","currency":"PLN","minor_units":2}
positionCelo številoObvezno

Položaj v urejeni zbirki.

Primer: 1
product_idNizObvezno

Identifikator izdelka.

Primer: "product-api"
quantityCelo številoObvezno

Število enot.

Primer: 2
skuNizObvezno

Koda enote za vodenje zaloge.

Primer: "A"
taxMoneyData nullObvezno

Znesek davka · Ena enota · Shranjeni podatki naročila; tax ≠ unit_tax; Neznano: null; znana ničla: 0.

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

Identifikator davčne kategorije · Shranjeni podatki naročila; null.

Primer: "standard"
tax_category_nameNiz nullObvezno

Shranjeno ime davčne kategorije; null.

Primer: "VAT 23%"
tax_rateNiz nullObvezno

tax_rate · Shranjeni podatki naročila: "0.23" = 23%; "0" ≠ null.

Primer: "0.23"
totalMoneyData Obvezno

Skupni znesek.

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

Bruto znesek · Izdelki · Po popustih; Neznano: null; znana ničla: 0.

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

Neto znesek · Izdelki · Po popustih; Neznano: null; znana ničla: 0.

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

Znesek davka · Izdelki · Po popustih · Shranjeni podatki naročila; Neznano: null; znana ničla: 0.

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

Bruto znesek · Ena enota · Pred popusti; Neznano: null; znana ničla: 0.

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

Neto znesek · Ena enota · Pred popusti; Neznano: null; znana ničla: 0.

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

Cena ene enote.

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

Znesek davka · Ena enota · Pred popusti; Neznano: null; znana ničla: 0.

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

Identifikator različice izdelka.

Primer: null
variant_optionsPolje elementov <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Obvezno

Možnosti različic, povezane z izdelkom ali posnetkom.

Primer: []

Dodatna polja: Ne

Ročni popust

OrderManualDiscountData · Zneski in stopnje izvirajo iz shranjenega naročila, vključno s popravki postavk. Manjkajoči pretekli podatki so null in se ne nadomestijo s trenutnimi stopnjami kataloga. Zneski ostanejo decimalni nizi.
amountMoneyData Obvezno

Bruto znesek · Ročni popust · Shranjeni podatki naročila.

Primer: {"amount":"12.30","currency":"PLN","minor_units":2}
kindNizObvezno

Vrsta popusta: percentage / fixed.

Omejitve
enum
["percentage", "fixed"]
Primer: "fixed"
valueNizObvezno

Nastavljena vrednost: percentage "10" = 10%; fixed = Bruto znesek.

Primer: "12.30"

Dodatna polja: Ne

Status, ki ga sprejema ta operacija

OrderPaymentStatus · Shema · Podatkovne sheme: Naročila
Niz
Omejitve
enum
["unpaid", "paid", "failed", "refunded"]

Dodatna polja: Da

Status, ki ga sprejema ta operacija

OrderStatusData · Shema · Podatkovne sheme: Naročila
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (OrderStatusData).

Primer: "status-0"
nameNizObvezno

Ime vira v ustreznem kontekstu.

Primer: "Status 0"
updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"
Primer: "2026-10-19T10:00:00Z"
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Prikaži seznam · Statusi — Naročila — Odgovor

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
created_atNizObvezno

Čas nastanka.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Primer: "example"
is_initialLogična vrednostObvezno

Ali je to začetni status.

Primer: false
nameNizObvezno

Ime vira v ustreznem kontekstu.

Primer: "Example"
positionCelo številoObvezno

Položaj v urejeni zbirki.

Primer: 1

Dodatna polja: Ne

Prikaži seznam · Statusi — Naročila — Odgovor

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataPolje elementov <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Obvezno

Primer odgovora · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

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

Metapodatki odgovora.

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

Dodatna polja: Ne

Posodobi · Status — Naročila — Telo zahteve

OrderStatusUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1
status_idNizObvezno

Identifikator iz ustreznega slovarja statusov.

Omejitve
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primer: "example"

Dodatna polja: Ne

Prikaži seznam — Naročila — Odgovor

OrderSummaryData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
created_atNizObvezno

Čas nastanka.

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

Podatki stranke, zabeleženi za ta vir.

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

Način dostave in povezani podatki.

Primer: {"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 znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

Primer: {"amount":"24.60","currency":"PLN","minor_units":2}
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (OrderSummaryData).

Primer: "order-0000"
lifecycle_stateOrderLifecycleState Obvezno

Stanje poslovnega življenjskega cikla.

Primer: "placed"
localeNizObvezno

Jezik, izbran za to zahtevo.

Primer: "pl"
market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

Primer: "market-pl"
numberNizObvezno

Uporabniku prikazana številka naročila ali zahtevka.

Primer: "0001"
paymentPaymentData Obvezno

Podrobnosti plačila, zabeležene za naročilo.

Primer: {"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čna vrednostObvezno

Ali navedene cene vključujejo davek.

Primer: true
shipping_discount_amountMoneyData Obvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

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

Status, ki ga sprejema ta operacija.

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

Znesek pred dodatnimi postavkami, prikazanimi v odgovoru.

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

Davčni podatki.

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

Davčna država · Shranjeni podatki naročila · ISO 3166-1 alpha-2; null.

Primer: "PL"
totalMoneyData Obvezno

Skupni znesek.

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

Dodatna polja: Ne

Naročilo · Davčne skupine

OrderTaxBreakdownData · Zneski in stopnje izvirajo iz shranjenega naročila, vključno s popravki postavk. Manjkajoči pretekli podatki so null in se ne nadomestijo s trenutnimi stopnjami kataloga. Zneski ostanejo decimalni nizi.
groupsPolje elementov <OrderTaxGroupData > Obvezno

Davčne skupine · source + tax_rate; Neznano: null; znana ničla: 0.

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

Nerazporejen davek = order.tax − Σ groups.tax; ±.

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

Dodatna polja: Ne

Davčne skupine

OrderTaxGroupData · Zneski in stopnje izvirajo iz shranjenega naročila, vključno s popravki postavk. Manjkajoči pretekli podatki so null in se ne nadomestijo s trenutnimi stopnjami kataloga. Zneski ostanejo decimalni nizi.
grossMoneyData Obvezno

Bruto znesek · Po popustih; Neznano: null; znana ničla: 0.

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

Neto znesek · Po popustih; Neznano: null; znana ničla: 0.

Primer: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceNizObvezno

Vir: products (Izdelki), shipping (Dostava).

Omejitve
enum
["products", "shipping"]
Primer: "products"
taxMoneyData nullObvezno

Znesek davka · Po popustih; Neznano: null; znana ničla: 0.

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

tax_rate · Shranjeni podatki naročila: "0.23" = 23%; "0" ≠ null.

Primer: "0.23"

Dodatna polja: Ne

Naročilo · Skupni zneski

OrderTotalsData · Zneski in stopnje izvirajo iz shranjenega naročila, vključno s popravki postavk. Manjkajoči pretekli podatki so null in se ne nadomestijo s trenutnimi stopnjami kataloga. Zneski ostanejo decimalni nizi.
before_discountsOrderAmountBreakdownData Obvezno

Naročilo · Pred popusti · net / tax / gross.

Primer: {"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.

Primer: {"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

Naročilo · Po popustih · net / tax / gross.

Primer: {"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

Izdelki · Popusti · net / tax / gross.

Primer: {"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

Izdelki · Po popustih · net / tax / gross.

Primer: {"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

Izdelki · Pred popusti · net / tax / gross.

Primer: {"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 · Po popustih · net / tax / gross.

Primer: {"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 · Pred popusti · net / tax / gross.

Primer: {"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.

Primer: {"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

Možnosti različic, povezane z izdelkom ali posnetkom

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Shema · Podatkovne sheme: Naročila
nameNizObvezno

Ime vira v ustreznem kontekstu.

valueNizObvezno

Vrednost, opisana z okoliško shemo.

Dodatna polja: Ne

OrderDiscountData

OrderDiscountData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
amountMoneyData Obvezno

Bruto znesek · Izdelki · Popusti.

Primer: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki.

Primer: "saved-coupon"
codeNiz nullObvezno

Stabilna strojno berljiva koda.

Primer: "SAVE"
kindNizObvezno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["coupon", "promotion"]
Primer: "coupon"
nameNizObvezno

Ime vira v ustreznem kontekstu.

Primer: "Saved coupon"
sequenceCelo število nullIzbirno

Vrstni red uporabe; null.

Primer: 1
shipping_amountMoneyData nullIzbirno

Bruto znesek · Dostava · Popusti; null.

Primer: {"amount":"24.60","currency":"PLN","minor_units":2}
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 3

Dodatna polja: Ne

Podrobnosti plačila, zabeležene za naročilo

PaymentData · Shema · Podatkovne sheme: Naročila
amountMoneyData Obvezno

payment.amount je skupni znesek naročila. Stanje plačila ne določa plačanih, vrnjenih ali dolgovanih zneskov.

Primer: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentNizObvezno

Podatki o okolju, dodani zapisu.

Omejitve
enum
["live", "sandbox"]
Primer: "live"
method_codeNiz nullObvezno

Koda načina dostave ali plačila.

Primer: "payment-old"
method_nameNiz nullObvezno

Ime načina dostave ali plačila.

Primer: "Historic method"
paid_atNiz nullObvezno

Datum in čas, ko je bilo plačilo označeno kot plačano.

Niz:format: "date-time"
Primer: null
statusOrderPaymentStatus Obvezno

Status, ki ga sprejema ta operacija.

Primer: "unpaid"
updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"
Primer: "2026-10-19T10:00:00Z"
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 0

Dodatna polja: Ne

Posodobi · Status plačila — Naročila — Telo zahteve

PaymentStatusUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 0maximum: 9223372036854775807
Primer: 1
reasonNizObvezno

Zabeleženi razlog spremembe.

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

Status, ki ga sprejema ta operacija.

Primer: "paid"

Dodatna polja: Ne

Status, ki ga sprejema ta operacija

PaymentStatus · Shema · Podatkovne sheme: Naročila
Niz
Omejitve
enum
["unpaid", "paid", "failed", "refunded"]

Dodatna polja: Da

PickupPointAddressData

PickupPointAddressData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
address_line_1NizObvezno

Prva vrstica naslova.

minLength: 1maxLength: 240
cityNizObvezno

Mesto ali kraj.

minLength: 1maxLength: 160
postal_codeNizObvezno

Poštna številka.

minLength: 1maxLength: 32

Dodatna polja: Ne

PickupPointCoordinatesData

PickupPointCoordinatesData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
latitudeŠteviloObvezno

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeŠteviloObvezno

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Dodatna polja: Ne

PickupPointData

PickupPointData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
address_line1NizObvezno

Prva vrstica naslova.

cityNizObvezno

Mesto ali kraj.

codeNizObvezno

Stabilna strojno berljiva koda.

country_codeNizObvezno

Koda države.

kindNizObvezno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["locker", "pickup_point"]
latitudeŠtevilo nullObvezno

WGS84 φ (°)

location_descriptionNiz nullObvezno

Opis v izbranem jeziku.

longitudeŠtevilo nullObvezno

WGS84 λ (°)

nameNizObvezno

Ime vira v ustreznem kontekstu.

opening_hoursNiz nullObvezno

Opening hours

operatorNizObvezno

Ime vira v ustreznem kontekstu.

postal_codeNizObvezno

Poštna številka.

Dodatna polja: Ne

PickupPointSummaryData

PickupPointSummaryData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
codeNizObvezno

Stabilna strojno berljiva koda.

Omejitve
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeNizObvezno

Koda države.

Omejitve
pattern
"^[A-Z]{2}$"
environmentNizObvezno

Podatki o okolju, dodani zapisu.

Omejitve
enum
["live", "sandbox"]
kindNizObvezno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["locker", "pickup_point"]
operatorNizObvezno

Ime vira v ustreznem kontekstu.

minLength: 1maxLength: 63

Dodatna polja: Ne

Podatki stranke, zabeleženi za ta vir

RequestCustomerData · Shema · Podatkovne sheme: Naročila
emailNizObvezno

E-poštni naslov.

Primer: "customer@example.invalid"
nameNizObvezno

Ime vira v ustreznem kontekstu.

Primer: "Example"

Dodatna polja: Ne

Način dostave in povezani podatki

ShippingData · Shema · Podatkovne sheme: Naročila
amountMoneyData Obvezno

Bruto znesek dostave, shranjen v naročilu kot MoneyData. Poznejše spremembe davka tega zgodovinskega zneska ne spreminjajo.

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

Datumi odpreme in dostave. Seznam in podrobnosti naročila vsebujejo delivery.dates. Načrtovani datumi YYYY-MM-DD ne potrjujejo odpreme. Trenutni datumi imajo prednost; starejša naročila uporabljajo shranjeno oceno. Izbrisane ali neznane vrednosti so null. Podrobnosti vsebujejo tudi vse postavke in slike izdelkov.

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

Koda načina dostave ali plačila.

Primer: "shipping-old"
method_nameNiz nullObvezno

Ime načina dostave ali plačila.

Primer: "Historic carrier"
pickup_pointPickupPointSummaryData nullObvezno

Prevzemno mesto

Primer: null
recipient_modeNizObvezno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["full_address", "pickup_contact"]
Primer: "full_address"

Dodatna polja: Ne

ShippingDetailData

ShippingDetailData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
amountMoneyData Obvezno

Bruto znesek dostave, shranjen v naročilu kot MoneyData. Poznejše spremembe davka tega zgodovinskega zneska ne spreminjajo.

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

Datumi odpreme in dostave. Seznam in podrobnosti naročila vsebujejo delivery.dates. Načrtovani datumi YYYY-MM-DD ne potrjujejo odpreme. Trenutni datumi imajo prednost; starejša naročila uporabljajo shranjeno oceno. Izbrisane ali neznane vrednosti so null. Podrobnosti vsebujejo tudi vse postavke in slike izdelkov.

Primer: {"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 znesek · Popusti; Neznano: null; znana ničla: 0.

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

Neto znesek · Popusti; Neznano: null; znana ničla: 0.

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

Znesek davka · Popusti; Neznano: null; znana ničla: 0.

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

Dostava · Popusti; []: 0; null: Neznano: null; znana ničla: 0.

Primer: [{"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 znesek · Po popustih; Neznano: null; znana ničla: 0.

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

Koda načina dostave ali plačila.

Primer: "shipping-old"
method_nameNiz nullObvezno

Ime načina dostave ali plačila.

Primer: "Historic carrier"
netMoneyData nullObvezno

Neto znesek · Po popustih; Neznano: null; znana ničla: 0.

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

Bruto znesek · Dostava · Pred popusti; Neznano: null; znana ničla: 0.

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

Neto znesek · Dostava · Pred popusti; Neznano: null; znana ničla: 0.

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

Znesek davka · Dostava · Pred popusti; Neznano: null; znana ničla: 0.

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

Prevzemno mesto

Primer: null
recipient_modeNizObvezno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["full_address", "pickup_contact"]
Primer: "full_address"
taxMoneyData nullObvezno

Znesek davka · Po popustih; Neznano: null; znana ničla: 0.

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

Identifikator davčne kategorije · Shranjeni podatki naročila; null.

Primer: "standard"
tax_category_nameNiz nullObvezno

Shranjeno ime davčne kategorije; null.

Primer: "VAT 23%"
tax_rateNiz nullObvezno

tax_rate · Shranjeni podatki naročila: "0.23" = 23%; "0" ≠ null.

Primer: "0.23"

Dodatna polja: Ne