Pāriet uz saturu
ShopentlyLearn

Datu shēmas: Pasūtījumi

Datu shēmas: Pasūtījumi. API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Datu shēmas

Piegādes adrese

AddressData · Shēma · Datu shēmas: Pasūtījumi
address_line_1Virkne nullObligāts

Adreses pirmā rinda.

address_line_2Virkne nullObligāts

Papildu adreses informācija.

cityVirkne nullObligāts

Pilsēta vai apdzīvotā vieta.

country_codeVirkne nullObligāts

Valsts kods.

first_nameVirkne nullObligāts

Vārds.

house_numberVirkne nullObligāts

Ēkas vai mājas numurs.

last_nameVirkne nullObligāts

Uzvārds.

phoneVirkne nullObligāts

Tālruņa numurs.

postal_codeVirkne nullObligāts

Pasta indekss.

regionVirkne nullObligāts

Administratīvais reģions.

streetVirkne nullObligāts

Ielas nosaukums.

Papildu lauki: Nē

Saraksts — Pasūtījumi — Atbilde

ApiResponse_list_OrderSummaryData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
dataMasīvs <OrderSummaryData > Obligāts

Atbildes piemērs · ApiResponse_list_OrderSummaryData__.

Piemērs: [{"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 Obligāts

Atbildes metadati.

Piemērs: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildu lauki: Nē

Iegūt — Pasūtījumi — Atbilde

ApiResponse_OrderDetailData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
dataOrderDetailData Obligāts

Atbildes piemērs · OrderDetailData.

Piemērs: {"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 Obligāts

Atbildes metadati.

Piemērs: {"request_id":"example-request"}

Papildu lauki: Nē

Šim resursam saglabātā klienta informācija

CustomerData · Shēma · Datu shēmas: Pasūtījumi
emailVirkneObligāts

E-pasta adrese.

Piemērs: "customer@example.invalid"
first_nameVirkne nullObligāts

Vārds.

Piemērs: "Example"
last_nameVirkne nullObligāts

Uzvārds.

Piemērs: "Example"
phoneVirkne nullObligāts

Tālruņa numurs.

Piemērs: null

Papildu lauki: Nē

Nosūtīšanas un piegādes datumi

DeliveryDatesData · Pasūtījumu saraksts un informācija ietver delivery.dates. Datumi YYYY-MM-DD ir plānoti un neapstiprina nosūtīšanu. Pašreizējiem datumiem ir prioritāte; vecāki pasūtījumi izmanto saglabāto prognozi. Dzēstas vai nezināmas vērtības ir null. Informācija ietver arī visas pasūtījuma pozīcijas un produktu attēlus.
dispatch_timezoneVirkne nullObligāts

Nosūtīšanas laika josla (IANA; null).

Piemērs: "Europe/Warsaw"
estimated_delivery_fromVirkne nullObligāts

Paredzamās piegādes sākums (YYYY-MM-DD; null).

Virkne:format: "date"
Piemērs: "2026-10-20"
estimated_delivery_toVirkne nullObligāts

Paredzamās piegādes beigas (YYYY-MM-DD; null).

Virkne:format: "date"
Piemērs: "2026-10-21"
planned_dispatch_onVirkne nullObligāts

Plānotais nosūtīšanas datums (YYYY-MM-DD; null).

Virkne:format: "date"
Piemērs: "2026-10-19"

Papildu lauki: Nē

DeliveryPickupPointData

DeliveryPickupPointData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
addressPickupPointAddressData Obligāts

Piegādes adrese.

codeVirkneObligāts

Stabils mašīnlasāms kods.

Ierobežojumi
pattern
"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesData nullObligāts

Apkārtējā shēmā aprakstītā vērtība.

country_codeVirkneObligāts

Valsts kods.

Ierobežojumi
pattern
"^[A-Z]{2}$"
environmentVirkneObligāts

Ierakstam pievienotā vides informācija.

Ierobežojumi
enum
["live", "sandbox"]
kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi
enum
["locker", "pickup_point"]
location_descriptionVirkne nullObligāts

Apraksts izvēlētajā valodā.

Virkne:maxLength: 1000
nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

minLength: 1maxLength: 160
opening_hoursVirkne nullObligāts

Opening hours

Virkne:maxLength: 500
operatorVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

minLength: 1maxLength: 63
verified_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"

Papildu lauki: Nē

Rēķina informācija

InvoiceData · Shēma · Datu shēmas: Pasūtījumi
address_line_1Virkne nullObligāts

Adreses pirmā rinda.

address_line_2Virkne nullObligāts

Papildu adreses informācija.

cityVirkne nullObligāts

Pilsēta vai apdzīvotā vieta.

company_nameVirkne nullObligāts

Uzņēmuma nosaukums.

country_codeVirkne nullObligāts

Valsts kods.

house_numberVirkne nullObligāts

Ēkas vai mājas numurs.

postal_codeVirkne nullObligāts

Pasta indekss.

regionVirkne nullObligāts

Administratīvais reģions.

streetVirkne nullObligāts

Ielas nosaukums.

tax_identifierVirkne nullObligāts

Nodokļu maksātāja identifikācijas numurs.

tax_schemeVirkne nullObligāts

Nodokļu aprēķina shēma.

Papildu lauki: Nē

Neto summa / Nodokļa summa / Bruto summa

OrderAmountBreakdownData · Summas un likmes nāk no saglabātā pasūtījuma, ieskaitot pozīciju labojumus. Trūkstošie vēsturiskie dati ir null un netiek aizstāti ar pašreizējām kataloga likmēm. Summas paliek decimālās virknes.
grossMoneyData Obligāts

Bruto summa · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullObligāts

Neto summa · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullObligāts

Nodokļa summa · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"58.60","currency":"PLN","minor_units":2}

Papildu lauki: Nē

Piegāde · Atlaides

OrderDeliveryDiscountData · Summas un likmes nāk no saglabātā pasūtījuma, ieskaitot pozīciju labojumus. Trūkstošie vēsturiskie dati ir null un netiek aizstāti ar pašreizējām kataloga likmēm. Summas paliek decimālās virknes.
amountMoneyData Obligāts

Bruto summa · Piegāde · Atlaides.

Piemērs: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā.

Piemērs: "saved-coupon"
codeVirkne nullObligāts

Stabils mašīnlasāms kods.

Piemērs: "SAVE"
kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi
enum
["coupon", "promotion"]
Piemērs: "coupon"
nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Saved coupon"
sequenceVesels skaitlis nullObligāts

Pozīcija sakārtotā kolekcijā.

Piemērs: 1
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 3

Papildu lauki: Nē

Iegūt — Pasūtījumi — Atbilde

OrderDetailData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
created_atVirkneObligāts

Izveides laiks.

format: "date-time"
Piemērs: "2026-10-19T10:00:00Z"
customerCustomerData Obligāts

Šim resursam saglabātā klienta informācija.

Piemērs: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Obligāts

Piegādes metode un saistītā informācija.

Piemērs: {"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 Obligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Piemērs: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsMasīvs <OrderDiscountData > Obligāts

Atlaides

Piemērs: [{"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}]
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (OrderDetailData).

Piemērs: "order-0000"
invoiceInvoiceData nullObligāts

Rēķina informācija.

Piemērs: null
invoice_requestedLoģiska vērtībaObligāts

Vai pieprasīts rēķins.

Piemērs: false
lifecycle_stateOrderLifecycleState Obligāts

Biznesa dzīves cikla stāvoklis.

Piemērs: "placed"
linesMasīvs <OrderLineData > Obligāts

Pasūtījuma rindu momentuzņēmumi.

Piemērs: [{"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":[]}]
localeVirkneObligāts

Šim pieprasījumam izvēlētā valoda.

Piemērs: "pl"
market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

Piemērs: "market-pl"
numberVirkneObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

Piemērs: "0001"
paymentPaymentData Obligāts

Pasūtījumā reģistrētās maksājuma detaļas.

Piemērs: {"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 nullObligāts

Saņemšanas punkts

Piemērs: null
prices_include_taxLoģiska vērtībaObligāts

Vai norādītās cenas ietver nodokli.

Piemērs: true
shipping_addressAddressData nullObligāts

Piegādes adrese.

Piemērs: null
shipping_discount_amountMoneyData Obligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Piemērs: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligāts

Šai konkrētajai darbībai pieņemamais statuss.

Piemērs: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obligāts

Summa pirms atbildē parādītajiem papildu komponentiem.

Piemērs: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligāts

Nodokļu informācija.

Piemērs: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Obligāts

Nodokļu grupas · source + tax_rate; unallocated_tax.

Piemērs: {"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_codeVirkne nullObligāts

Nodokļu valsts · Saglabātie pasūtījuma dati · ISO 3166-1 alpha-2; null.

Piemērs: "PL"
totalMoneyData Obligāts

Kopējā summa.

Piemērs: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Obligāts

Kopsummas · net / tax / gross; Pirms atlaidēm / Pēc atlaidēm.

Piemērs: {"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}}}

Papildu lauki: Nē

Attēla metadati un URL

OrderImageData · Shēma · Datu shēmas: Pasūtījumi
altVirkne nullObligāts

Attēla alternatīvais teksts.

sourceVirkneNeobligāts

Reģistrētās aktivitātes avots.

const: "current_catalog"
Noklusējums: "current_catalog"
urlVirkneObligāts

Resursa URL.

Papildu lauki: Nē

Biznesa dzīves cikla stāvoklis

OrderLifecycleState · Shēma · Datu shēmas: Pasūtījumi
Virkne
Ierobežojumi
enum
["placed", "cancelled", "fulfilled", "returned"]

Papildu lauki: Jā

Pasūtījuma rindu momentuzņēmumi

OrderLineData · Shēma · Datu shēmas: Pasūtījumi
discount_amountMoneyData Obligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Piemērs: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Obligāts

Bruto summa · Atlaides; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObligāts

Neto summa · Atlaides; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObligāts

Nodokļa summa · Atlaides; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsMasīvs <OrderDiscountData > Obligāts

Atlaides · net / tax / gross.

Piemērs: [{"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}]
identifiersObjektsPapildu lauki: VirkneObligāts

Produkta identifikācijas kodi.

Piemērs: {}
imageOrderImageData nullObligāts

Attēla metadati un URL.

Piemērs: null
line_idVirkneObligāts

Pastāvīgs pasūtījuma pozīcijas identifikators.

Piemērs: "saved-line-a"
manual_discountOrderManualDiscountData nullObligāts

Manuāla atlaide; null.

Piemērs: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Saved A"
original_totalMoneyData Obligāts

Kopējā summa.

Piemērs: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Obligāts

Bruto summa · Produkti · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullObligāts

Neto summa · Produkti · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullObligāts

Nodokļa summa · Produkti · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"46.00","currency":"PLN","minor_units":2}
positionVesels skaitlisObligāts

Pozīcija sakārtotā kolekcijā.

Piemērs: 1
product_idVirkneObligāts

Produkta identifikators.

Piemērs: "product-api"
quantityVesels skaitlisObligāts

Vienību skaits.

Piemērs: 2
skuVirkneObligāts

Krājumu uzskaites vienības kods.

Piemērs: "A"
taxMoneyData nullObligāts

Nodokļa summa · Viena vienība · Saglabātie pasūtījuma dati; tax ≠ unit_tax; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idVirkne nullObligāts

Nodokļu kategorijas identifikators · Saglabātie pasūtījuma dati; null.

Piemērs: "standard"
tax_category_nameVirkne nullObligāts

Saglabātais nodokļu kategorijas nosaukums; null.

Piemērs: "VAT 23%"
tax_rateVirkne nullObligāts

tax_rate · Saglabātie pasūtījuma dati: "0.23" = 23%; "0" ≠ null.

Piemērs: "0.23"
totalMoneyData Obligāts

Kopējā summa.

Piemērs: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Obligāts

Bruto summa · Produkti · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullObligāts

Neto summa · Produkti · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullObligāts

Nodokļa summa · Produkti · Pēc atlaidēm · Saglabātie pasūtījuma dati; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Obligāts

Bruto summa · Viena vienība · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullObligāts

Neto summa · Viena vienība · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obligāts

Vienas vienības cena.

Piemērs: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullObligāts

Nodokļa summa · Viena vienība · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idVirkne nullObligāts

Produkta varianta identifikators.

Piemērs: null
variant_optionsMasīvs <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Obligāts

Ar produktu vai momentuzņēmumu saistītās variantu opcijas.

Piemērs: []

Papildu lauki: Nē

Manuāla atlaide

OrderManualDiscountData · Summas un likmes nāk no saglabātā pasūtījuma, ieskaitot pozīciju labojumus. Trūkstošie vēsturiskie dati ir null un netiek aizstāti ar pašreizējām kataloga likmēm. Summas paliek decimālās virknes.
amountMoneyData Obligāts

Bruto summa · Manuāla atlaide · Saglabātie pasūtījuma dati.

Piemērs: {"amount":"12.30","currency":"PLN","minor_units":2}
kindVirkneObligāts

Atlaides veids: percentage / fixed.

Ierobežojumi
enum
["percentage", "fixed"]
Piemērs: "fixed"
valueVirkneObligāts

Iestatītā vērtība: percentage "10" = 10%; fixed = Bruto summa.

Piemērs: "12.30"

Papildu lauki: Nē

Šai konkrētajai darbībai pieņemamais statuss

OrderPaymentStatus · Shēma · Datu shēmas: Pasūtījumi
Virkne
Ierobežojumi
enum
["unpaid", "paid", "failed", "refunded"]

Papildu lauki: Jā

Šai konkrētajai darbībai pieņemamais statuss

OrderStatusData · Shēma · Datu shēmas: Pasūtījumi
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (OrderStatusData).

Piemērs: "status-0"
nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Status 0"
updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"
Piemērs: "2026-10-19T10:00:00Z"
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Saraksts · Statusi — Pasūtījumi — Atbilde

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
created_atVirkneObligāts

Izveides laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Piemērs: "example"
is_initialLoģiska vērtībaObligāts

Vai šis ir sākuma statuss.

Piemērs: false
nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Example"
positionVesels skaitlisObligāts

Pozīcija sakārtotā kolekcijā.

Piemērs: 1

Papildu lauki: Nē

Saraksts · Statusi — Pasūtījumi — Atbilde

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
dataMasīvs <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Obligāts

Atbildes piemērs · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Piemērs: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligāts

Atbildes metadati.

Piemērs: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildu lauki: Nē

Atjaunināt · Statuss — Pasūtījumi — Pieprasījuma saturs

OrderStatusUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807
Piemērs: 1
status_idVirkneObligāts

No atbilstošās statusu vārdnīcas iegūts identifikators.

Ierobežojumi
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Piemērs: "example"

Papildu lauki: Nē

Saraksts — Pasūtījumi — Atbilde

OrderSummaryData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
created_atVirkneObligāts

Izveides laiks.

format: "date-time"
Piemērs: "2026-10-19T10:00:00Z"
customerCustomerData Obligāts

Šim resursam saglabātā klienta informācija.

Piemērs: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Obligāts

Piegādes metode un saistītā informācija.

Piemērs: {"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 Obligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Piemērs: {"amount":"24.60","currency":"PLN","minor_units":2}
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (OrderSummaryData).

Piemērs: "order-0000"
lifecycle_stateOrderLifecycleState Obligāts

Biznesa dzīves cikla stāvoklis.

Piemērs: "placed"
localeVirkneObligāts

Šim pieprasījumam izvēlētā valoda.

Piemērs: "pl"
market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

Piemērs: "market-pl"
numberVirkneObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

Piemērs: "0001"
paymentPaymentData Obligāts

Pasūtījumā reģistrētās maksājuma detaļas.

Piemērs: {"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_taxLoģiska vērtībaObligāts

Vai norādītās cenas ietver nodokli.

Piemērs: true
shipping_discount_amountMoneyData Obligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Piemērs: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligāts

Šai konkrētajai darbībai pieņemamais statuss.

Piemērs: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obligāts

Summa pirms atbildē parādītajiem papildu komponentiem.

Piemērs: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligāts

Nodokļu informācija.

Piemērs: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeVirkne nullObligāts

Nodokļu valsts · Saglabātie pasūtījuma dati · ISO 3166-1 alpha-2; null.

Piemērs: "PL"
totalMoneyData Obligāts

Kopējā summa.

Piemērs: {"amount":"329.40","currency":"PLN","minor_units":2}

Papildu lauki: Nē

Pasūtījums · Nodokļu grupas

OrderTaxBreakdownData · Summas un likmes nāk no saglabātā pasūtījuma, ieskaitot pozīciju labojumus. Trūkstošie vēsturiskie dati ir null un netiek aizstāti ar pašreizējām kataloga likmēm. Summas paliek decimālās virknes.
groupsMasīvs <OrderTaxGroupData > Obligāts

Nodokļu grupas · source + tax_rate; Nezināms: null; zināma nulle: 0.

Piemērs: [{"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 Obligāts

Nepiešķirtais nodoklis = order.tax − Σ groups.tax; ±.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}

Papildu lauki: Nē

Nodokļu grupas

OrderTaxGroupData · Summas un likmes nāk no saglabātā pasūtījuma, ieskaitot pozīciju labojumus. Trūkstošie vēsturiskie dati ir null un netiek aizstāti ar pašreizējām kataloga likmēm. Summas paliek decimālās virknes.
grossMoneyData Obligāts

Bruto summa · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullObligāts

Neto summa · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceVirkneObligāts

Avots: products (Produkti), shipping (Piegāde).

Ierobežojumi
enum
["products", "shipping"]
Piemērs: "products"
taxMoneyData nullObligāts

Nodokļa summa · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateVirkne nullObligāts

tax_rate · Saglabātie pasūtījuma dati: "0.23" = 23%; "0" ≠ null.

Piemērs: "0.23"

Papildu lauki: Nē

Pasūtījums · Kopsummas

OrderTotalsData · Summas un likmes nāk no saglabātā pasūtījuma, ieskaitot pozīciju labojumus. Trūkstošie vēsturiskie dati ir null un netiek aizstāti ar pašreizējām kataloga likmēm. Summas paliek decimālās virknes.
before_discountsOrderAmountBreakdownData Obligāts

Pasūtījums · Pirms atlaidēm · net / tax / gross.

Piemērs: {"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 Obligāts

Atlaides · net / tax / gross.

Piemērs: {"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 Obligāts

Pasūtījums · Pēc atlaidēm · net / tax / gross.

Piemērs: {"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 Obligāts

Produkti · Atlaides · net / tax / gross.

Piemērs: {"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 Obligāts

Produkti · Pēc atlaidēm · net / tax / gross.

Piemērs: {"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 Obligāts

Produkti · Pirms atlaidēm · net / tax / gross.

Piemērs: {"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 Obligāts

Piegāde · Pēc atlaidēm · net / tax / gross.

Piemērs: {"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 Obligāts

Piegāde · Pirms atlaidēm · net / tax / gross.

Piemērs: {"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 Obligāts

Piegāde · Atlaides · net / tax / gross.

Piemērs: {"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}}

Papildu lauki: Nē

Ar produktu vai momentuzņēmumu saistītās variantu opcijas

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Shēma · Datu shēmas: Pasūtījumi
nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

valueVirkneObligāts

Apkārtējā shēmā aprakstītā vērtība.

Papildu lauki: Nē

OrderDiscountData

OrderDiscountData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
amountMoneyData Obligāts

Bruto summa · Produkti · Atlaides.

Piemērs: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā.

Piemērs: "saved-coupon"
codeVirkne nullObligāts

Stabils mašīnlasāms kods.

Piemērs: "SAVE"
kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi
enum
["coupon", "promotion"]
Piemērs: "coupon"
nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Saved coupon"
sequenceVesels skaitlis nullNeobligāts

Piemērošanas secība; null.

Piemērs: 1
shipping_amountMoneyData nullNeobligāts

Bruto summa · Piegāde · Atlaides; null.

Piemērs: {"amount":"24.60","currency":"PLN","minor_units":2}
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 3

Papildu lauki: Nē

Pasūtījumā reģistrētās maksājuma detaļas

PaymentData · Shēma · Datu shēmas: Pasūtījumi
amountMoneyData Obligāts

payment.amount ir pasūtījuma kopsumma. Maksājuma statuss nenosaka samaksātās, atmaksātās vai nesamaksātās summas.

Piemērs: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentVirkneObligāts

Ierakstam pievienotā vides informācija.

Ierobežojumi
enum
["live", "sandbox"]
Piemērs: "live"
method_codeVirkne nullObligāts

Piegādes vai maksājuma metodes kods.

Piemērs: "payment-old"
method_nameVirkne nullObligāts

Piegādes vai maksājuma metodes nosaukums.

Piemērs: "Historic method"
paid_atVirkne nullObligāts

Datums un laiks, kad maksājums atzīmēts kā samaksāts.

Virkne:format: "date-time"
Piemērs: null
statusOrderPaymentStatus Obligāts

Šai konkrētajai darbībai pieņemamais statuss.

Piemērs: "unpaid"
updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"
Piemērs: "2026-10-19T10:00:00Z"
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 0

Papildu lauki: Nē

Atjaunināt · Maksājuma statuss — Pasūtījumi — Pieprasījuma saturs

PaymentStatusUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 0maximum: 9223372036854775807
Piemērs: 1
reasonVirkneObligāts

Reģistrētais izmaiņas iemesls.

minLength: 1maxLength: 500
Piemērs: "Example"
statusPaymentStatus Obligāts

Šai konkrētajai darbībai pieņemamais statuss.

Piemērs: "paid"

Papildu lauki: Nē

Šai konkrētajai darbībai pieņemamais statuss

PaymentStatus · Shēma · Datu shēmas: Pasūtījumi
Virkne
Ierobežojumi
enum
["unpaid", "paid", "failed", "refunded"]

Papildu lauki: Jā

PickupPointAddressData

PickupPointAddressData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
address_line_1VirkneObligāts

Adreses pirmā rinda.

minLength: 1maxLength: 240
cityVirkneObligāts

Pilsēta vai apdzīvotā vieta.

minLength: 1maxLength: 160
postal_codeVirkneObligāts

Pasta indekss.

minLength: 1maxLength: 32

Papildu lauki: Nē

PickupPointCoordinatesData

PickupPointCoordinatesData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
latitudeSkaitlisObligāts

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeSkaitlisObligāts

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Papildu lauki: Nē

PickupPointData

PickupPointData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
address_line1VirkneObligāts

Adreses pirmā rinda.

cityVirkneObligāts

Pilsēta vai apdzīvotā vieta.

codeVirkneObligāts

Stabils mašīnlasāms kods.

country_codeVirkneObligāts

Valsts kods.

kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi
enum
["locker", "pickup_point"]
latitudeSkaitlis nullObligāts

WGS84 φ (°)

location_descriptionVirkne nullObligāts

Apraksts izvēlētajā valodā.

longitudeSkaitlis nullObligāts

WGS84 λ (°)

nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

opening_hoursVirkne nullObligāts

Opening hours

operatorVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

postal_codeVirkneObligāts

Pasta indekss.

Papildu lauki: Nē

PickupPointSummaryData

PickupPointSummaryData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
codeVirkneObligāts

Stabils mašīnlasāms kods.

Ierobežojumi
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeVirkneObligāts

Valsts kods.

Ierobežojumi
pattern
"^[A-Z]{2}$"
environmentVirkneObligāts

Ierakstam pievienotā vides informācija.

Ierobežojumi
enum
["live", "sandbox"]
kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi
enum
["locker", "pickup_point"]
operatorVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

minLength: 1maxLength: 63

Papildu lauki: Nē

Šim resursam saglabātā klienta informācija

RequestCustomerData · Shēma · Datu shēmas: Pasūtījumi
emailVirkneObligāts

E-pasta adrese.

Piemērs: "customer@example.invalid"
nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Example"

Papildu lauki: Nē

Piegādes metode un saistītā informācija

ShippingData · Shēma · Datu shēmas: Pasūtījumi
amountMoneyData Obligāts

Pasūtījumā kā MoneyData saglabātā piegādes summa ar nodokļiem. Vēlāki nodokļu grozījumi šo vēsturisko summu nemaina.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Obligāts

Nosūtīšanas un piegādes datumi. Pasūtījumu saraksts un informācija ietver delivery.dates. Datumi YYYY-MM-DD ir plānoti un neapstiprina nosūtīšanu. Pašreizējiem datumiem ir prioritāte; vecāki pasūtījumi izmanto saglabāto prognozi. Dzēstas vai nezināmas vērtības ir null. Informācija ietver arī visas pasūtījuma pozīcijas un produktu attēlus.

Piemērs: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
method_codeVirkne nullObligāts

Piegādes vai maksājuma metodes kods.

Piemērs: "shipping-old"
method_nameVirkne nullObligāts

Piegādes vai maksājuma metodes nosaukums.

Piemērs: "Historic carrier"
pickup_pointPickupPointSummaryData nullObligāts

Saņemšanas punkts

Piemērs: null
recipient_modeVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi
enum
["full_address", "pickup_contact"]
Piemērs: "full_address"

Papildu lauki: Nē

ShippingDetailData

ShippingDetailData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
amountMoneyData Obligāts

Pasūtījumā kā MoneyData saglabātā piegādes summa ar nodokļiem. Vēlāki nodokļu grozījumi šo vēsturisko summu nemaina.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Obligāts

Nosūtīšanas un piegādes datumi. Pasūtījumu saraksts un informācija ietver delivery.dates. Datumi YYYY-MM-DD ir plānoti un neapstiprina nosūtīšanu. Pašreizējiem datumiem ir prioritāte; vecāki pasūtījumi izmanto saglabāto prognozi. Dzēstas vai nezināmas vērtības ir null. Informācija ietver arī visas pasūtījuma pozīcijas un produktu attēlus.

Piemērs: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
discount_grossMoneyData Obligāts

Bruto summa · Atlaides; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObligāts

Neto summa · Atlaides; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObligāts

Nodokļa summa · Atlaides; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsMasīvs <OrderDeliveryDiscountData > nullObligāts

Piegāde · Atlaides; []: 0; null: Nezināms: null; zināma nulle: 0.

Piemērs: [{"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 Obligāts

Bruto summa · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeVirkne nullObligāts

Piegādes vai maksājuma metodes kods.

Piemērs: "shipping-old"
method_nameVirkne nullObligāts

Piegādes vai maksājuma metodes nosaukums.

Piemērs: "Historic carrier"
netMoneyData nullObligāts

Neto summa · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Obligāts

Bruto summa · Piegāde · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullObligāts

Neto summa · Piegāde · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullObligāts

Nodokļa summa · Piegāde · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullObligāts

Saņemšanas punkts

Piemērs: null
recipient_modeVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi
enum
["full_address", "pickup_contact"]
Piemērs: "full_address"
taxMoneyData nullObligāts

Nodokļa summa · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idVirkne nullObligāts

Nodokļu kategorijas identifikators · Saglabātie pasūtījuma dati; null.

Piemērs: "standard"
tax_category_nameVirkne nullObligāts

Saglabātais nodokļu kategorijas nosaukums; null.

Piemērs: "VAT 23%"
tax_rateVirkne nullObligāts

tax_rate · Saglabātie pasūtījuma dati: "0.23" = 23%; "0" ≠ null.

Piemērs: "0.23"

Papildu lauki: Nē