Gå til indhold
ShopentlyLearn
Dansk

Dataskemaer: Ordrer

Dataskemaer: Ordrer. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

Leveringsadresse

AddressData · Skema · Dataskemaer: Ordrer
address_line_1Streng nullObligatorisk

Første adresselinje.

address_line_2Streng nullObligatorisk

Yderligere adresseoplysninger.

cityStreng nullObligatorisk

By eller lokalitet.

country_codeStreng nullObligatorisk

Landekode.

first_nameStreng nullObligatorisk

Fornavn.

house_numberStreng nullObligatorisk

Bygnings- eller husnummer.

last_nameStreng nullObligatorisk

Efternavn.

phoneStreng nullObligatorisk

Telefonnummer.

postal_codeStreng nullObligatorisk

Postnummer.

regionStreng nullObligatorisk

Administrativ region.

streetStreng nullObligatorisk

Gadenavn.

Yderligere felter: Nej

Vis liste — Ordrer — Svar

ApiResponse_list_OrderSummaryData__ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
dataArray <OrderSummaryData > Obligatorisk

Eksempel på svar · ApiResponse_list_OrderSummaryData__.

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

Svarmetadata.

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

Yderligere felter: Nej

Hent — Ordrer — Svar

ApiResponse_OrderDetailData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
dataOrderDetailData Obligatorisk

Eksempel på svar · OrderDetailData.

Eksempel: {"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 Obligatorisk

Svarmetadata.

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

Yderligere felter: Nej

Kundeoplysninger registreret for denne ressource

CustomerData · Skema · Dataskemaer: Ordrer
emailStrengObligatorisk

E-mailadresse.

Eksempel: "customer@example.invalid"
first_nameStreng nullObligatorisk

Fornavn.

Eksempel: "Example"
last_nameStreng nullObligatorisk

Efternavn.

Eksempel: "Example"
phoneStreng nullObligatorisk

Telefonnummer.

Eksempel: null

Yderligere felter: Nej

Afsendelses- og leveringsdatoer

DeliveryDatesData · Ordrelisten og detaljer indeholder delivery.dates. Datoer i YYYY-MM-DD er planlagte og bekræfter ikke afsendelse. Aktuelle datoer har forrang; ældre ordrer bruger det gemte estimat. Slettede eller ukendte værdier er null. Detaljer indeholder også alle ordrelinjer og produktbilleder.
dispatch_timezoneStreng nullObligatorisk

Afsendelsens tidszone (IANA; null).

Eksempel: "Europe/Warsaw"
estimated_delivery_fromStreng nullObligatorisk

Start på forventet levering (YYYY-MM-DD; null).

Streng:format: "date"
Eksempel: "2026-10-20"
estimated_delivery_toStreng nullObligatorisk

Slut på forventet levering (YYYY-MM-DD; null).

Streng:format: "date"
Eksempel: "2026-10-21"
planned_dispatch_onStreng nullObligatorisk

Planlagt afsendelsesdato (YYYY-MM-DD; null).

Streng:format: "date"
Eksempel: "2026-10-19"

Yderligere felter: Nej

DeliveryPickupPointData

DeliveryPickupPointData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
addressPickupPointAddressData Obligatorisk

Leveringsadresse.

codeStrengObligatorisk

Stabil maskinlæsbar kode.

Begrænsninger
pattern
"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesData nullObligatorisk

Værdi beskrevet af det omgivende skema.

country_codeStrengObligatorisk

Landekode.

Begrænsninger
pattern
"^[A-Z]{2}$"
environmentStrengObligatorisk

Miljøoplysninger knyttet til posten.

Begrænsninger
enum
["live", "sandbox"]
kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger
enum
["locker", "pickup_point"]
location_descriptionStreng nullObligatorisk

Beskrivelse på det valgte sprog.

Streng:maxLength: 1000
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

minLength: 1maxLength: 160
opening_hoursStreng nullObligatorisk

Opening hours

Streng:maxLength: 500
operatorStrengObligatorisk

Ressourcens navn i den relevante kontekst.

minLength: 1maxLength: 63
verified_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"

Yderligere felter: Nej

Fakturaoplysninger

InvoiceData · Skema · Dataskemaer: Ordrer
address_line_1Streng nullObligatorisk

Første adresselinje.

address_line_2Streng nullObligatorisk

Yderligere adresseoplysninger.

cityStreng nullObligatorisk

By eller lokalitet.

company_nameStreng nullObligatorisk

Virksomhedsnavn.

country_codeStreng nullObligatorisk

Landekode.

house_numberStreng nullObligatorisk

Bygnings- eller husnummer.

postal_codeStreng nullObligatorisk

Postnummer.

regionStreng nullObligatorisk

Administrativ region.

streetStreng nullObligatorisk

Gadenavn.

tax_identifierStreng nullObligatorisk

Skatteidentifikationsnummer.

tax_schemeStreng nullObligatorisk

Ordning for afgiftsberegning.

Yderligere felter: Nej

Nettobeløb / Skattebeløb / Bruttobeløb

OrderAmountBreakdownData · Beløb og satser kommer fra den gemte ordre, inklusive rettelser af linjer. Manglende historiske oplysninger er null og erstattes ikke med katalogets aktuelle satser. Beløb forbliver decimalstrenge.
grossMoneyData Obligatorisk

Bruttobeløb · Efter rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullObligatorisk

Nettobeløb · Efter rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullObligatorisk

Skattebeløb · Efter rabatter; Ukendt: null; kendt nul: 0.

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

Yderligere felter: Nej

Fragt · Rabatter

OrderDeliveryDiscountData · Beløb og satser kommer fra den gemte ordre, inklusive rettelser af linjer. Manglende historiske oplysninger er null og erstattes ikke med katalogets aktuelle satser. Beløb forbliver decimalstrenge.
amountMoneyData Obligatorisk

Bruttobeløb · Fragt · Rabatter.

Eksempel: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

Eksempel: "saved-coupon"
codeStreng nullObligatorisk

Stabil maskinlæsbar kode.

Eksempel: "SAVE"
kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger
enum
["coupon", "promotion"]
Eksempel: "coupon"
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Saved coupon"
sequenceHeltal nullObligatorisk

Placering i den sorterede samling.

Eksempel: 1
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 3

Yderligere felter: Nej

Hent — Ordrer — Svar

OrderDetailData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-10-19T10:00:00Z"
customerCustomerData Obligatorisk

Kundeoplysninger registreret for denne ressource.

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

Leveringsmetode og tilhørende oplysninger.

Eksempel: {"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 Obligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Eksempel: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Obligatorisk

Rabatter

Eksempel: [{"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}]
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (OrderDetailData).

Eksempel: "order-0000"
invoiceInvoiceData nullObligatorisk

Fakturaoplysninger.

Eksempel: null
invoice_requestedBoolesk værdiObligatorisk

Om der blev anmodet om en faktura.

Eksempel: false
lifecycle_stateOrderLifecycleState Obligatorisk

Tilstand i forretningslivscyklussen.

Eksempel: "placed"
linesArray <OrderLineData > Obligatorisk

Øjebliksbilleder af ordrelinjer.

Eksempel: [{"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":[]}]
localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

Eksempel: "pl"
market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

Eksempel: "market-pl"
numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "0001"
paymentPaymentData Obligatorisk

Betalingsoplysninger registreret for ordren.

Eksempel: {"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 nullObligatorisk

Afhentningssted

Eksempel: null
prices_include_taxBoolesk værdiObligatorisk

Om de angivne priser inkluderer afgifter.

Eksempel: true
shipping_addressAddressData nullObligatorisk

Leveringsadresse.

Eksempel: null
shipping_discount_amountMoneyData Obligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Eksempel: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligatorisk

Status accepteret af denne specifikke operation.

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

Beløb før de yderligere bestanddele vist i svaret.

Eksempel: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligatorisk

Afgiftsoplysninger.

Eksempel: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Obligatorisk

Skattegrupper · source + tax_rate; unallocated_tax.

Eksempel: {"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_codeStreng nullObligatorisk

Skatteland · Gemte ordredata · ISO 3166-1 alpha-2; null.

Eksempel: "PL"
totalMoneyData Obligatorisk

Samlet beløb.

Eksempel: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Obligatorisk

Totaler · net / tax / gross; Før rabatter / Efter rabatter.

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

Yderligere felter: Nej

Billedmetadata og URL

OrderImageData · Skema · Dataskemaer: Ordrer
altStreng nullObligatorisk

Alternativ tekst til et billede.

sourceStrengValgfrit

Kilden til den registrerede aktivitet.

const: "current_catalog"
Standard: "current_catalog"
urlStrengObligatorisk

Ressourcens URL.

Yderligere felter: Nej

Tilstand i forretningslivscyklussen

OrderLifecycleState · Skema · Dataskemaer: Ordrer Streng
Begrænsninger
enum
["placed", "cancelled", "fulfilled", "returned"]

Yderligere felter: Ja

Øjebliksbilleder af ordrelinjer

OrderLineData · Skema · Dataskemaer: Ordrer
discount_amountMoneyData Obligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Eksempel: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Obligatorisk

Bruttobeløb · Rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObligatorisk

Nettobeløb · Rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObligatorisk

Skattebeløb · Rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Obligatorisk

Rabatter · net / tax / gross.

Eksempel: [{"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}]
identifiersObjektYderligere felter: StrengObligatorisk

Produktidentifikationskoder.

Eksempel: {}
imageOrderImageData nullObligatorisk

Billedmetadata og URL.

Eksempel: null
line_idStrengObligatorisk

Stabil identifikator for ordrelinjen.

Eksempel: "saved-line-a"
manual_discountOrderManualDiscountData nullObligatorisk

Manuel rabat; null.

Eksempel: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Saved A"
original_totalMoneyData Obligatorisk

Samlet beløb.

Eksempel: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Obligatorisk

Bruttobeløb · Produkter · Før rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullObligatorisk

Nettobeløb · Produkter · Før rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullObligatorisk

Skattebeløb · Produkter · Før rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"46.00","currency":"PLN","minor_units":2}
positionHeltalObligatorisk

Placering i den sorterede samling.

Eksempel: 1
product_idStrengObligatorisk

Produktidentifikator.

Eksempel: "product-api"
quantityHeltalObligatorisk

Antal enheder.

Eksempel: 2
skuStrengObligatorisk

SKU-varekode.

Eksempel: "A"
taxMoneyData nullObligatorisk

Skattebeløb · En enhed · Gemte ordredata; tax ≠ unit_tax; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idStreng nullObligatorisk

Skattekategoriens identifikator · Gemte ordredata; null.

Eksempel: "standard"
tax_category_nameStreng nullObligatorisk

Gemt navn på skattekategorien; null.

Eksempel: "VAT 23%"
tax_rateStreng nullObligatorisk

tax_rate · Gemte ordredata: "0.23" = 23%; "0" ≠ null.

Eksempel: "0.23"
totalMoneyData Obligatorisk

Samlet beløb.

Eksempel: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Obligatorisk

Bruttobeløb · Produkter · Efter rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullObligatorisk

Nettobeløb · Produkter · Efter rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullObligatorisk

Skattebeløb · Produkter · Efter rabatter · Gemte ordredata; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Obligatorisk

Bruttobeløb · En enhed · Før rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullObligatorisk

Nettobeløb · En enhed · Før rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obligatorisk

Pris for én enhed.

Eksempel: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullObligatorisk

Skattebeløb · En enhed · Før rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idStreng nullObligatorisk

Produktvariantidentifikator.

Eksempel: null
variant_optionsArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Obligatorisk

Variantvalg knyttet til produktet eller øjebliksbilledet.

Eksempel: []

Yderligere felter: Nej

Manuel rabat

OrderManualDiscountData · Beløb og satser kommer fra den gemte ordre, inklusive rettelser af linjer. Manglende historiske oplysninger er null og erstattes ikke med katalogets aktuelle satser. Beløb forbliver decimalstrenge.
amountMoneyData Obligatorisk

Bruttobeløb · Manuel rabat · Gemte ordredata.

Eksempel: {"amount":"12.30","currency":"PLN","minor_units":2}
kindStrengObligatorisk

Rabattype: percentage / fixed.

Begrænsninger
enum
["percentage", "fixed"]
Eksempel: "fixed"
valueStrengObligatorisk

Indstillet værdi: percentage "10" = 10%; fixed = Bruttobeløb.

Eksempel: "12.30"

Yderligere felter: Nej

Status accepteret af denne specifikke operation

OrderPaymentStatus · Skema · Dataskemaer: Ordrer Streng
Begrænsninger
enum
["unpaid", "paid", "failed", "refunded"]

Yderligere felter: Ja

Status accepteret af denne specifikke operation

OrderStatusData · Skema · Dataskemaer: Ordrer
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (OrderStatusData).

Eksempel: "status-0"
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Status 0"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
Eksempel: "2026-10-19T10:00:00Z"
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Vis liste · Statusser — Ordrer — Svar

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Eksempel: "example"
is_initialBoolesk værdiObligatorisk

Om dette er startstatus.

Eksempel: false
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
positionHeltalObligatorisk

Placering i den sorterede samling.

Eksempel: 1

Yderligere felter: Nej

Vis liste · Statusser — Ordrer — Svar

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
dataArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Obligatorisk

Eksempel på svar · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

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

Svarmetadata.

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

Yderligere felter: Nej

Opdater · Status — Ordrer — Forespørgselsindhold

OrderStatusUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
status_idStrengObligatorisk

Identifikator hentet fra den relevante statusliste.

Begrænsninger
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Eksempel: "example"

Yderligere felter: Nej

Vis liste — Ordrer — Svar

OrderSummaryData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-10-19T10:00:00Z"
customerCustomerData Obligatorisk

Kundeoplysninger registreret for denne ressource.

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

Leveringsmetode og tilhørende oplysninger.

Eksempel: {"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 Obligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Eksempel: {"amount":"24.60","currency":"PLN","minor_units":2}
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (OrderSummaryData).

Eksempel: "order-0000"
lifecycle_stateOrderLifecycleState Obligatorisk

Tilstand i forretningslivscyklussen.

Eksempel: "placed"
localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

Eksempel: "pl"
market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

Eksempel: "market-pl"
numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "0001"
paymentPaymentData Obligatorisk

Betalingsoplysninger registreret for ordren.

Eksempel: {"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_taxBoolesk værdiObligatorisk

Om de angivne priser inkluderer afgifter.

Eksempel: true
shipping_discount_amountMoneyData Obligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Eksempel: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligatorisk

Status accepteret af denne specifikke operation.

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

Beløb før de yderligere bestanddele vist i svaret.

Eksempel: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligatorisk

Afgiftsoplysninger.

Eksempel: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeStreng nullObligatorisk

Skatteland · Gemte ordredata · ISO 3166-1 alpha-2; null.

Eksempel: "PL"
totalMoneyData Obligatorisk

Samlet beløb.

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

Yderligere felter: Nej

Ordre · Skattegrupper

OrderTaxBreakdownData · Beløb og satser kommer fra den gemte ordre, inklusive rettelser af linjer. Manglende historiske oplysninger er null og erstattes ikke med katalogets aktuelle satser. Beløb forbliver decimalstrenge.
groupsArray <OrderTaxGroupData > Obligatorisk

Skattegrupper · source + tax_rate; Ukendt: null; kendt nul: 0.

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

Ikke fordelt skat = order.tax − Σ groups.tax; ±.

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

Yderligere felter: Nej

Skattegrupper

OrderTaxGroupData · Beløb og satser kommer fra den gemte ordre, inklusive rettelser af linjer. Manglende historiske oplysninger er null og erstattes ikke med katalogets aktuelle satser. Beløb forbliver decimalstrenge.
grossMoneyData Obligatorisk

Bruttobeløb · Efter rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullObligatorisk

Nettobeløb · Efter rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceStrengObligatorisk

Kilde: products (Produkter), shipping (Fragt).

Begrænsninger
enum
["products", "shipping"]
Eksempel: "products"
taxMoneyData nullObligatorisk

Skattebeløb · Efter rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateStreng nullObligatorisk

tax_rate · Gemte ordredata: "0.23" = 23%; "0" ≠ null.

Eksempel: "0.23"

Yderligere felter: Nej

Ordre · Totaler

OrderTotalsData · Beløb og satser kommer fra den gemte ordre, inklusive rettelser af linjer. Manglende historiske oplysninger er null og erstattes ikke med katalogets aktuelle satser. Beløb forbliver decimalstrenge.
before_discountsOrderAmountBreakdownData Obligatorisk

Ordre · Før rabatter · net / tax / gross.

Eksempel: {"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 Obligatorisk

Rabatter · net / tax / gross.

Eksempel: {"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 Obligatorisk

Ordre · Efter rabatter · net / tax / gross.

Eksempel: {"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 Obligatorisk

Produkter · Rabatter · net / tax / gross.

Eksempel: {"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 Obligatorisk

Produkter · Efter rabatter · net / tax / gross.

Eksempel: {"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 Obligatorisk

Produkter · Før rabatter · net / tax / gross.

Eksempel: {"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 Obligatorisk

Fragt · Efter rabatter · net / tax / gross.

Eksempel: {"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 Obligatorisk

Fragt · Før rabatter · net / tax / gross.

Eksempel: {"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 Obligatorisk

Fragt · Rabatter · net / tax / gross.

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

Yderligere felter: Nej

Variantvalg knyttet til produktet eller øjebliksbilledet

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Skema · Dataskemaer: Ordrer
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

valueStrengObligatorisk

Værdi beskrevet af det omgivende skema.

Yderligere felter: Nej

OrderDiscountData

OrderDiscountData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
amountMoneyData Obligatorisk

Bruttobeløb · Produkter · Rabatter.

Eksempel: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

Eksempel: "saved-coupon"
codeStreng nullObligatorisk

Stabil maskinlæsbar kode.

Eksempel: "SAVE"
kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger
enum
["coupon", "promotion"]
Eksempel: "coupon"
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Saved coupon"
sequenceHeltal nullValgfrit

Anvendelsesrækkefølge; null.

Eksempel: 1
shipping_amountMoneyData nullValgfrit

Bruttobeløb · Fragt · Rabatter; null.

Eksempel: {"amount":"24.60","currency":"PLN","minor_units":2}
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 3

Yderligere felter: Nej

Betalingsoplysninger registreret for ordren

PaymentData · Skema · Dataskemaer: Ordrer
amountMoneyData Obligatorisk

payment.amount er ordretotalen. Betalingsstatus bestemmer ikke betalte, refunderede eller udestående beløb.

Eksempel: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentStrengObligatorisk

Miljøoplysninger knyttet til posten.

Begrænsninger
enum
["live", "sandbox"]
Eksempel: "live"
method_codeStreng nullObligatorisk

Kode for leverings- eller betalingsmetode.

Eksempel: "payment-old"
method_nameStreng nullObligatorisk

Navn på leverings- eller betalingsmetode.

Eksempel: "Historic method"
paid_atStreng nullObligatorisk

Dato og tidspunkt, hvor betalingen blev markeret som betalt.

Streng:format: "date-time"
Eksempel: null
statusOrderPaymentStatus Obligatorisk

Status accepteret af denne specifikke operation.

Eksempel: "unpaid"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
Eksempel: "2026-10-19T10:00:00Z"
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 0

Yderligere felter: Nej

Opdater · Betalingsstatus — Ordrer — Forespørgselsindhold

PaymentStatusUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 0maximum: 9223372036854775807
Eksempel: 1
reasonStrengObligatorisk

Registreret begrundelse for ændringen.

minLength: 1maxLength: 500
Eksempel: "Example"
statusPaymentStatus Obligatorisk

Status accepteret af denne specifikke operation.

Eksempel: "paid"

Yderligere felter: Nej

Status accepteret af denne specifikke operation

PaymentStatus · Skema · Dataskemaer: Ordrer Streng
Begrænsninger
enum
["unpaid", "paid", "failed", "refunded"]

Yderligere felter: Ja

PickupPointAddressData

PickupPointAddressData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
address_line_1StrengObligatorisk

Første adresselinje.

minLength: 1maxLength: 240
cityStrengObligatorisk

By eller lokalitet.

minLength: 1maxLength: 160
postal_codeStrengObligatorisk

Postnummer.

minLength: 1maxLength: 32

Yderligere felter: Nej

PickupPointCoordinatesData

PickupPointCoordinatesData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
latitudeTalObligatorisk

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeTalObligatorisk

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Yderligere felter: Nej

PickupPointData

PickupPointData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
address_line1StrengObligatorisk

Første adresselinje.

cityStrengObligatorisk

By eller lokalitet.

codeStrengObligatorisk

Stabil maskinlæsbar kode.

country_codeStrengObligatorisk

Landekode.

kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger
enum
["locker", "pickup_point"]
latitudeTal nullObligatorisk

WGS84 φ (°)

location_descriptionStreng nullObligatorisk

Beskrivelse på det valgte sprog.

longitudeTal nullObligatorisk

WGS84 λ (°)

nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

opening_hoursStreng nullObligatorisk

Opening hours

operatorStrengObligatorisk

Ressourcens navn i den relevante kontekst.

postal_codeStrengObligatorisk

Postnummer.

Yderligere felter: Nej

PickupPointSummaryData

PickupPointSummaryData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
codeStrengObligatorisk

Stabil maskinlæsbar kode.

Begrænsninger
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeStrengObligatorisk

Landekode.

Begrænsninger
pattern
"^[A-Z]{2}$"
environmentStrengObligatorisk

Miljøoplysninger knyttet til posten.

Begrænsninger
enum
["live", "sandbox"]
kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger
enum
["locker", "pickup_point"]
operatorStrengObligatorisk

Ressourcens navn i den relevante kontekst.

minLength: 1maxLength: 63

Yderligere felter: Nej

Kundeoplysninger registreret for denne ressource

RequestCustomerData · Skema · Dataskemaer: Ordrer
emailStrengObligatorisk

E-mailadresse.

Eksempel: "customer@example.invalid"
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"

Yderligere felter: Nej

Leveringsmetode og tilhørende oplysninger

ShippingData · Skema · Dataskemaer: Ordrer
amountMoneyData Obligatorisk

Fragtbeløb inklusive moms gemt på ordren som MoneyData. Senere afgiftsændringer ændrer ikke dette historiske beløb.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Obligatorisk

Afsendelses- og leveringsdatoer. Ordrelisten og detaljer indeholder delivery.dates. Datoer i YYYY-MM-DD er planlagte og bekræfter ikke afsendelse. Aktuelle datoer har forrang; ældre ordrer bruger det gemte estimat. Slettede eller ukendte værdier er null. Detaljer indeholder også alle ordrelinjer og produktbilleder.

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

Kode for leverings- eller betalingsmetode.

Eksempel: "shipping-old"
method_nameStreng nullObligatorisk

Navn på leverings- eller betalingsmetode.

Eksempel: "Historic carrier"
pickup_pointPickupPointSummaryData nullObligatorisk

Afhentningssted

Eksempel: null
recipient_modeStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger
enum
["full_address", "pickup_contact"]
Eksempel: "full_address"

Yderligere felter: Nej

ShippingDetailData

ShippingDetailData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
amountMoneyData Obligatorisk

Fragtbeløb inklusive moms gemt på ordren som MoneyData. Senere afgiftsændringer ændrer ikke dette historiske beløb.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Obligatorisk

Afsendelses- og leveringsdatoer. Ordrelisten og detaljer indeholder delivery.dates. Datoer i YYYY-MM-DD er planlagte og bekræfter ikke afsendelse. Aktuelle datoer har forrang; ældre ordrer bruger det gemte estimat. Slettede eller ukendte værdier er null. Detaljer indeholder også alle ordrelinjer og produktbilleder.

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

Bruttobeløb · Rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObligatorisk

Nettobeløb · Rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObligatorisk

Skattebeløb · Rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsArray <OrderDeliveryDiscountData > nullObligatorisk

Fragt · Rabatter; []: 0; null: Ukendt: null; kendt nul: 0.

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

Bruttobeløb · Efter rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeStreng nullObligatorisk

Kode for leverings- eller betalingsmetode.

Eksempel: "shipping-old"
method_nameStreng nullObligatorisk

Navn på leverings- eller betalingsmetode.

Eksempel: "Historic carrier"
netMoneyData nullObligatorisk

Nettobeløb · Efter rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Obligatorisk

Bruttobeløb · Fragt · Før rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullObligatorisk

Nettobeløb · Fragt · Før rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullObligatorisk

Skattebeløb · Fragt · Før rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullObligatorisk

Afhentningssted

Eksempel: null
recipient_modeStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger
enum
["full_address", "pickup_contact"]
Eksempel: "full_address"
taxMoneyData nullObligatorisk

Skattebeløb · Efter rabatter; Ukendt: null; kendt nul: 0.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idStreng nullObligatorisk

Skattekategoriens identifikator · Gemte ordredata; null.

Eksempel: "standard"
tax_category_nameStreng nullObligatorisk

Gemt navn på skattekategorien; null.

Eksempel: "VAT 23%"
tax_rateStreng nullObligatorisk

tax_rate · Gemte ordredata: "0.23" = 23%; "0" ≠ null.

Eksempel: "0.23"

Yderligere felter: Nej