Hoppa till innehållet
ShopentlyLearn
Svenska

Datascheman: Beställningar

Datascheman: Beställningar. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Leveransadress

AddressData · Schema · Datascheman: Beställningar
address_line_1Sträng nullObligatoriskt

Första adressraden.

address_line_2Sträng nullObligatoriskt

Ytterligare adressuppgifter.

citySträng nullObligatoriskt

Stad eller ort.

country_codeSträng nullObligatoriskt

Landskod.

first_nameSträng nullObligatoriskt

Förnamn.

house_numberSträng nullObligatoriskt

Byggnads- eller husnummer.

last_nameSträng nullObligatoriskt

Efternamn.

phoneSträng nullObligatoriskt

Telefonnummer.

postal_codeSträng nullObligatoriskt

Postnummer.

regionSträng nullObligatoriskt

Administrativ region.

streetSträng nullObligatoriskt

Gatunamn.

Ytterligare fält: Nej

Lista — Beställningar — Svar

ApiResponse_list_OrderSummaryData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataArray <OrderSummaryData > Obligatoriskt

Exempel på svar · ApiResponse_list_OrderSummaryData__.

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

Metadata för svaret.

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

Ytterligare fält: Nej

Hämta — Beställningar — Svar

ApiResponse_OrderDetailData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataOrderDetailData Obligatoriskt

Exempel på svar · OrderDetailData.

Exempel: {"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 Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

Kunduppgifter registrerade för resursen

CustomerData · Schema · Datascheman: Beställningar
emailSträngObligatoriskt

E-postadress.

Exempel: "customer@example.invalid"
first_nameSträng nullObligatoriskt

Förnamn.

Exempel: "Example"
last_nameSträng nullObligatoriskt

Efternamn.

Exempel: "Example"
phoneSträng nullObligatoriskt

Telefonnummer.

Exempel: null

Ytterligare fält: Nej

Avsändnings- och leveransdatum

DeliveryDatesData · Orderlistan och detaljerna innehåller delivery.dates. Datum i YYYY-MM-DD är planerade och bekräftar inte avsändning. Aktuella datum har företräde; äldre beställningar använder den sparade uppskattningen. Raderade eller okända värden är null. Detaljerna innehåller även alla orderrader och produktbilder.
dispatch_timezoneSträng nullObligatoriskt

Tidszon för avsändning (IANA; null).

Exempel: "Europe/Warsaw"
estimated_delivery_fromSträng nullObligatoriskt

Början av beräknad leverans (YYYY-MM-DD; null).

Sträng:format: "date"
Exempel: "2026-10-20"
estimated_delivery_toSträng nullObligatoriskt

Slut på beräknad leverans (YYYY-MM-DD; null).

Sträng:format: "date"
Exempel: "2026-10-21"
planned_dispatch_onSträng nullObligatoriskt

Planerat avsändningsdatum (YYYY-MM-DD; null).

Sträng:format: "date"
Exempel: "2026-10-19"

Ytterligare fält: Nej

DeliveryPickupPointData

DeliveryPickupPointData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
addressPickupPointAddressData Obligatoriskt

Leveransadress.

codeSträngObligatoriskt

Stabil maskinläsbar kod.

Begränsningar
pattern
"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesData nullObligatoriskt

Värde som beskrivs av omgivande schema.

country_codeSträngObligatoriskt

Landskod.

Begränsningar
pattern
"^[A-Z]{2}$"
environmentSträngObligatoriskt

Miljöinformation som hör till posten.

Begränsningar
enum
["live", "sandbox"]
kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["locker", "pickup_point"]
location_descriptionSträng nullObligatoriskt

Beskrivning på valt språk.

Sträng:maxLength: 1000
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 160
opening_hoursSträng nullObligatoriskt

Opening hours

Sträng:maxLength: 500
operatorSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 63
verified_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"

Ytterligare fält: Nej

Fakturauppgifter

InvoiceData · Schema · Datascheman: Beställningar
address_line_1Sträng nullObligatoriskt

Första adressraden.

address_line_2Sträng nullObligatoriskt

Ytterligare adressuppgifter.

citySträng nullObligatoriskt

Stad eller ort.

company_nameSträng nullObligatoriskt

Företagsnamn.

country_codeSträng nullObligatoriskt

Landskod.

house_numberSträng nullObligatoriskt

Byggnads- eller husnummer.

postal_codeSträng nullObligatoriskt

Postnummer.

regionSträng nullObligatoriskt

Administrativ region.

streetSträng nullObligatoriskt

Gatunamn.

tax_identifierSträng nullObligatoriskt

Skatteregistreringsnummer.

tax_schemeSträng nullObligatoriskt

Schema för skatteberäkning.

Ytterligare fält: Nej

Nettobelopp / Skattebelopp / Bruttobelopp

OrderAmountBreakdownData · Belopp och skattesatser kommer från den sparade ordern, inklusive radkorrigeringar. Saknade historiska uppgifter är null och ersätts inte med aktuella katalogsatser. Belopp förblir decimalsträngar.
grossMoneyData Obligatoriskt

Bruttobelopp · Efter rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullObligatoriskt

Nettobelopp · Efter rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullObligatoriskt

Skattebelopp · Efter rabatter; Okänt: null; känt nollvärde: 0.

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

Ytterligare fält: Nej

Frakt · Rabatter

OrderDeliveryDiscountData · Belopp och skattesatser kommer från den sparade ordern, inklusive radkorrigeringar. Saknade historiska uppgifter är null och ersätts inte med aktuella katalogsatser. Belopp förblir decimalsträngar.
amountMoneyData Obligatoriskt

Bruttobelopp · Frakt · Rabatter.

Exempel: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

Exempel: "saved-coupon"
codeSträng nullObligatoriskt

Stabil maskinläsbar kod.

Exempel: "SAVE"
kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["coupon", "promotion"]
Exempel: "coupon"
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Saved coupon"
sequenceHeltal nullObligatoriskt

Position i den ordnade samlingen.

Exempel: 1
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 3

Ytterligare fält: Nej

Hämta — Beställningar — Svar

OrderDetailData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
Exempel: "2026-10-19T10:00:00Z"
customerCustomerData Obligatoriskt

Kunduppgifter registrerade för resursen.

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

Leveranssätt och tillhörande information.

Exempel: {"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 Obligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Exempel: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Obligatoriskt

Rabatter

Exempel: [{"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}]
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (OrderDetailData).

Exempel: "order-0000"
invoiceInvoiceData nullObligatoriskt

Fakturauppgifter.

Exempel: null
invoice_requestedBooleskt värdeObligatoriskt

Anger om en faktura begärdes.

Exempel: false
lifecycle_stateOrderLifecycleState Obligatoriskt

Status i affärslivscykeln.

Exempel: "placed"
linesArray <OrderLineData > Obligatoriskt

Sparade uppgifter för orderrader.

Exempel: [{"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":[]}]
localeSträngObligatoriskt

Språk valt för denna begäran.

Exempel: "pl"
market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

Exempel: "market-pl"
numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "0001"
paymentPaymentData Obligatoriskt

Betalningsuppgifter registrerade för beställningen.

Exempel: {"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 nullObligatoriskt

Utlämningsställe

Exempel: null
prices_include_taxBooleskt värdeObligatoriskt

Anger om angivna priser inkluderar skatt.

Exempel: true
shipping_addressAddressData nullObligatoriskt

Leveransadress.

Exempel: null
shipping_discount_amountMoneyData Obligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Exempel: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligatoriskt

Status som accepteras av den aktuella operationen.

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

Belopp före de tillägg som visas i svaret.

Exempel: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligatoriskt

Skatteinformation.

Exempel: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Obligatoriskt

Skattegrupper · source + tax_rate; unallocated_tax.

Exempel: {"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_codeSträng nullObligatoriskt

Skatteland · Sparade orderuppgifter · ISO 3166-1 alpha-2; null.

Exempel: "PL"
totalMoneyData Obligatoriskt

Totalbelopp.

Exempel: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Obligatoriskt

Summor · net / tax / gross; Före rabatter / Efter rabatter.

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

Ytterligare fält: Nej

Bildens metadata och URL

OrderImageData · Schema · Datascheman: Beställningar
altSträng nullObligatoriskt

Alternativtext för en bild.

sourceSträngValfritt

Källa för registrerad aktivitet.

const: "current_catalog"
Standardvärde: "current_catalog"
urlSträngObligatoriskt

Resursens URL.

Ytterligare fält: Nej

Status i affärslivscykeln

OrderLifecycleState · Schema · Datascheman: Beställningar Sträng
Begränsningar
enum
["placed", "cancelled", "fulfilled", "returned"]

Ytterligare fält: Ja

Sparade uppgifter för orderrader

OrderLineData · Schema · Datascheman: Beställningar
discount_amountMoneyData Obligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Exempel: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Obligatoriskt

Bruttobelopp · Rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObligatoriskt

Nettobelopp · Rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObligatoriskt

Skattebelopp · Rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Obligatoriskt

Rabatter · net / tax / gross.

Exempel: [{"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}]
identifiersObjektYtterligare fält: SträngObligatoriskt

Produktens identifieringskoder.

Exempel: {}
imageOrderImageData nullObligatoriskt

Bildens metadata och URL.

Exempel: null
line_idSträngObligatoriskt

Stabil identifierare för orderraden.

Exempel: "saved-line-a"
manual_discountOrderManualDiscountData nullObligatoriskt

Manuell rabatt; null.

Exempel: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Saved A"
original_totalMoneyData Obligatoriskt

Totalbelopp.

Exempel: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Obligatoriskt

Bruttobelopp · Produkter · Före rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullObligatoriskt

Nettobelopp · Produkter · Före rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullObligatoriskt

Skattebelopp · Produkter · Före rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"46.00","currency":"PLN","minor_units":2}
positionHeltalObligatoriskt

Position i den ordnade samlingen.

Exempel: 1
product_idSträngObligatoriskt

Produktens identifierare.

Exempel: "product-api"
quantityHeltalObligatoriskt

Antal enheter.

Exempel: 2
skuSträngObligatoriskt

Artikelns SKU-kod.

Exempel: "A"
taxMoneyData nullObligatoriskt

Skattebelopp · En enhet · Sparade orderuppgifter; tax ≠ unit_tax; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idSträng nullObligatoriskt

Skattekategorins identifierare · Sparade orderuppgifter; null.

Exempel: "standard"
tax_category_nameSträng nullObligatoriskt

Sparat namn på skattekategorin; null.

Exempel: "VAT 23%"
tax_rateSträng nullObligatoriskt

tax_rate · Sparade orderuppgifter: "0.23" = 23%; "0" ≠ null.

Exempel: "0.23"
totalMoneyData Obligatoriskt

Totalbelopp.

Exempel: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Obligatoriskt

Bruttobelopp · Produkter · Efter rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullObligatoriskt

Nettobelopp · Produkter · Efter rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullObligatoriskt

Skattebelopp · Produkter · Efter rabatter · Sparade orderuppgifter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Obligatoriskt

Bruttobelopp · En enhet · Före rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullObligatoriskt

Nettobelopp · En enhet · Före rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obligatoriskt

Pris per enhet.

Exempel: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullObligatoriskt

Skattebelopp · En enhet · Före rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idSträng nullObligatoriskt

Produktvariantens identifierare.

Exempel: null
variant_optionsArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Obligatoriskt

Variantalternativ kopplade till produkten eller den sparade posten.

Exempel: []

Ytterligare fält: Nej

Manuell rabatt

OrderManualDiscountData · Belopp och skattesatser kommer från den sparade ordern, inklusive radkorrigeringar. Saknade historiska uppgifter är null och ersätts inte med aktuella katalogsatser. Belopp förblir decimalsträngar.
amountMoneyData Obligatoriskt

Bruttobelopp · Manuell rabatt · Sparade orderuppgifter.

Exempel: {"amount":"12.30","currency":"PLN","minor_units":2}
kindSträngObligatoriskt

Rabattyp: percentage / fixed.

Begränsningar
enum
["percentage", "fixed"]
Exempel: "fixed"
valueSträngObligatoriskt

Inställt värde: percentage "10" = 10%; fixed = Bruttobelopp.

Exempel: "12.30"

Ytterligare fält: Nej

Status som accepteras av den aktuella operationen

OrderPaymentStatus · Schema · Datascheman: Beställningar Sträng
Begränsningar
enum
["unpaid", "paid", "failed", "refunded"]

Ytterligare fält: Ja

Status som accepteras av den aktuella operationen

OrderStatusData · Schema · Datascheman: Beställningar
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (OrderStatusData).

Exempel: "status-0"
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Status 0"
updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
Exempel: "2026-10-19T10:00:00Z"
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Lista · Statusar — Beställningar — Svar

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Exempel: "example"
is_initialBooleskt värdeObligatoriskt

Anger om detta är den ursprungliga statusen.

Exempel: false
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Example"
positionHeltalObligatoriskt

Position i den ordnade samlingen.

Exempel: 1

Ytterligare fält: Nej

Lista · Statusar — Beställningar — Svar

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Obligatoriskt

Exempel på svar · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

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

Metadata för svaret.

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

Ytterligare fält: Nej

Uppdatera · Status — Beställningar — Begärans innehåll

OrderStatusUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807
Exempel: 1
status_idSträngObligatoriskt

Identifierare hämtad från relevant statuskatalog.

Begränsningar
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exempel: "example"

Ytterligare fält: Nej

Lista — Beställningar — Svar

OrderSummaryData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
Exempel: "2026-10-19T10:00:00Z"
customerCustomerData Obligatoriskt

Kunduppgifter registrerade för resursen.

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

Leveranssätt och tillhörande information.

Exempel: {"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 Obligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Exempel: {"amount":"24.60","currency":"PLN","minor_units":2}
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (OrderSummaryData).

Exempel: "order-0000"
lifecycle_stateOrderLifecycleState Obligatoriskt

Status i affärslivscykeln.

Exempel: "placed"
localeSträngObligatoriskt

Språk valt för denna begäran.

Exempel: "pl"
market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

Exempel: "market-pl"
numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "0001"
paymentPaymentData Obligatoriskt

Betalningsuppgifter registrerade för beställningen.

Exempel: {"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_taxBooleskt värdeObligatoriskt

Anger om angivna priser inkluderar skatt.

Exempel: true
shipping_discount_amountMoneyData Obligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Exempel: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligatoriskt

Status som accepteras av den aktuella operationen.

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

Belopp före de tillägg som visas i svaret.

Exempel: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligatoriskt

Skatteinformation.

Exempel: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeSträng nullObligatoriskt

Skatteland · Sparade orderuppgifter · ISO 3166-1 alpha-2; null.

Exempel: "PL"
totalMoneyData Obligatoriskt

Totalbelopp.

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

Ytterligare fält: Nej

Beställning · Skattegrupper

OrderTaxBreakdownData · Belopp och skattesatser kommer från den sparade ordern, inklusive radkorrigeringar. Saknade historiska uppgifter är null och ersätts inte med aktuella katalogsatser. Belopp förblir decimalsträngar.
groupsArray <OrderTaxGroupData > Obligatoriskt

Skattegrupper · source + tax_rate; Okänt: null; känt nollvärde: 0.

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

Ej fördelad skatt = order.tax − Σ groups.tax; ±.

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

Ytterligare fält: Nej

Skattegrupper

OrderTaxGroupData · Belopp och skattesatser kommer från den sparade ordern, inklusive radkorrigeringar. Saknade historiska uppgifter är null och ersätts inte med aktuella katalogsatser. Belopp förblir decimalsträngar.
grossMoneyData Obligatoriskt

Bruttobelopp · Efter rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullObligatoriskt

Nettobelopp · Efter rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceSträngObligatoriskt

Källa: products (Produkter), shipping (Frakt).

Begränsningar
enum
["products", "shipping"]
Exempel: "products"
taxMoneyData nullObligatoriskt

Skattebelopp · Efter rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateSträng nullObligatoriskt

tax_rate · Sparade orderuppgifter: "0.23" = 23%; "0" ≠ null.

Exempel: "0.23"

Ytterligare fält: Nej

Beställning · Summor

OrderTotalsData · Belopp och skattesatser kommer från den sparade ordern, inklusive radkorrigeringar. Saknade historiska uppgifter är null och ersätts inte med aktuella katalogsatser. Belopp förblir decimalsträngar.
before_discountsOrderAmountBreakdownData Obligatoriskt

Beställning · Före rabatter · net / tax / gross.

Exempel: {"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 Obligatoriskt

Rabatter · net / tax / gross.

Exempel: {"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 Obligatoriskt

Beställning · Efter rabatter · net / tax / gross.

Exempel: {"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 Obligatoriskt

Produkter · Rabatter · net / tax / gross.

Exempel: {"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 Obligatoriskt

Produkter · Efter rabatter · net / tax / gross.

Exempel: {"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 Obligatoriskt

Produkter · Före rabatter · net / tax / gross.

Exempel: {"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 Obligatoriskt

Frakt · Efter rabatter · net / tax / gross.

Exempel: {"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 Obligatoriskt

Frakt · Före rabatter · net / tax / gross.

Exempel: {"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 Obligatoriskt

Frakt · Rabatter · net / tax / gross.

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

Ytterligare fält: Nej

Variantalternativ kopplade till produkten eller den sparade posten

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Schema · Datascheman: Beställningar
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

valueSträngObligatoriskt

Värde som beskrivs av omgivande schema.

Ytterligare fält: Nej

OrderDiscountData

OrderDiscountData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
amountMoneyData Obligatoriskt

Bruttobelopp · Produkter · Rabatter.

Exempel: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

Exempel: "saved-coupon"
codeSträng nullObligatoriskt

Stabil maskinläsbar kod.

Exempel: "SAVE"
kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["coupon", "promotion"]
Exempel: "coupon"
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Saved coupon"
sequenceHeltal nullValfritt

Tillämpningsordning; null.

Exempel: 1
shipping_amountMoneyData nullValfritt

Bruttobelopp · Frakt · Rabatter; null.

Exempel: {"amount":"24.60","currency":"PLN","minor_units":2}
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 3

Ytterligare fält: Nej

Betalningsuppgifter registrerade för beställningen

PaymentData · Schema · Datascheman: Beställningar
amountMoneyData Obligatoriskt

payment.amount är orderns totalbelopp. Betalningsstatus avgör inte betalda, återbetalda eller återstående belopp.

Exempel: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentSträngObligatoriskt

Miljöinformation som hör till posten.

Begränsningar
enum
["live", "sandbox"]
Exempel: "live"
method_codeSträng nullObligatoriskt

Kod för leverans- eller betalningsmetod.

Exempel: "payment-old"
method_nameSträng nullObligatoriskt

Namn på leverans- eller betalningsmetod.

Exempel: "Historic method"
paid_atSträng nullObligatoriskt

Datum och tid när betalningen markerades som betald.

Sträng:format: "date-time"
Exempel: null
statusOrderPaymentStatus Obligatoriskt

Status som accepteras av den aktuella operationen.

Exempel: "unpaid"
updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
Exempel: "2026-10-19T10:00:00Z"
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 0

Ytterligare fält: Nej

Uppdatera · Betalningsstatus — Beställningar — Begärans innehåll

PaymentStatusUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 0maximum: 9223372036854775807
Exempel: 1
reasonSträngObligatoriskt

Registrerad orsak till ändringen.

minLength: 1maxLength: 500
Exempel: "Example"
statusPaymentStatus Obligatoriskt

Status som accepteras av den aktuella operationen.

Exempel: "paid"

Ytterligare fält: Nej

Status som accepteras av den aktuella operationen

PaymentStatus · Schema · Datascheman: Beställningar Sträng
Begränsningar
enum
["unpaid", "paid", "failed", "refunded"]

Ytterligare fält: Ja

PickupPointAddressData

PickupPointAddressData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
address_line_1SträngObligatoriskt

Första adressraden.

minLength: 1maxLength: 240
citySträngObligatoriskt

Stad eller ort.

minLength: 1maxLength: 160
postal_codeSträngObligatoriskt

Postnummer.

minLength: 1maxLength: 32

Ytterligare fält: Nej

PickupPointCoordinatesData

PickupPointCoordinatesData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
latitudeTalObligatoriskt

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeTalObligatoriskt

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Ytterligare fält: Nej

PickupPointData

PickupPointData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
address_line1SträngObligatoriskt

Första adressraden.

citySträngObligatoriskt

Stad eller ort.

codeSträngObligatoriskt

Stabil maskinläsbar kod.

country_codeSträngObligatoriskt

Landskod.

kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["locker", "pickup_point"]
latitudeTal nullObligatoriskt

WGS84 φ (°)

location_descriptionSträng nullObligatoriskt

Beskrivning på valt språk.

longitudeTal nullObligatoriskt

WGS84 λ (°)

nameSträngObligatoriskt

Resursens namn i aktuell kontext.

opening_hoursSträng nullObligatoriskt

Opening hours

operatorSträngObligatoriskt

Resursens namn i aktuell kontext.

postal_codeSträngObligatoriskt

Postnummer.

Ytterligare fält: Nej

PickupPointSummaryData

PickupPointSummaryData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
codeSträngObligatoriskt

Stabil maskinläsbar kod.

Begränsningar
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeSträngObligatoriskt

Landskod.

Begränsningar
pattern
"^[A-Z]{2}$"
environmentSträngObligatoriskt

Miljöinformation som hör till posten.

Begränsningar
enum
["live", "sandbox"]
kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["locker", "pickup_point"]
operatorSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 63

Ytterligare fält: Nej

Kunduppgifter registrerade för resursen

RequestCustomerData · Schema · Datascheman: Beställningar
emailSträngObligatoriskt

E-postadress.

Exempel: "customer@example.invalid"
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Example"

Ytterligare fält: Nej

Leveranssätt och tillhörande information

ShippingData · Schema · Datascheman: Beställningar
amountMoneyData Obligatoriskt

Fraktbelopp inklusive skatt som sparats i beställningen som MoneyData. Senare skatteändringar ändrar inte detta historiska belopp.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Obligatoriskt

Avsändnings- och leveransdatum. Orderlistan och detaljerna innehåller delivery.dates. Datum i YYYY-MM-DD är planerade och bekräftar inte avsändning. Aktuella datum har företräde; äldre beställningar använder den sparade uppskattningen. Raderade eller okända värden är null. Detaljerna innehåller även alla orderrader och produktbilder.

Exempel: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
method_codeSträng nullObligatoriskt

Kod för leverans- eller betalningsmetod.

Exempel: "shipping-old"
method_nameSträng nullObligatoriskt

Namn på leverans- eller betalningsmetod.

Exempel: "Historic carrier"
pickup_pointPickupPointSummaryData nullObligatoriskt

Utlämningsställe

Exempel: null
recipient_modeSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["full_address", "pickup_contact"]
Exempel: "full_address"

Ytterligare fält: Nej

ShippingDetailData

ShippingDetailData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
amountMoneyData Obligatoriskt

Fraktbelopp inklusive skatt som sparats i beställningen som MoneyData. Senare skatteändringar ändrar inte detta historiska belopp.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Obligatoriskt

Avsändnings- och leveransdatum. Orderlistan och detaljerna innehåller delivery.dates. Datum i YYYY-MM-DD är planerade och bekräftar inte avsändning. Aktuella datum har företräde; äldre beställningar använder den sparade uppskattningen. Raderade eller okända värden är null. Detaljerna innehåller även alla orderrader och produktbilder.

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

Bruttobelopp · Rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObligatoriskt

Nettobelopp · Rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObligatoriskt

Skattebelopp · Rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsArray <OrderDeliveryDiscountData > nullObligatoriskt

Frakt · Rabatter; []: 0; null: Okänt: null; känt nollvärde: 0.

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

Bruttobelopp · Efter rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeSträng nullObligatoriskt

Kod för leverans- eller betalningsmetod.

Exempel: "shipping-old"
method_nameSträng nullObligatoriskt

Namn på leverans- eller betalningsmetod.

Exempel: "Historic carrier"
netMoneyData nullObligatoriskt

Nettobelopp · Efter rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Obligatoriskt

Bruttobelopp · Frakt · Före rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullObligatoriskt

Nettobelopp · Frakt · Före rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullObligatoriskt

Skattebelopp · Frakt · Före rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullObligatoriskt

Utlämningsställe

Exempel: null
recipient_modeSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["full_address", "pickup_contact"]
Exempel: "full_address"
taxMoneyData nullObligatoriskt

Skattebelopp · Efter rabatter; Okänt: null; känt nollvärde: 0.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idSträng nullObligatoriskt

Skattekategorins identifierare · Sparade orderuppgifter; null.

Exempel: "standard"
tax_category_nameSträng nullObligatoriskt

Sparat namn på skattekategorin; null.

Exempel: "VAT 23%"
tax_rateSträng nullObligatoriskt

tax_rate · Sparade orderuppgifter: "0.23" = 23%; "0" ≠ null.

Exempel: "0.23"

Ytterligare fält: Nej