Gå til innhold
ShopentlyLearn
Norsk bokmål

Dataskjemaer: Ordrer

Dataskjemaer: Ordrer. Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Dataskjemaer

Leveringsadresse

AddressData · Skjema · Dataskjemaer: Ordrer
address_line_1Streng nullObligatorisk

Første adresselinje.

address_line_2Streng nullObligatorisk

Ytterligere adresseinformasjon.

cityStreng nullObligatorisk

By eller sted.

country_codeStreng nullObligatorisk

Landskode.

first_nameStreng nullObligatorisk

Fornavn.

house_numberStreng nullObligatorisk

Bygnings- eller husnummer.

last_nameStreng nullObligatorisk

Etternavn.

phoneStreng nullObligatorisk

Telefonnummer.

postal_codeStreng nullObligatorisk

Postnummer.

regionStreng nullObligatorisk

Administrativ region.

streetStreng nullObligatorisk

Gatenavn.

Ytterligere felt: Nei

Vis liste — Ordrer — Svar

ApiResponse_list_OrderSummaryData__ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Hent — Ordrer — Svar

ApiResponse_OrderDetailData_ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Kundeinformasjon registrert for denne ressursen

CustomerData · Skjema · Dataskjemaer: Ordrer
emailStrengObligatorisk

E-postadresse.

Eksempel: "customer@example.invalid"
first_nameStreng nullObligatorisk

Fornavn.

Eksempel: "Example"
last_nameStreng nullObligatorisk

Etternavn.

Eksempel: "Example"
phoneStreng nullObligatorisk

Telefonnummer.

Eksempel: null

Ytterligere felt: Nei

Forsendelses- og leveringsdatoer

DeliveryDatesData · Ordrelisten og detaljene inneholder delivery.dates. Datoer i YYYY-MM-DD er planlagte og bekrefter ikke forsendelse. Gjeldende datoer har forrang; eldre ordrer bruker det lagrede estimatet. Slettede eller ukjente verdier er null. Detaljene inneholder også alle ordrelinjer og produktbilder.
dispatch_timezoneStreng nullObligatorisk

Tidssone for forsendelse (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

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

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

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

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

Ytterligere felt: Nei

DeliveryPickupPointData

DeliveryPickupPointData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
addressPickupPointAddressData Obligatorisk

Leveringsadresse.

codeStrengObligatorisk

Stabil maskinlesbar kode.

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

Verdi beskrevet av det omkringliggende skjemaet.

country_codeStrengObligatorisk

Landskode.

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

Miljøinformasjon knyttet til oppføringen.

Begrensninger
enum
["live", "sandbox"]
kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger
enum
["locker", "pickup_point"]
location_descriptionStreng nullObligatorisk

Beskrivelse på valgt språk.

Streng:maxLength: 1000
nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 160
opening_hoursStreng nullObligatorisk

Opening hours

Streng:maxLength: 500
operatorStrengObligatorisk

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 63
verified_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"

Ytterligere felt: Nei

Fakturainformasjon

InvoiceData · Skjema · Dataskjemaer: Ordrer
address_line_1Streng nullObligatorisk

Første adresselinje.

address_line_2Streng nullObligatorisk

Ytterligere adresseinformasjon.

cityStreng nullObligatorisk

By eller sted.

company_nameStreng nullObligatorisk

Firmanavn.

country_codeStreng nullObligatorisk

Landskode.

house_numberStreng nullObligatorisk

Bygnings- eller husnummer.

postal_codeStreng nullObligatorisk

Postnummer.

regionStreng nullObligatorisk

Administrativ region.

streetStreng nullObligatorisk

Gatenavn.

tax_identifierStreng nullObligatorisk

Skatteidentifikasjonsnummer.

tax_schemeStreng nullObligatorisk

Ordning for avgiftsberegning.

Ytterligere felt: Nei

Nettobeløp / Avgiftsbeløp / Bruttobeløp

OrderAmountBreakdownData · Beløp og satser kommer fra den lagrede ordren, inkludert linjerettelser. Manglende historiske opplysninger er null og erstattes ikke med katalogens gjeldende satser. Beløp forblir desimalstrenger.
grossMoneyData Obligatorisk

Bruttobeløp · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

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

Nettobeløp · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

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

Avgiftsbeløp · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

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

Ytterligere felt: Nei

Frakt · Rabatter

OrderDeliveryDiscountData · Beløp og satser kommer fra den lagrede ordren, inkludert linjerettelser. Manglende historiske opplysninger er null og erstattes ikke med katalogens gjeldende satser. Beløp forblir desimalstrenger.
amountMoneyData Obligatorisk

Bruttobeløp · Frakt · Rabatter.

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

Ressursidentifikator; behold den slik den returneres.

Eksempel: "saved-coupon"
codeStreng nullObligatorisk

Stabil maskinlesbar kode.

Eksempel: "SAVE"
kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger
enum
["coupon", "promotion"]
Eksempel: "coupon"
nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Saved coupon"
sequenceHeltall nullObligatorisk

Plassering i den sorterte samlingen.

Eksempel: 1
versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 3

Ytterligere felt: Nei

Hent — Ordrer — Svar

OrderDetailData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
created_atStrengObligatorisk

Opprettelsestidspunkt.

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

Kundeinformasjon registrert for denne ressursen.

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

Leveringsmetode og tilhørende informasjon.

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

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

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

Ressursidentifikator; behold den slik den returneres. (OrderDetailData).

Eksempel: "order-0000"
invoiceInvoiceData nullObligatorisk

Fakturainformasjon.

Eksempel: null
invoice_requestedBoolsk verdiObligatorisk

Om det ble bedt om faktura.

Eksempel: false
lifecycle_stateOrderLifecycleState Obligatorisk

Tilstand i forretningslivssyklusen.

Eksempel: "placed"
linesArray <OrderLineData > Obligatorisk

Øyeblikksbilder av 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

Språk valgt for denne forespørselen.

Eksempel: "pl"
market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

Eksempel: "market-pl"
numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "0001"
paymentPaymentData Obligatorisk

Betalingsopplysninger registrert 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

Hentested

Eksempel: null
prices_include_taxBoolsk verdiObligatorisk

Om oppgitte priser inkluderer avgifter.

Eksempel: true
shipping_addressAddressData nullObligatorisk

Leveringsadresse.

Eksempel: null
shipping_discount_amountMoneyData Obligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

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

Status som godtas av denne bestemte operasjonen.

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

Beløp før de ytterligere bestanddelene vist i svaret.

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

Avgiftsinformasjon.

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

Avgiftsgrupper · 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

Avgiftsland · Lagrede ordredata · ISO 3166-1 alpha-2; null.

Eksempel: "PL"
totalMoneyData Obligatorisk

Samlet beløp.

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

Totalsummer · net / tax / gross; Før rabatter / Etter 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}}}

Ytterligere felt: Nei

Bildemetadata og URL

OrderImageData · Skjema · Dataskjemaer: Ordrer
altStreng nullObligatorisk

Alternativ tekst for et bilde.

sourceStrengValgfritt

Kilden til den registrerte aktiviteten.

const: "current_catalog"
Standard: "current_catalog"
urlStrengObligatorisk

Ressursens URL.

Ytterligere felt: Nei

Tilstand i forretningslivssyklusen

OrderLifecycleState · Skjema · Dataskjemaer: Ordrer Streng
Begrensninger
enum
["placed", "cancelled", "fulfilled", "returned"]

Ytterligere felt: Ja

Øyeblikksbilder av ordrelinjer

OrderLineData · Skjema · Dataskjemaer: Ordrer
discount_amountMoneyData Obligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

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

Bruttobeløp · Rabatter; Ukjent: null; kjent nullverdi: 0.

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

Nettobeløp · Rabatter; Ukjent: null; kjent nullverdi: 0.

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

Avgiftsbeløp · Rabatter; Ukjent: null; kjent nullverdi: 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}]
identifiersObjektYtterligere felt: StrengObligatorisk

Produktidentifikasjonskoder.

Eksempel: {}
imageOrderImageData nullObligatorisk

Bildemetadata og URL.

Eksempel: null
line_idStrengObligatorisk

Stabil identifikator for ordrelinjen.

Eksempel: "saved-line-a"
manual_discountOrderManualDiscountData nullObligatorisk

Manuell rabatt; null.

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

Ressursens navn i den relevante konteksten.

Eksempel: "Saved A"
original_totalMoneyData Obligatorisk

Samlet beløp.

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

Bruttobeløp · Produkter · Før rabatter; Ukjent: null; kjent nullverdi: 0.

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

Nettobeløp · Produkter · Før rabatter; Ukjent: null; kjent nullverdi: 0.

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

Avgiftsbeløp · Produkter · Før rabatter; Ukjent: null; kjent nullverdi: 0.

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

Plassering i den sorterte samlingen.

Eksempel: 1
product_idStrengObligatorisk

Produktidentifikator.

Eksempel: "product-api"
quantityHeltallObligatorisk

Antall enheter.

Eksempel: 2
skuStrengObligatorisk

SKU-varekode.

Eksempel: "A"
taxMoneyData nullObligatorisk

Avgiftsbeløp · Én enhet · Lagrede ordredata; tax ≠ unit_tax; Ukjent: null; kjent nullverdi: 0.

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

Avgiftskategoriens identifikator · Lagrede ordredata; null.

Eksempel: "standard"
tax_category_nameStreng nullObligatorisk

Lagret navn på avgiftskategorien; null.

Eksempel: "VAT 23%"
tax_rateStreng nullObligatorisk

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

Eksempel: "0.23"
totalMoneyData Obligatorisk

Samlet beløp.

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

Bruttobeløp · Produkter · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

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

Nettobeløp · Produkter · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

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

Avgiftsbeløp · Produkter · Etter rabatter · Lagrede ordredata; Ukjent: null; kjent nullverdi: 0.

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

Bruttobeløp · Én enhet · Før rabatter; Ukjent: null; kjent nullverdi: 0.

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

Nettobeløp · Én enhet · Før rabatter; Ukjent: null; kjent nullverdi: 0.

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

Pris for én enhet.

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

Avgiftsbeløp · Én enhet · Før rabatter; Ukjent: null; kjent nullverdi: 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 øyeblikksbildet.

Eksempel: []

Ytterligere felt: Nei

Manuell rabatt

OrderManualDiscountData · Beløp og satser kommer fra den lagrede ordren, inkludert linjerettelser. Manglende historiske opplysninger er null og erstattes ikke med katalogens gjeldende satser. Beløp forblir desimalstrenger.
amountMoneyData Obligatorisk

Bruttobeløp · Manuell rabatt · Lagrede ordredata.

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

Rabattype: percentage / fixed.

Begrensninger
enum
["percentage", "fixed"]
Eksempel: "fixed"
valueStrengObligatorisk

Angitt verdi: percentage "10" = 10%; fixed = Bruttobeløp.

Eksempel: "12.30"

Ytterligere felt: Nei

Status som godtas av denne bestemte operasjonen

OrderPaymentStatus · Skjema · Dataskjemaer: Ordrer Streng
Begrensninger
enum
["unpaid", "paid", "failed", "refunded"]

Ytterligere felt: Ja

Status som godtas av denne bestemte operasjonen

OrderStatusData · Skjema · Dataskjemaer: Ordrer
idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (OrderStatusData).

Eksempel: "status-0"
nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Status 0"
updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

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

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Vis liste · Statuser — Ordrer — Svar

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
created_atStrengObligatorisk

Opprettelsestidspunkt.

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

Ressursidentifikator; behold den slik den returneres. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Eksempel: "example"
is_initialBoolsk verdiObligatorisk

Om dette er startstatusen.

Eksempel: false
nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Example"
positionHeltallObligatorisk

Plassering i den sorterte samlingen.

Eksempel: 1

Ytterligere felt: Nei

Vis liste · Statuser — Ordrer — Svar

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Oppdater · Status — Ordrer — Forespørselsinnhold

OrderStatusUpdate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
status_idStrengObligatorisk

Identifikator hentet fra den relevante statuslisten.

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

Ytterligere felt: Nei

Vis liste — Ordrer — Svar

OrderSummaryData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
created_atStrengObligatorisk

Opprettelsestidspunkt.

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

Kundeinformasjon registrert for denne ressursen.

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

Leveringsmetode og tilhørende informasjon.

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

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

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

Ressursidentifikator; behold den slik den returneres. (OrderSummaryData).

Eksempel: "order-0000"
lifecycle_stateOrderLifecycleState Obligatorisk

Tilstand i forretningslivssyklusen.

Eksempel: "placed"
localeStrengObligatorisk

Språk valgt for denne forespørselen.

Eksempel: "pl"
market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

Eksempel: "market-pl"
numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "0001"
paymentPaymentData Obligatorisk

Betalingsopplysninger registrert 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_taxBoolsk verdiObligatorisk

Om oppgitte priser inkluderer avgifter.

Eksempel: true
shipping_discount_amountMoneyData Obligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

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

Status som godtas av denne bestemte operasjonen.

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

Beløp før de ytterligere bestanddelene vist i svaret.

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

Avgiftsinformasjon.

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

Avgiftsland · Lagrede ordredata · ISO 3166-1 alpha-2; null.

Eksempel: "PL"
totalMoneyData Obligatorisk

Samlet beløp.

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

Ytterligere felt: Nei

Ordre · Avgiftsgrupper

OrderTaxBreakdownData · Beløp og satser kommer fra den lagrede ordren, inkludert linjerettelser. Manglende historiske opplysninger er null og erstattes ikke med katalogens gjeldende satser. Beløp forblir desimalstrenger.
groupsArray <OrderTaxGroupData > Obligatorisk

Avgiftsgrupper · source + tax_rate; Ukjent: null; kjent nullverdi: 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

Ufordelt avgift = order.tax − Σ groups.tax; ±.

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

Ytterligere felt: Nei

Avgiftsgrupper

OrderTaxGroupData · Beløp og satser kommer fra den lagrede ordren, inkludert linjerettelser. Manglende historiske opplysninger er null og erstattes ikke med katalogens gjeldende satser. Beløp forblir desimalstrenger.
grossMoneyData Obligatorisk

Bruttobeløp · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

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

Nettobeløp · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

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

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

Begrensninger
enum
["products", "shipping"]
Eksempel: "products"
taxMoneyData nullObligatorisk

Avgiftsbeløp · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

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

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

Eksempel: "0.23"

Ytterligere felt: Nei

Ordre · Totalsummer

OrderTotalsData · Beløp og satser kommer fra den lagrede ordren, inkludert linjerettelser. Manglende historiske opplysninger er null og erstattes ikke med katalogens gjeldende satser. Beløp forblir desimalstrenger.
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 · Etter 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 · Etter 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

Frakt · Etter 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

Frakt · 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

Frakt · 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}}

Ytterligere felt: Nei

Variantvalg knyttet til produktet eller øyeblikksbildet

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Skjema · Dataskjemaer: Ordrer
nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

valueStrengObligatorisk

Verdi beskrevet av det omkringliggende skjemaet.

Ytterligere felt: Nei

OrderDiscountData

OrderDiscountData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
amountMoneyData Obligatorisk

Bruttobeløp · Produkter · Rabatter.

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

Ressursidentifikator; behold den slik den returneres.

Eksempel: "saved-coupon"
codeStreng nullObligatorisk

Stabil maskinlesbar kode.

Eksempel: "SAVE"
kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger
enum
["coupon", "promotion"]
Eksempel: "coupon"
nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Saved coupon"
sequenceHeltall nullValgfritt

Anvendelsesrekkefølge; null.

Eksempel: 1
shipping_amountMoneyData nullValgfritt

Bruttobeløp · Frakt · Rabatter; null.

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

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 3

Ytterligere felt: Nei

Betalingsopplysninger registrert for ordren

PaymentData · Skjema · Dataskjemaer: Ordrer
amountMoneyData Obligatorisk

payment.amount er ordretotalen. Betalingsstatus bestemmer ikke betalte, refunderte eller utestående beløp.

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

Miljøinformasjon knyttet til oppføringen.

Begrensninger
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 da betalingen ble merket som betalt.

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

Status som godtas av denne bestemte operasjonen.

Eksempel: "unpaid"
updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

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

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 0

Ytterligere felt: Nei

Oppdater · Betalingsstatus — Ordrer — Forespørselsinnhold

PaymentStatusUpdate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 0maximum: 9223372036854775807
Eksempel: 1
reasonStrengObligatorisk

Registrert begrunnelse for endringen.

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

Status som godtas av denne bestemte operasjonen.

Eksempel: "paid"

Ytterligere felt: Nei

Status som godtas av denne bestemte operasjonen

PaymentStatus · Skjema · Dataskjemaer: Ordrer Streng
Begrensninger
enum
["unpaid", "paid", "failed", "refunded"]

Ytterligere felt: Ja

PickupPointAddressData

PickupPointAddressData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
address_line_1StrengObligatorisk

Første adresselinje.

minLength: 1maxLength: 240
cityStrengObligatorisk

By eller sted.

minLength: 1maxLength: 160
postal_codeStrengObligatorisk

Postnummer.

minLength: 1maxLength: 32

Ytterligere felt: Nei

PickupPointCoordinatesData

PickupPointCoordinatesData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
latitudeTallObligatorisk

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeTallObligatorisk

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Ytterligere felt: Nei

PickupPointData

PickupPointData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
address_line1StrengObligatorisk

Første adresselinje.

cityStrengObligatorisk

By eller sted.

codeStrengObligatorisk

Stabil maskinlesbar kode.

country_codeStrengObligatorisk

Landskode.

kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger
enum
["locker", "pickup_point"]
latitudeTall nullObligatorisk

WGS84 φ (°)

location_descriptionStreng nullObligatorisk

Beskrivelse på valgt språk.

longitudeTall nullObligatorisk

WGS84 λ (°)

nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

opening_hoursStreng nullObligatorisk

Opening hours

operatorStrengObligatorisk

Ressursens navn i den relevante konteksten.

postal_codeStrengObligatorisk

Postnummer.

Ytterligere felt: Nei

PickupPointSummaryData

PickupPointSummaryData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
codeStrengObligatorisk

Stabil maskinlesbar kode.

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

Landskode.

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

Miljøinformasjon knyttet til oppføringen.

Begrensninger
enum
["live", "sandbox"]
kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger
enum
["locker", "pickup_point"]
operatorStrengObligatorisk

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 63

Ytterligere felt: Nei

Kundeinformasjon registrert for denne ressursen

RequestCustomerData · Skjema · Dataskjemaer: Ordrer
emailStrengObligatorisk

E-postadresse.

Eksempel: "customer@example.invalid"
nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Example"

Ytterligere felt: Nei

Leveringsmetode og tilhørende informasjon

ShippingData · Skjema · Dataskjemaer: Ordrer
amountMoneyData Obligatorisk

Fraktbeløp inkludert avgifter lagret på ordren som MoneyData. Senere avgiftsendringer endrer ikke dette historiske beløpet.

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

Forsendelses- og leveringsdatoer. Ordrelisten og detaljene inneholder delivery.dates. Datoer i YYYY-MM-DD er planlagte og bekrefter ikke forsendelse. Gjeldende datoer har forrang; eldre ordrer bruker det lagrede estimatet. Slettede eller ukjente verdier er null. Detaljene inneholder også alle ordrelinjer og produktbilder.

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

Hentested

Eksempel: null
recipient_modeStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger
enum
["full_address", "pickup_contact"]
Eksempel: "full_address"

Ytterligere felt: Nei

ShippingDetailData

ShippingDetailData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
amountMoneyData Obligatorisk

Fraktbeløp inkludert avgifter lagret på ordren som MoneyData. Senere avgiftsendringer endrer ikke dette historiske beløpet.

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

Forsendelses- og leveringsdatoer. Ordrelisten og detaljene inneholder delivery.dates. Datoer i YYYY-MM-DD er planlagte og bekrefter ikke forsendelse. Gjeldende datoer har forrang; eldre ordrer bruker det lagrede estimatet. Slettede eller ukjente verdier er null. Detaljene inneholder også alle ordrelinjer og produktbilder.

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øp · Rabatter; Ukjent: null; kjent nullverdi: 0.

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

Nettobeløp · Rabatter; Ukjent: null; kjent nullverdi: 0.

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

Avgiftsbeløp · Rabatter; Ukjent: null; kjent nullverdi: 0.

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

Frakt · Rabatter; []: 0; null: Ukjent: null; kjent nullverdi: 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øp · Etter rabatter; Ukjent: null; kjent nullverdi: 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øp · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

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

Bruttobeløp · Frakt · Før rabatter; Ukjent: null; kjent nullverdi: 0.

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

Nettobeløp · Frakt · Før rabatter; Ukjent: null; kjent nullverdi: 0.

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

Avgiftsbeløp · Frakt · Før rabatter; Ukjent: null; kjent nullverdi: 0.

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

Hentested

Eksempel: null
recipient_modeStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger
enum
["full_address", "pickup_contact"]
Eksempel: "full_address"
taxMoneyData nullObligatorisk

Avgiftsbeløp · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

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

Avgiftskategoriens identifikator · Lagrede ordredata; null.

Eksempel: "standard"
tax_category_nameStreng nullObligatorisk

Lagret navn på avgiftskategorien; null.

Eksempel: "VAT 23%"
tax_rateStreng nullObligatorisk

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

Eksempel: "0.23"

Ytterligere felt: Nei