Tietoskeemat: Tilaukset

Tietoskeemat: Tilaukset. API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

Tietoskeemat

Toimitusosoite

AddressData · Skeema · Tietoskeemat: Tilaukset

address_line_1Merkkijono nullPakollinen: Ensimmäinen osoiterivi.
address_line_2Merkkijono nullPakollinen: Osoitteen lisätiedot.
cityMerkkijono nullPakollinen: Kaupunki tai paikkakunta.
country_codeMerkkijono nullPakollinen: Maakoodi.
first_nameMerkkijono nullPakollinen: Etunimi.
house_numberMerkkijono nullPakollinen: Rakennuksen tai talon numero.
last_nameMerkkijono nullPakollinen: Sukunimi.
phoneMerkkijono nullPakollinen: Puhelinnumero.
postal_codeMerkkijono nullPakollinen: Postinumero.
regionMerkkijono nullPakollinen: Hallinnollinen alue.
streetMerkkijono nullPakollinen: Kadun nimi.

Lisäkentät: Ei

Listaa — Tilaukset — Vastaus

ApiResponse_list_OrderSummaryData__ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataTaulukko <OrderSummaryData > Pakollinen: Vastausesimerkki · ApiResponse_list_OrderSummaryData__.

Esimerkki: [{"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 Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Hae — Tilaukset — Vastaus

ApiResponse_OrderDetailData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataOrderDetailData Pakollinen: Vastausesimerkki · OrderDetailData.

Esimerkki: {"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 Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Tälle resurssille kirjatut asiakastiedot

CustomerData · Skeema · Tietoskeemat: Tilaukset

emailMerkkijonoPakollinen: Sähköpostiosoite.

Esimerkki: "customer@example.invalid"
first_nameMerkkijono nullPakollinen: Etunimi.

Esimerkki: "Example"
last_nameMerkkijono nullPakollinen: Sukunimi.

Esimerkki: "Example"
phoneMerkkijono nullPakollinen: Puhelinnumero.

Esimerkki: null

Lisäkentät: Ei

Lähetys- ja toimituspäivät

DeliveryDatesData · Tilausluettelo ja tiedot sisältävät delivery.dates-objektin. YYYY-MM-DD-päivät ovat suunniteltuja eivätkä vahvista lähetystä. Nykyiset päivät ovat ensisijaisia; vanhat tilaukset käyttävät tallennettua arviota. Poistetut tai tuntemattomat arvot ovat null. Tiedot sisältävät myös kaikki tilausrivit ja tuotekuvat.

dispatch_timezoneMerkkijono nullPakollinen: Lähetyksen aikavyöhyke (IANA; null).

Esimerkki: "Europe/Warsaw"
estimated_delivery_fromMerkkijono nullPakollinen: Arvioidun toimituksen alku (YYYY-MM-DD; null).

Merkkijono:format: "date"

Esimerkki: "2026-10-20"
estimated_delivery_toMerkkijono nullPakollinen: Arvioidun toimituksen loppu (YYYY-MM-DD; null).

Merkkijono:format: "date"

Esimerkki: "2026-10-21"
planned_dispatch_onMerkkijono nullPakollinen: Suunniteltu lähetyspäivä (YYYY-MM-DD; null).

Merkkijono:format: "date"

Esimerkki: "2026-10-19"

Lisäkentät: Ei

DeliveryPickupPointData

DeliveryPickupPointData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

addressPickupPointAddressData Pakollinen

Toimitusosoite.

codeMerkkijonoPakollinen

Vakaa koneellisesti luettava koodi.

Rajoitukset

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

coordinatesPickupPointCoordinatesData nullPakollinen

Ympäröivän skeeman kuvaama arvo.

country_codeMerkkijonoPakollinen

Maakoodi.

Rajoitukset

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

environmentMerkkijonoPakollinen

Tietueeseen liitetyt ympäristötiedot.

Rajoitukset

enum: ["live", "sandbox"]

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum: ["locker", "pickup_point"]

location_descriptionMerkkijono nullPakollinen

Kuvaus valitulla kielellä.

Merkkijono:maxLength: 1000

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

minLength: 1maxLength: 160

opening_hoursMerkkijono nullPakollinen

Opening hours

Merkkijono:maxLength: 500

operatorMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

minLength: 1maxLength: 63

verified_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"

Lisäkentät: Ei

Laskutiedot

InvoiceData · Skeema · Tietoskeemat: Tilaukset

address_line_1Merkkijono nullPakollinen: Ensimmäinen osoiterivi.
address_line_2Merkkijono nullPakollinen: Osoitteen lisätiedot.
cityMerkkijono nullPakollinen: Kaupunki tai paikkakunta.
company_nameMerkkijono nullPakollinen: Yrityksen nimi.
country_codeMerkkijono nullPakollinen: Maakoodi.
house_numberMerkkijono nullPakollinen: Rakennuksen tai talon numero.
postal_codeMerkkijono nullPakollinen: Postinumero.
regionMerkkijono nullPakollinen: Hallinnollinen alue.
streetMerkkijono nullPakollinen: Kadun nimi.
tax_identifierMerkkijono nullPakollinen: Verotunniste.
tax_schemeMerkkijono nullPakollinen: Veron laskentamalli.

Lisäkentät: Ei

Veroton summa / Veron määrä / Verollinen summa

OrderAmountBreakdownData · Summat ja verokannat tulevat tallennetusta tilauksesta rivikorjauksineen. Puuttuvat historiatiedot ovat null, eikä niitä korvata luettelon nykyisillä verokannoilla. Summat pysyvät desimaalimerkkijonoina.

grossMoneyData Pakollinen: Verollinen summa · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullPakollinen: Veroton summa · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullPakollinen: Veron määrä · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

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

Lisäkentät: Ei

Toimitus · Alennukset

OrderDeliveryDiscountData · Summat ja verokannat tulevat tallennetusta tilauksesta rivikorjauksineen. Puuttuvat historiatiedot ovat null, eikä niitä korvata luettelon nykyisillä verokannoilla. Summat pysyvät desimaalimerkkijonoina.

amountMoneyData Pakollinen

Verollinen summa · Toimitus · Alennukset.

Esimerkki: {"amount":"24.60","currency":"PLN","minor_units":2}

campaign_idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa.

Esimerkki: "saved-coupon"

codeMerkkijono nullPakollinen

Vakaa koneellisesti luettava koodi.

Esimerkki: "SAVE"

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum: ["coupon", "promotion"]

Esimerkki: "coupon"

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Saved coupon"

sequenceKokonaisluku nullPakollinen

Sijainti järjestetyssä kokoelmassa.

Esimerkki: 1

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 3

Lisäkentät: Ei

Hae — Tilaukset — Vastaus

OrderDetailData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

created_atMerkkijonoPakollinen: Luontiajankohta.

format: "date-time"

Esimerkki: "2026-10-19T10:00:00Z"
customerCustomerData Pakollinen: Tälle resurssille kirjatut asiakastiedot.

Esimerkki: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Pakollinen: Toimitustapa ja siihen liittyvät tiedot.

Esimerkki: {"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 Pakollinen: JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

Esimerkki: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsTaulukko <OrderDiscountData > Pakollinen: Alennukset

Esimerkki: [{"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}]
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (OrderDetailData).

Esimerkki: "order-0000"
invoiceInvoiceData nullPakollinen: Laskutiedot.

Esimerkki: null
invoice_requestedTotuusarvoPakollinen: Pyydettiinkö laskua.

Esimerkki: false
lifecycle_stateOrderLifecycleState Pakollinen: Liiketoiminnan elinkaaritila.

Esimerkki: "placed"
linesTaulukko <OrderLineData > Pakollinen: Tilausrivien tilannekuvat.

Esimerkki: [{"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":[]}]
localeMerkkijonoPakollinen: Tälle pyynnölle valittu kieli.

Esimerkki: "pl"
market_idMerkkijonoPakollinen: Kontekstipäätepisteen palauttama markkinatunniste.

Esimerkki: "market-pl"
numberMerkkijonoPakollinen: Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "0001"
paymentPaymentData Pakollinen: Tilaukselle kirjatut maksutiedot.

Esimerkki: {"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 nullPakollinen: Noutopiste

Esimerkki: null
prices_include_taxTotuusarvoPakollinen: Sisältävätkö luetellut hinnat verot.

Esimerkki: true
shipping_addressAddressData nullPakollinen: Toimitusosoite.

Esimerkki: null
shipping_discount_amountMoneyData Pakollinen: JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

Esimerkki: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Pakollinen: Tämän nimenomaisen toiminnon hyväksymä tila.

Esimerkki: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Pakollinen: Summa ennen vastauksessa esitettyjä lisäosia.

Esimerkki: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Pakollinen: Verotiedot.

Esimerkki: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Pakollinen: Veroryhmät · source + tax_rate; unallocated_tax.

Esimerkki: {"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_codeMerkkijono nullPakollinen: Verotusmaa · Tallennetut tilaustiedot · ISO 3166-1 alpha-2; null.

Esimerkki: "PL"
totalMoneyData Pakollinen: Kokonaissumma.

Esimerkki: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Pakollinen: Yhteissummat · net / tax / gross; Ennen alennuksia / Alennusten jälkeen.

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

Lisäkentät: Ei

Kuvan metatiedot ja URL-osoite

OrderImageData · Skeema · Tietoskeemat: Tilaukset

altMerkkijono nullPakollinen: Kuvan vaihtoehtoinen teksti.
sourceMerkkijonoValinnainen: Kirjatun toiminnan lähde.

const: "current_catalog"

Oletus: "current_catalog"
urlMerkkijonoPakollinen: Resurssin URL-osoite.

Lisäkentät: Ei

Liiketoiminnan elinkaaritila

OrderLifecycleState · Skeema · Tietoskeemat: Tilaukset

Merkkijono

Rajoitukset

enum: ["placed", "cancelled", "fulfilled", "returned"]

Lisäkentät: Kyllä

Tilausrivien tilannekuvat

OrderLineData · Skeema · Tietoskeemat: Tilaukset

discount_amountMoneyData Pakollinen: JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

Esimerkki: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Pakollinen: Verollinen summa · Alennukset; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullPakollinen: Veroton summa · Alennukset; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullPakollinen: Veron määrä · Alennukset; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsTaulukko <OrderDiscountData > Pakollinen: Alennukset · net / tax / gross.

Esimerkki: [{"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}]
identifiersObjektiLisäkentät: MerkkijonoPakollinen: Tuotteen tunnistekoodit.

Esimerkki: {}
imageOrderImageData nullPakollinen: Kuvan metatiedot ja URL-osoite.

Esimerkki: null
line_idMerkkijonoPakollinen: Tilausrivin pysyvä tunniste.

Esimerkki: "saved-line-a"
manual_discountOrderManualDiscountData nullPakollinen: Manuaalinen alennus; null.

Esimerkki: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameMerkkijonoPakollinen: Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Saved A"
original_totalMoneyData Pakollinen: Kokonaissumma.

Esimerkki: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Pakollinen: Verollinen summa · Tuotteet · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullPakollinen: Veroton summa · Tuotteet · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullPakollinen: Veron määrä · Tuotteet · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"46.00","currency":"PLN","minor_units":2}
positionKokonaislukuPakollinen: Sijainti järjestetyssä kokoelmassa.

Esimerkki: 1
product_idMerkkijonoPakollinen: Tuotteen tunniste.

Esimerkki: "product-api"
quantityKokonaislukuPakollinen: Yksiköiden määrä.

Esimerkki: 2
skuMerkkijonoPakollinen: Varastonimikkeen SKU-koodi.

Esimerkki: "A"
taxMoneyData nullPakollinen: Veron määrä · Yksi yksikkö · Tallennetut tilaustiedot; tax ≠ unit_tax; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idMerkkijono nullPakollinen: Veroluokan tunniste · Tallennetut tilaustiedot; null.

Esimerkki: "standard"
tax_category_nameMerkkijono nullPakollinen: Veroluokan tallennettu nimi; null.

Esimerkki: "VAT 23%"
tax_rateMerkkijono nullPakollinen: tax_rate · Tallennetut tilaustiedot: "0.23" = 23%; "0" ≠ null.

Esimerkki: "0.23"
totalMoneyData Pakollinen: Kokonaissumma.

Esimerkki: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Pakollinen: Verollinen summa · Tuotteet · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullPakollinen: Veroton summa · Tuotteet · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullPakollinen: Veron määrä · Tuotteet · Alennusten jälkeen · Tallennetut tilaustiedot; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Pakollinen: Verollinen summa · Yksi yksikkö · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullPakollinen: Veroton summa · Yksi yksikkö · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Pakollinen: Yhden yksikön hinta.

Esimerkki: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullPakollinen: Veron määrä · Yksi yksikkö · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idMerkkijono nullPakollinen: Tuotevariantin tunniste.

Esimerkki: null
variant_optionsTaulukko <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Pakollinen: Tuotteeseen tai tilannekuvaan liittyvät varianttivalinnat.

Esimerkki: []

Lisäkentät: Ei

Manuaalinen alennus

OrderManualDiscountData · Summat ja verokannat tulevat tallennetusta tilauksesta rivikorjauksineen. Puuttuvat historiatiedot ovat null, eikä niitä korvata luettelon nykyisillä verokannoilla. Summat pysyvät desimaalimerkkijonoina.

amountMoneyData Pakollinen

Verollinen summa · Manuaalinen alennus · Tallennetut tilaustiedot.

Esimerkki: {"amount":"12.30","currency":"PLN","minor_units":2}

kindMerkkijonoPakollinen

Alennuksen tyyppi: percentage / fixed.

Rajoitukset

enum: ["percentage", "fixed"]

Esimerkki: "fixed"

valueMerkkijonoPakollinen

Määritetty arvo: percentage "10" = 10%; fixed = Verollinen summa.

Esimerkki: "12.30"

Lisäkentät: Ei

Tämän nimenomaisen toiminnon hyväksymä tila

OrderPaymentStatus · Skeema · Tietoskeemat: Tilaukset

Merkkijono

Rajoitukset

enum: ["unpaid", "paid", "failed", "refunded"]

Lisäkentät: Kyllä

Tämän nimenomaisen toiminnon hyväksymä tila

OrderStatusData · Skeema · Tietoskeemat: Tilaukset

idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (OrderStatusData).

Esimerkki: "status-0"
nameMerkkijonoPakollinen: Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Status 0"
updated_atMerkkijonoPakollinen: Viimeisimmän päivityksen ajankohta.

format: "date-time"

Esimerkki: "2026-10-19T10:00:00Z"
versionKokonaislukuPakollinen: Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Listaa · Tilat — Tilaukset — Vastaus

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

created_atMerkkijonoPakollinen: Luontiajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Esimerkki: "example"
is_initialTotuusarvoPakollinen: Onko tämä alkutila.

Esimerkki: false
nameMerkkijonoPakollinen: Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"
positionKokonaislukuPakollinen: Sijainti järjestetyssä kokoelmassa.

Esimerkki: 1

Lisäkentät: Ei

Listaa · Tilat — Tilaukset — Vastaus

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataTaulukko <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Pakollinen: Vastausesimerkki · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Esimerkki: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Päivitä · Tila — Tilaukset — Pyynnön sisältö

OrderStatusUpdate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

expected_versionKokonaislukuPakollinen

Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

status_idMerkkijonoPakollinen

Asianmukaisesta tilaluettelosta saatu tunniste.

Rajoitukset

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

Esimerkki: "example"

Lisäkentät: Ei

Listaa — Tilaukset — Vastaus

OrderSummaryData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

created_atMerkkijonoPakollinen: Luontiajankohta.

format: "date-time"

Esimerkki: "2026-10-19T10:00:00Z"
customerCustomerData Pakollinen: Tälle resurssille kirjatut asiakastiedot.

Esimerkki: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Pakollinen: Toimitustapa ja siihen liittyvät tiedot.

Esimerkki: {"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 Pakollinen: JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

Esimerkki: {"amount":"24.60","currency":"PLN","minor_units":2}
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (OrderSummaryData).

Esimerkki: "order-0000"
lifecycle_stateOrderLifecycleState Pakollinen: Liiketoiminnan elinkaaritila.

Esimerkki: "placed"
localeMerkkijonoPakollinen: Tälle pyynnölle valittu kieli.

Esimerkki: "pl"
market_idMerkkijonoPakollinen: Kontekstipäätepisteen palauttama markkinatunniste.

Esimerkki: "market-pl"
numberMerkkijonoPakollinen: Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "0001"
paymentPaymentData Pakollinen: Tilaukselle kirjatut maksutiedot.

Esimerkki: {"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_taxTotuusarvoPakollinen: Sisältävätkö luetellut hinnat verot.

Esimerkki: true
shipping_discount_amountMoneyData Pakollinen: JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

Esimerkki: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Pakollinen: Tämän nimenomaisen toiminnon hyväksymä tila.

Esimerkki: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Pakollinen: Summa ennen vastauksessa esitettyjä lisäosia.

Esimerkki: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Pakollinen: Verotiedot.

Esimerkki: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeMerkkijono nullPakollinen: Verotusmaa · Tallennetut tilaustiedot · ISO 3166-1 alpha-2; null.

Esimerkki: "PL"
totalMoneyData Pakollinen: Kokonaissumma.

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

Lisäkentät: Ei

Tilaus · Veroryhmät

OrderTaxBreakdownData · Summat ja verokannat tulevat tallennetusta tilauksesta rivikorjauksineen. Puuttuvat historiatiedot ovat null, eikä niitä korvata luettelon nykyisillä verokannoilla. Summat pysyvät desimaalimerkkijonoina.

groupsTaulukko <OrderTaxGroupData > Pakollinen: Veroryhmät · source + tax_rate; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: [{"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 Pakollinen: Kohdistamaton vero = order.tax − Σ groups.tax; ±.

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

Lisäkentät: Ei

Veroryhmät

OrderTaxGroupData · Summat ja verokannat tulevat tallennetusta tilauksesta rivikorjauksineen. Puuttuvat historiatiedot ovat null, eikä niitä korvata luettelon nykyisillä verokannoilla. Summat pysyvät desimaalimerkkijonoina.

grossMoneyData Pakollinen

Verollinen summa · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"221.40","currency":"PLN","minor_units":2}

netMoneyData nullPakollinen

Veroton summa · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"180.00","currency":"PLN","minor_units":2}

sourceMerkkijonoPakollinen

Lähde: products (Tuotteet), shipping (Toimitus).

Rajoitukset

enum: ["products", "shipping"]

Esimerkki: "products"

taxMoneyData nullPakollinen

Veron määrä · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"41.40","currency":"PLN","minor_units":2}

tax_rateMerkkijono nullPakollinen

tax_rate · Tallennetut tilaustiedot: "0.23" = 23%; "0" ≠ null.

Esimerkki: "0.23"

Lisäkentät: Ei

Tilaus · Yhteissummat

OrderTotalsData · Summat ja verokannat tulevat tallennetusta tilauksesta rivikorjauksineen. Puuttuvat historiatiedot ovat null, eikä niitä korvata luettelon nykyisillä verokannoilla. Summat pysyvät desimaalimerkkijonoina.

before_discountsOrderAmountBreakdownData Pakollinen: Tilaus · Ennen alennuksia · net / tax / gross.

Esimerkki: {"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 Pakollinen: Alennukset · net / tax / gross.

Esimerkki: {"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 Pakollinen: Tilaus · Alennusten jälkeen · net / tax / gross.

Esimerkki: {"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 Pakollinen: Tuotteet · Alennukset · net / tax / gross.

Esimerkki: {"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 Pakollinen: Tuotteet · Alennusten jälkeen · net / tax / gross.

Esimerkki: {"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 Pakollinen: Tuotteet · Ennen alennuksia · net / tax / gross.

Esimerkki: {"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 Pakollinen: Toimitus · Alennusten jälkeen · net / tax / gross.

Esimerkki: {"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 Pakollinen: Toimitus · Ennen alennuksia · net / tax / gross.

Esimerkki: {"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 Pakollinen: Toimitus · Alennukset · net / tax / gross.

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

Lisäkentät: Ei

Tuotteeseen tai tilannekuvaan liittyvät varianttivalinnat

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Skeema · Tietoskeemat: Tilaukset

nameMerkkijonoPakollinen: Resurssin nimi kyseisessä kontekstissa.
valueMerkkijonoPakollinen: Ympäröivän skeeman kuvaama arvo.

Lisäkentät: Ei

OrderDiscountData

OrderDiscountData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

amountMoneyData Pakollinen

Verollinen summa · Tuotteet · Alennukset.

Esimerkki: {"amount":"12.30","currency":"PLN","minor_units":2}

campaign_idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa.

Esimerkki: "saved-coupon"

codeMerkkijono nullPakollinen

Vakaa koneellisesti luettava koodi.

Esimerkki: "SAVE"

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum: ["coupon", "promotion"]

Esimerkki: "coupon"

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Saved coupon"

sequenceKokonaisluku nullValinnainen

Soveltamisjärjestys; null.

Esimerkki: 1

shipping_amountMoneyData nullValinnainen

Verollinen summa · Toimitus · Alennukset; null.

Esimerkki: {"amount":"24.60","currency":"PLN","minor_units":2}

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 3

Lisäkentät: Ei

Tilaukselle kirjatut maksutiedot

PaymentData · Skeema · Tietoskeemat: Tilaukset

amountMoneyData Pakollinen

payment.amount on tilauksen kokonaissumma. Maksutila ei määritä maksettuja, palautettuja tai avoimia summia.

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

environmentMerkkijonoPakollinen

Tietueeseen liitetyt ympäristötiedot.

Rajoitukset

enum: ["live", "sandbox"]

Esimerkki: "live"

method_codeMerkkijono nullPakollinen

Toimitus- tai maksutavan koodi.

Esimerkki: "payment-old"

method_nameMerkkijono nullPakollinen

Toimitus- tai maksutavan nimi.

Esimerkki: "Historic method"

paid_atMerkkijono nullPakollinen

Päivämäärä ja aika, jolloin maksu merkittiin maksetuksi.

Merkkijono:format: "date-time"

Esimerkki: null

statusOrderPaymentStatus Pakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

Esimerkki: "unpaid"

updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"

Esimerkki: "2026-10-19T10:00:00Z"

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 0

Lisäkentät: Ei

Päivitä · Maksun tila — Tilaukset — Pyynnön sisältö

PaymentStatusUpdate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

expected_versionKokonaislukuPakollinen: Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 0maximum: 9223372036854775807

Esimerkki: 1
reasonMerkkijonoPakollinen: Muutokselle kirjattu syy.

minLength: 1maxLength: 500

Esimerkki: "Example"
statusPaymentStatus Pakollinen: Tämän nimenomaisen toiminnon hyväksymä tila.

Esimerkki: "paid"

Lisäkentät: Ei

Tämän nimenomaisen toiminnon hyväksymä tila

PaymentStatus · Skeema · Tietoskeemat: Tilaukset

Merkkijono

Rajoitukset

enum: ["unpaid", "paid", "failed", "refunded"]

Lisäkentät: Kyllä

PickupPointAddressData

PickupPointAddressData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

address_line_1MerkkijonoPakollinen: Ensimmäinen osoiterivi.

minLength: 1maxLength: 240
cityMerkkijonoPakollinen: Kaupunki tai paikkakunta.

minLength: 1maxLength: 160
postal_codeMerkkijonoPakollinen: Postinumero.

minLength: 1maxLength: 32

Lisäkentät: Ei

PickupPointCoordinatesData

PickupPointCoordinatesData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

latitudeLukuPakollinen: WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeLukuPakollinen: WGS84 λ (°)

minimum: -180.0maximum: 180.0

Lisäkentät: Ei

PickupPointData

PickupPointData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

address_line1MerkkijonoPakollinen

Ensimmäinen osoiterivi.

cityMerkkijonoPakollinen

Kaupunki tai paikkakunta.

codeMerkkijonoPakollinen

Vakaa koneellisesti luettava koodi.

country_codeMerkkijonoPakollinen

Maakoodi.

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum: ["locker", "pickup_point"]

latitudeLuku nullPakollinen

WGS84 φ (°)

location_descriptionMerkkijono nullPakollinen

Kuvaus valitulla kielellä.

longitudeLuku nullPakollinen

WGS84 λ (°)

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

opening_hoursMerkkijono nullPakollinen

Opening hours

operatorMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

postal_codeMerkkijonoPakollinen

Postinumero.

Lisäkentät: Ei

PickupPointSummaryData

PickupPointSummaryData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

codeMerkkijonoPakollinen

Vakaa koneellisesti luettava koodi.

Rajoitukset

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

country_codeMerkkijonoPakollinen

Maakoodi.

Rajoitukset

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

environmentMerkkijonoPakollinen

Tietueeseen liitetyt ympäristötiedot.

Rajoitukset

enum: ["live", "sandbox"]

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum: ["locker", "pickup_point"]

operatorMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

minLength: 1maxLength: 63

Lisäkentät: Ei

Tälle resurssille kirjatut asiakastiedot

RequestCustomerData · Skeema · Tietoskeemat: Tilaukset

emailMerkkijonoPakollinen: Sähköpostiosoite.

Esimerkki: "customer@example.invalid"
nameMerkkijonoPakollinen: Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"

Lisäkentät: Ei

Toimitustapa ja siihen liittyvät tiedot

ShippingData · Skeema · Tietoskeemat: Tilaukset

amountMoneyData Pakollinen

Tilaukseen MoneyData-muodossa tallennettu toimituksen verollinen summa. Myöhemmät veromuutokset eivät muuta tätä historiallista summaa.

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

datesDeliveryDatesData Pakollinen

Lähetys- ja toimituspäivät. Tilausluettelo ja tiedot sisältävät delivery.dates-objektin. YYYY-MM-DD-päivät ovat suunniteltuja eivätkä vahvista lähetystä. Nykyiset päivät ovat ensisijaisia; vanhat tilaukset käyttävät tallennettua arviota. Poistetut tai tuntemattomat arvot ovat null. Tiedot sisältävät myös kaikki tilausrivit ja tuotekuvat.

Esimerkki:

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

method_codeMerkkijono nullPakollinen

Toimitus- tai maksutavan koodi.

Esimerkki: "shipping-old"

method_nameMerkkijono nullPakollinen

Toimitus- tai maksutavan nimi.

Esimerkki: "Historic carrier"

pickup_pointPickupPointSummaryData nullPakollinen

Noutopiste

Esimerkki: null

recipient_modeMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum: ["full_address", "pickup_contact"]

Esimerkki: "full_address"

Lisäkentät: Ei

ShippingDetailData

ShippingDetailData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

amountMoneyData Pakollinen

Tilaukseen MoneyData-muodossa tallennettu toimituksen verollinen summa. Myöhemmät veromuutokset eivät muuta tätä historiallista summaa.

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

datesDeliveryDatesData Pakollinen

Esimerkki:

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

discount_grossMoneyData Pakollinen

Verollinen summa · Alennukset; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"24.60","currency":"PLN","minor_units":2}

discount_netMoneyData nullPakollinen

Veroton summa · Alennukset; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"20.00","currency":"PLN","minor_units":2}

discount_taxMoneyData nullPakollinen

Veron määrä · Alennukset; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"4.60","currency":"PLN","minor_units":2}

discountsTaulukko <OrderDeliveryDiscountData > nullPakollinen

Toimitus · Alennukset; []: 0; null: Tuntematon: null; tunnettu nolla: 0.

Esimerkki:

[{"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 Pakollinen

Verollinen summa · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

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

method_codeMerkkijono nullPakollinen

Toimitus- tai maksutavan koodi.

Esimerkki: "shipping-old"

method_nameMerkkijono nullPakollinen

Toimitus- tai maksutavan nimi.

Esimerkki: "Historic carrier"

netMoneyData nullPakollinen

Veroton summa · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

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

original_grossMoneyData Pakollinen

Verollinen summa · Toimitus · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"24.60","currency":"PLN","minor_units":2}

original_netMoneyData nullPakollinen

Veroton summa · Toimitus · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"20.00","currency":"PLN","minor_units":2}

original_taxMoneyData nullPakollinen

Veron määrä · Toimitus · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

Esimerkki: {"amount":"4.60","currency":"PLN","minor_units":2}

pickup_pointDeliveryPickupPointData nullPakollinen

Noutopiste

Esimerkki: null

recipient_modeMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum: ["full_address", "pickup_contact"]

Esimerkki: "full_address"

taxMoneyData nullPakollinen

Veron määrä · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

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

tax_category_idMerkkijono nullPakollinen

Veroluokan tunniste · Tallennetut tilaustiedot; null.

Esimerkki: "standard"

tax_category_nameMerkkijono nullPakollinen

Veroluokan tallennettu nimi; null.

Esimerkki: "VAT 23%"

tax_rateMerkkijono nullPakollinen

tax_rate · Tallennetut tilaustiedot: "0.23" = 23%; "0" ≠ null.

Esimerkki: "0.23"

Lisäkentät: Ei