Gegevensschema’s: Bestellingen

Gegevensschema’s: Bestellingen. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Verzendadres

AddressData · Schema · Gegevensschema’s: Bestellingen

address_line_1Tekenreeks nullVerplicht: Eerste adresregel.
address_line_2Tekenreeks nullVerplicht: Aanvullende adresgegevens.
cityTekenreeks nullVerplicht: Stad of plaats.
country_codeTekenreeks nullVerplicht: Landcode.
first_nameTekenreeks nullVerplicht: Voornaam.
house_numberTekenreeks nullVerplicht: Huis- of gebouwnummer.
last_nameTekenreeks nullVerplicht: Achternaam.
phoneTekenreeks nullVerplicht: Telefoonnummer.
postal_codeTekenreeks nullVerplicht: Postcode.
regionTekenreeks nullVerplicht: Bestuurlijke regio.
streetTekenreeks nullVerplicht: Straatnaam.

Aanvullende velden: Nee

Lijst ophalen — Bestellingen — Antwoord

ApiResponse_list_OrderSummaryData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <OrderSummaryData > Verplicht: Voorbeeldantwoord · ApiResponse_list_OrderSummaryData__.

Voorbeeld: [{"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Ophalen — Bestellingen — Antwoord

ApiResponse_OrderDetailData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataOrderDetailData Verplicht: Voorbeeldantwoord · OrderDetailData.

Voorbeeld: {"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Klantgegevens die voor deze resource zijn vastgelegd

CustomerData · Schema · Gegevensschema’s: Bestellingen

emailTekenreeksVerplicht: E-mailadres.

Voorbeeld: "customer@example.invalid"
first_nameTekenreeks nullVerplicht: Voornaam.

Voorbeeld: "Example"
last_nameTekenreeks nullVerplicht: Achternaam.

Voorbeeld: "Example"
phoneTekenreeks nullVerplicht: Telefoonnummer.

Voorbeeld: null

Aanvullende velden: Nee

Verzend- en bezorgdatums

DeliveryDatesData · De bestellijst en details bevatten delivery.dates. Datums in YYYY-MM-DD zijn gepland en bevestigen geen verzending. Actuele datums gaan voor; oudere bestellingen gebruiken de opgeslagen schatting. Gewiste of onbekende waarden zijn null. Details bevatten ook alle bestelregels en productafbeeldingen.

dispatch_timezoneTekenreeks nullVerplicht: Tijdzone van verzending (IANA; null).

Voorbeeld: "Europe/Warsaw"
estimated_delivery_fromTekenreeks nullVerplicht: Begin van verwachte bezorging (YYYY-MM-DD; null).

Tekenreeks:format: "date"

Voorbeeld: "2026-10-20"
estimated_delivery_toTekenreeks nullVerplicht: Einde van verwachte bezorging (YYYY-MM-DD; null).

Tekenreeks:format: "date"

Voorbeeld: "2026-10-21"
planned_dispatch_onTekenreeks nullVerplicht: Geplande verzenddatum (YYYY-MM-DD; null).

Tekenreeks:format: "date"

Voorbeeld: "2026-10-19"

Aanvullende velden: Nee

DeliveryPickupPointData

DeliveryPickupPointData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

addressPickupPointAddressData Verplicht

Verzendadres.

codeTekenreeksVerplicht

Stabiele, machineleesbare code.

Beperkingen

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

coordinatesPickupPointCoordinatesData nullVerplicht

Waarde zoals beschreven door het omringende schema.

country_codeTekenreeksVerplicht

Landcode.

Beperkingen

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

environmentTekenreeksVerplicht

Omgevingsinformatie die bij de registratie hoort.

Beperkingen

enum: ["live", "sandbox"]

kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum: ["locker", "pickup_point"]

location_descriptionTekenreeks nullVerplicht

Beschrijving in de geselecteerde taal.

Tekenreeks:maxLength: 1000

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

minLength: 1maxLength: 160

opening_hoursTekenreeks nullVerplicht

Opening hours

Tekenreeks:maxLength: 500

operatorTekenreeksVerplicht

Resourcenaam in de betreffende context.

minLength: 1maxLength: 63

verified_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"

Aanvullende velden: Nee

Factuurgegevens

InvoiceData · Schema · Gegevensschema’s: Bestellingen

address_line_1Tekenreeks nullVerplicht: Eerste adresregel.
address_line_2Tekenreeks nullVerplicht: Aanvullende adresgegevens.
cityTekenreeks nullVerplicht: Stad of plaats.
company_nameTekenreeks nullVerplicht: Bedrijfsnaam.
country_codeTekenreeks nullVerplicht: Landcode.
house_numberTekenreeks nullVerplicht: Huis- of gebouwnummer.
postal_codeTekenreeks nullVerplicht: Postcode.
regionTekenreeks nullVerplicht: Bestuurlijke regio.
streetTekenreeks nullVerplicht: Straatnaam.
tax_identifierTekenreeks nullVerplicht: Fiscaal identificatienummer.
tax_schemeTekenreeks nullVerplicht: Schema voor belastingberekening.

Aanvullende velden: Nee

Nettobedrag / Belastingbedrag / Brutobedrag

OrderAmountBreakdownData · Bedragen en belastingtarieven komen uit de opgeslagen bestelling, inclusief regelcorrecties. Ontbrekende historische gegevens zijn null en worden niet vervangen door actuele catalogustarieven. Bedragen blijven decimale tekenreeksen.

grossMoneyData Verplicht: Brutobedrag · Na kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullVerplicht: Nettobedrag · Na kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullVerplicht: Belastingbedrag · Na kortingen; Onbekend: null; bekende nul: 0.

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

Aanvullende velden: Nee

Verzending · Kortingen

OrderDeliveryDiscountData · Bedragen en belastingtarieven komen uit de opgeslagen bestelling, inclusief regelcorrecties. Ontbrekende historische gegevens zijn null en worden niet vervangen door actuele catalogustarieven. Bedragen blijven decimale tekenreeksen.

amountMoneyData Verplicht

Brutobedrag · Verzending · Kortingen.

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

campaign_idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

Voorbeeld: "saved-coupon"

codeTekenreeks nullVerplicht

Stabiele, machineleesbare code.

Voorbeeld: "SAVE"

kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum: ["coupon", "promotion"]

Voorbeeld: "coupon"

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Saved coupon"

sequenceGeheel getal nullVerplicht

Positie in de geordende verzameling.

Voorbeeld: 1

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 3

Aanvullende velden: Nee

Ophalen — Bestellingen — Antwoord

OrderDetailData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

created_atTekenreeksVerplicht: Tijdstip van aanmaak.

format: "date-time"

Voorbeeld: "2026-10-19T10:00:00Z"
customerCustomerData Verplicht: Klantgegevens die voor deze resource zijn vastgelegd.

Voorbeeld: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Verplicht: Verzendmethode en bijbehorende informatie.

Voorbeeld: {"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 Verplicht: Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

Voorbeeld: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Verplicht: Kortingen

Voorbeeld: [{"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}]
idTekenreeksVerplicht: Resource-identificatie; bewaar deze zoals teruggegeven. (OrderDetailData).

Voorbeeld: "order-0000"
invoiceInvoiceData nullVerplicht: Factuurgegevens.

Voorbeeld: null
invoice_requestedBooleaanse waardeVerplicht: Of een factuur is aangevraagd.

Voorbeeld: false
lifecycle_stateOrderLifecycleState Verplicht: Status in de zakelijke levenscyclus.

Voorbeeld: "placed"
linesArray <OrderLineData > Verplicht: Vastgelegde bestelregels.

Voorbeeld: [{"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":[]}]
localeTekenreeksVerplicht: Taal die voor dit verzoek is geselecteerd.

Voorbeeld: "pl"
market_idTekenreeksVerplicht: Marktidentificatie die het contextendpoint teruggeeft.

Voorbeeld: "market-pl"
numberTekenreeksVerplicht: Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "0001"
paymentPaymentData Verplicht: Betaalgegevens die bij de bestelling zijn vastgelegd.

Voorbeeld: {"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 nullVerplicht: Afhaalpunt

Voorbeeld: null
prices_include_taxBooleaanse waardeVerplicht: Of de vermelde prijzen inclusief belasting zijn.

Voorbeeld: true
shipping_addressAddressData nullVerplicht: Verzendadres.

Voorbeeld: null
shipping_discount_amountMoneyData Verplicht: Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

Voorbeeld: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Verplicht: Status die deze specifieke bewerking accepteert.

Voorbeeld: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Verplicht: Bedrag vóór de aanvullende componenten in het antwoord.

Voorbeeld: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Verplicht: Belastinggegevens.

Voorbeeld: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Verplicht: Belastinggroepen · source + tax_rate; unallocated_tax.

Voorbeeld: {"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_codeTekenreeks nullVerplicht: Belastingland · Opgeslagen bestelgegevens · ISO 3166-1 alpha-2; null.

Voorbeeld: "PL"
totalMoneyData Verplicht: Totaalbedrag.

Voorbeeld: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Verplicht: Totalen · net / tax / gross; Vóór kortingen / Na kortingen.

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

Aanvullende velden: Nee

Afbeeldingsmetadata en URL

OrderImageData · Schema · Gegevensschema’s: Bestellingen

altTekenreeks nullVerplicht: Alternatieve tekst voor een afbeelding.
sourceTekenreeksOptioneel: Bron van de vastgelegde activiteit.

const: "current_catalog"

Standaard: "current_catalog"
urlTekenreeksVerplicht: Resource-URL.

Aanvullende velden: Nee

Status in de zakelijke levenscyclus

OrderLifecycleState · Schema · Gegevensschema’s: Bestellingen

Tekenreeks

Beperkingen

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

Aanvullende velden: Ja

Vastgelegde bestelregels

OrderLineData · Schema · Gegevensschema’s: Bestellingen

discount_amountMoneyData Verplicht: Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

Voorbeeld: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Verplicht: Brutobedrag · Kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullVerplicht: Nettobedrag · Kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullVerplicht: Belastingbedrag · Kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Verplicht: Kortingen · net / tax / gross.

Voorbeeld: [{"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}]
identifiersObjectAanvullende velden: TekenreeksVerplicht: Productidentificatiecodes.

Voorbeeld: {}
imageOrderImageData nullVerplicht: Afbeeldingsmetadata en URL.

Voorbeeld: null
line_idTekenreeksVerplicht: Vaste identificatie van de bestelregel.

Voorbeeld: "saved-line-a"
manual_discountOrderManualDiscountData nullVerplicht: Handmatige korting; null.

Voorbeeld: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameTekenreeksVerplicht: Resourcenaam in de betreffende context.

Voorbeeld: "Saved A"
original_totalMoneyData Verplicht: Totaalbedrag.

Voorbeeld: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Verplicht: Brutobedrag · Producten · Vóór kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullVerplicht: Nettobedrag · Producten · Vóór kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullVerplicht: Belastingbedrag · Producten · Vóór kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"46.00","currency":"PLN","minor_units":2}
positionGeheel getalVerplicht: Positie in de geordende verzameling.

Voorbeeld: 1
product_idTekenreeksVerplicht: Productidentificatie.

Voorbeeld: "product-api"
quantityGeheel getalVerplicht: Aantal eenheden.

Voorbeeld: 2
skuTekenreeksVerplicht: Voorraadartikelcode (SKU).

Voorbeeld: "A"
taxMoneyData nullVerplicht: Belastingbedrag · Eén eenheid · Opgeslagen bestelgegevens; tax ≠ unit_tax; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idTekenreeks nullVerplicht: Identificatie van de belastingcategorie · Opgeslagen bestelgegevens; null.

Voorbeeld: "standard"
tax_category_nameTekenreeks nullVerplicht: Opgeslagen naam van de belastingcategorie; null.

Voorbeeld: "VAT 23%"
tax_rateTekenreeks nullVerplicht: tax_rate · Opgeslagen bestelgegevens: "0.23" = 23%; "0" ≠ null.

Voorbeeld: "0.23"
totalMoneyData Verplicht: Totaalbedrag.

Voorbeeld: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Verplicht: Brutobedrag · Producten · Na kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullVerplicht: Nettobedrag · Producten · Na kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullVerplicht: Belastingbedrag · Producten · Na kortingen · Opgeslagen bestelgegevens; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Verplicht: Brutobedrag · Eén eenheid · Vóór kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullVerplicht: Nettobedrag · Eén eenheid · Vóór kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Verplicht: Prijs per eenheid.

Voorbeeld: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullVerplicht: Belastingbedrag · Eén eenheid · Vóór kortingen; Onbekend: null; bekende nul: 0.

Voorbeeld: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idTekenreeks nullVerplicht: Identificatie van de productvariant.

Voorbeeld: null
variant_optionsArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Verplicht: Variantopties die bij het product of de momentopname horen.

Voorbeeld: []

Aanvullende velden: Nee

Handmatige korting

OrderManualDiscountData · Bedragen en belastingtarieven komen uit de opgeslagen bestelling, inclusief regelcorrecties. Ontbrekende historische gegevens zijn null en worden niet vervangen door actuele catalogustarieven. Bedragen blijven decimale tekenreeksen.

amountMoneyData Verplicht

Brutobedrag · Handmatige korting · Opgeslagen bestelgegevens.

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

kindTekenreeksVerplicht

Soort korting: percentage / fixed.

Beperkingen

enum: ["percentage", "fixed"]

Voorbeeld: "fixed"

valueTekenreeksVerplicht

Ingestelde waarde: percentage "10" = 10%; fixed = Brutobedrag.

Voorbeeld: "12.30"

Aanvullende velden: Nee

Status die deze specifieke bewerking accepteert

OrderPaymentStatus · Schema · Gegevensschema’s: Bestellingen

Tekenreeks

Beperkingen

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

Aanvullende velden: Ja

Status die deze specifieke bewerking accepteert

OrderStatusData · Schema · Gegevensschema’s: Bestellingen

idTekenreeksVerplicht: Resource-identificatie; bewaar deze zoals teruggegeven. (OrderStatusData).

Voorbeeld: "status-0"
nameTekenreeksVerplicht: Resourcenaam in de betreffende context.

Voorbeeld: "Status 0"
updated_atTekenreeksVerplicht: Tijdstip van de meest recente wijziging.

format: "date-time"

Voorbeeld: "2026-10-19T10:00:00Z"
versionGeheel getalVerplicht: Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Lijst ophalen · Statussen — Bestellingen — Antwoord

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

created_atTekenreeksVerplicht: Tijdstip van aanmaak.

format: "date-time"

Voorbeeld: "2026-01-01T12:00:00Z"
idTekenreeksVerplicht: Resource-identificatie; bewaar deze zoals teruggegeven. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Voorbeeld: "example"
is_initialBooleaanse waardeVerplicht: Of dit de beginstatus is.

Voorbeeld: false
nameTekenreeksVerplicht: Resourcenaam in de betreffende context.

Voorbeeld: "Example"
positionGeheel getalVerplicht: Positie in de geordende verzameling.

Voorbeeld: 1

Aanvullende velden: Nee

Lijst ophalen · Statussen — Bestellingen — Antwoord

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Verplicht: Voorbeeldantwoord · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Voorbeeld: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Bijwerken · Status — Bestellingen — Verzoekinhoud

OrderStatusUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

status_idTekenreeksVerplicht

Identificatie uit de bijbehorende statuslijst.

Beperkingen

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

Voorbeeld: "example"

Aanvullende velden: Nee

Lijst ophalen — Bestellingen — Antwoord

OrderSummaryData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

created_atTekenreeksVerplicht: Tijdstip van aanmaak.

format: "date-time"

Voorbeeld: "2026-10-19T10:00:00Z"
customerCustomerData Verplicht: Klantgegevens die voor deze resource zijn vastgelegd.

Voorbeeld: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Verplicht: Verzendmethode en bijbehorende informatie.

Voorbeeld: {"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 Verplicht: Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

Voorbeeld: {"amount":"24.60","currency":"PLN","minor_units":2}
idTekenreeksVerplicht: Resource-identificatie; bewaar deze zoals teruggegeven. (OrderSummaryData).

Voorbeeld: "order-0000"
lifecycle_stateOrderLifecycleState Verplicht: Status in de zakelijke levenscyclus.

Voorbeeld: "placed"
localeTekenreeksVerplicht: Taal die voor dit verzoek is geselecteerd.

Voorbeeld: "pl"
market_idTekenreeksVerplicht: Marktidentificatie die het contextendpoint teruggeeft.

Voorbeeld: "market-pl"
numberTekenreeksVerplicht: Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "0001"
paymentPaymentData Verplicht: Betaalgegevens die bij de bestelling zijn vastgelegd.

Voorbeeld: {"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_taxBooleaanse waardeVerplicht: Of de vermelde prijzen inclusief belasting zijn.

Voorbeeld: true
shipping_discount_amountMoneyData Verplicht: Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

Voorbeeld: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Verplicht: Status die deze specifieke bewerking accepteert.

Voorbeeld: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Verplicht: Bedrag vóór de aanvullende componenten in het antwoord.

Voorbeeld: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Verplicht: Belastinggegevens.

Voorbeeld: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeTekenreeks nullVerplicht: Belastingland · Opgeslagen bestelgegevens · ISO 3166-1 alpha-2; null.

Voorbeeld: "PL"
totalMoneyData Verplicht: Totaalbedrag.

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

Aanvullende velden: Nee

Bestelling · Belastinggroepen

OrderTaxBreakdownData · Bedragen en belastingtarieven komen uit de opgeslagen bestelling, inclusief regelcorrecties. Ontbrekende historische gegevens zijn null en worden niet vervangen door actuele catalogustarieven. Bedragen blijven decimale tekenreeksen.

groupsArray <OrderTaxGroupData > Verplicht: Belastinggroepen · source + tax_rate; Onbekend: null; bekende nul: 0.

Voorbeeld: [{"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 Verplicht: Niet toegewezen belasting = order.tax − Σ groups.tax; ±.

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

Aanvullende velden: Nee

Belastinggroepen

OrderTaxGroupData · Bedragen en belastingtarieven komen uit de opgeslagen bestelling, inclusief regelcorrecties. Ontbrekende historische gegevens zijn null en worden niet vervangen door actuele catalogustarieven. Bedragen blijven decimale tekenreeksen.

grossMoneyData Verplicht

Brutobedrag · Na kortingen; Onbekend: null; bekende nul: 0.

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

netMoneyData nullVerplicht

Nettobedrag · Na kortingen; Onbekend: null; bekende nul: 0.

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

sourceTekenreeksVerplicht

Bron: products (Producten), shipping (Verzending).

Beperkingen

enum: ["products", "shipping"]

Voorbeeld: "products"

taxMoneyData nullVerplicht

Belastingbedrag · Na kortingen; Onbekend: null; bekende nul: 0.

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

tax_rateTekenreeks nullVerplicht

tax_rate · Opgeslagen bestelgegevens: "0.23" = 23%; "0" ≠ null.

Voorbeeld: "0.23"

Aanvullende velden: Nee

Bestelling · Totalen

OrderTotalsData · Bedragen en belastingtarieven komen uit de opgeslagen bestelling, inclusief regelcorrecties. Ontbrekende historische gegevens zijn null en worden niet vervangen door actuele catalogustarieven. Bedragen blijven decimale tekenreeksen.

before_discountsOrderAmountBreakdownData Verplicht: Bestelling · Vóór kortingen · net / tax / gross.

Voorbeeld: {"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 Verplicht: Kortingen · net / tax / gross.

Voorbeeld: {"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 Verplicht: Bestelling · Na kortingen · net / tax / gross.

Voorbeeld: {"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 Verplicht: Producten · Kortingen · net / tax / gross.

Voorbeeld: {"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 Verplicht: Producten · Na kortingen · net / tax / gross.

Voorbeeld: {"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 Verplicht: Producten · Vóór kortingen · net / tax / gross.

Voorbeeld: {"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 Verplicht: Verzending · Na kortingen · net / tax / gross.

Voorbeeld: {"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 Verplicht: Verzending · Vóór kortingen · net / tax / gross.

Voorbeeld: {"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 Verplicht: Verzending · Kortingen · net / tax / gross.

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

Aanvullende velden: Nee

Variantopties die bij het product of de momentopname horen

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Schema · Gegevensschema’s: Bestellingen

nameTekenreeksVerplicht: Resourcenaam in de betreffende context.
valueTekenreeksVerplicht: Waarde zoals beschreven door het omringende schema.

Aanvullende velden: Nee

OrderDiscountData

OrderDiscountData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

amountMoneyData Verplicht

Brutobedrag · Producten · Kortingen.

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

campaign_idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

Voorbeeld: "saved-coupon"

codeTekenreeks nullVerplicht

Stabiele, machineleesbare code.

Voorbeeld: "SAVE"

kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum: ["coupon", "promotion"]

Voorbeeld: "coupon"

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Saved coupon"

sequenceGeheel getal nullOptioneel

Toepassingsvolgorde; null.

Voorbeeld: 1

shipping_amountMoneyData nullOptioneel

Brutobedrag · Verzending · Kortingen; null.

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

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 3

Aanvullende velden: Nee

Betaalgegevens die bij de bestelling zijn vastgelegd

PaymentData · Schema · Gegevensschema’s: Bestellingen

amountMoneyData Verplicht

payment.amount is het besteltotaal. De betaalstatus bepaalt geen betaalde, terugbetaalde of openstaande bedragen.

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

environmentTekenreeksVerplicht

Omgevingsinformatie die bij de registratie hoort.

Beperkingen

enum: ["live", "sandbox"]

Voorbeeld: "live"

method_codeTekenreeks nullVerplicht

Code van de verzend- of betaalmethode.

Voorbeeld: "payment-old"

method_nameTekenreeks nullVerplicht

Naam van de verzend- of betaalmethode.

Voorbeeld: "Historic method"

paid_atTekenreeks nullVerplicht

Datum en tijd waarop de betaling als betaald is gemarkeerd.

Tekenreeks:format: "date-time"

Voorbeeld: null

statusOrderPaymentStatus Verplicht

Status die deze specifieke bewerking accepteert.

Voorbeeld: "unpaid"

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"

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

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 0

Aanvullende velden: Nee

Bijwerken · Betaalstatus — Bestellingen — Verzoekinhoud

PaymentStatusUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

expected_versionGeheel getalVerplicht: Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 0maximum: 9223372036854775807

Voorbeeld: 1
reasonTekenreeksVerplicht: Vastgelegde reden voor de wijziging.

minLength: 1maxLength: 500

Voorbeeld: "Example"
statusPaymentStatus Verplicht: Status die deze specifieke bewerking accepteert.

Voorbeeld: "paid"

Aanvullende velden: Nee

Status die deze specifieke bewerking accepteert

PaymentStatus · Schema · Gegevensschema’s: Bestellingen

Tekenreeks

Beperkingen

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

Aanvullende velden: Ja

PickupPointAddressData

PickupPointAddressData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

address_line_1TekenreeksVerplicht: Eerste adresregel.

minLength: 1maxLength: 240
cityTekenreeksVerplicht: Stad of plaats.

minLength: 1maxLength: 160
postal_codeTekenreeksVerplicht: Postcode.

minLength: 1maxLength: 32

Aanvullende velden: Nee

PickupPointCoordinatesData

PickupPointCoordinatesData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

latitudeGetalVerplicht: WGS84 φ (°)

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

minimum: -180.0maximum: 180.0

Aanvullende velden: Nee

PickupPointData

PickupPointData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

address_line1TekenreeksVerplicht

Eerste adresregel.

cityTekenreeksVerplicht

Stad of plaats.

codeTekenreeksVerplicht

Stabiele, machineleesbare code.

country_codeTekenreeksVerplicht

Landcode.

kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum: ["locker", "pickup_point"]

latitudeGetal nullVerplicht

WGS84 φ (°)

location_descriptionTekenreeks nullVerplicht

Beschrijving in de geselecteerde taal.

longitudeGetal nullVerplicht

WGS84 λ (°)

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

opening_hoursTekenreeks nullVerplicht

Opening hours

operatorTekenreeksVerplicht

Resourcenaam in de betreffende context.

postal_codeTekenreeksVerplicht

Postcode.

Aanvullende velden: Nee

PickupPointSummaryData

PickupPointSummaryData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

codeTekenreeksVerplicht

Stabiele, machineleesbare code.

Beperkingen

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

country_codeTekenreeksVerplicht

Landcode.

Beperkingen

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

environmentTekenreeksVerplicht

Omgevingsinformatie die bij de registratie hoort.

Beperkingen

enum: ["live", "sandbox"]

kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum: ["locker", "pickup_point"]

operatorTekenreeksVerplicht

Resourcenaam in de betreffende context.

minLength: 1maxLength: 63

Aanvullende velden: Nee

Klantgegevens die voor deze resource zijn vastgelegd

RequestCustomerData · Schema · Gegevensschema’s: Bestellingen

emailTekenreeksVerplicht: E-mailadres.

Voorbeeld: "customer@example.invalid"
nameTekenreeksVerplicht: Resourcenaam in de betreffende context.

Voorbeeld: "Example"

Aanvullende velden: Nee

Verzendmethode en bijbehorende informatie

ShippingData · Schema · Gegevensschema’s: Bestellingen

amountMoneyData Verplicht

Brutoverzendbedrag dat als MoneyData in de bestelling is vastgelegd. Latere belastingwijzigingen veranderen dit historische bedrag niet.

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

datesDeliveryDatesData Verplicht

Verzend- en bezorgdatums. De bestellijst en details bevatten delivery.dates. Datums in YYYY-MM-DD zijn gepland en bevestigen geen verzending. Actuele datums gaan voor; oudere bestellingen gebruiken de opgeslagen schatting. Gewiste of onbekende waarden zijn null. Details bevatten ook alle bestelregels en productafbeeldingen.

Voorbeeld:

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

method_codeTekenreeks nullVerplicht

Code van de verzend- of betaalmethode.

Voorbeeld: "shipping-old"

method_nameTekenreeks nullVerplicht

Naam van de verzend- of betaalmethode.

Voorbeeld: "Historic carrier"

pickup_pointPickupPointSummaryData nullVerplicht

Afhaalpunt

Voorbeeld: null

recipient_modeTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum: ["full_address", "pickup_contact"]

Voorbeeld: "full_address"

Aanvullende velden: Nee

ShippingDetailData

ShippingDetailData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

amountMoneyData Verplicht

Brutoverzendbedrag dat als MoneyData in de bestelling is vastgelegd. Latere belastingwijzigingen veranderen dit historische bedrag niet.

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

datesDeliveryDatesData Verplicht

Voorbeeld:

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

discount_grossMoneyData Verplicht

Brutobedrag · Kortingen; Onbekend: null; bekende nul: 0.

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

discount_netMoneyData nullVerplicht

Nettobedrag · Kortingen; Onbekend: null; bekende nul: 0.

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

discount_taxMoneyData nullVerplicht

Belastingbedrag · Kortingen; Onbekend: null; bekende nul: 0.

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

discountsArray <OrderDeliveryDiscountData > nullVerplicht

Verzending · Kortingen; []: 0; null: Onbekend: null; bekende nul: 0.

Voorbeeld:

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

Brutobedrag · Na kortingen; Onbekend: null; bekende nul: 0.

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

method_codeTekenreeks nullVerplicht

Code van de verzend- of betaalmethode.

Voorbeeld: "shipping-old"

method_nameTekenreeks nullVerplicht

Naam van de verzend- of betaalmethode.

Voorbeeld: "Historic carrier"

netMoneyData nullVerplicht

Nettobedrag · Na kortingen; Onbekend: null; bekende nul: 0.

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

original_grossMoneyData Verplicht

Brutobedrag · Verzending · Vóór kortingen; Onbekend: null; bekende nul: 0.

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

original_netMoneyData nullVerplicht

Nettobedrag · Verzending · Vóór kortingen; Onbekend: null; bekende nul: 0.

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

original_taxMoneyData nullVerplicht

Belastingbedrag · Verzending · Vóór kortingen; Onbekend: null; bekende nul: 0.

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

pickup_pointDeliveryPickupPointData nullVerplicht

Afhaalpunt

Voorbeeld: null

recipient_modeTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum: ["full_address", "pickup_contact"]

Voorbeeld: "full_address"

taxMoneyData nullVerplicht

Belastingbedrag · Na kortingen; Onbekend: null; bekende nul: 0.

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

tax_category_idTekenreeks nullVerplicht

Identificatie van de belastingcategorie · Opgeslagen bestelgegevens; null.

Voorbeeld: "standard"

tax_category_nameTekenreeks nullVerplicht

Opgeslagen naam van de belastingcategorie; null.

Voorbeeld: "VAT 23%"

tax_rateTekenreeks nullVerplicht

tax_rate · Opgeslagen bestelgegevens: "0.23" = 23%; "0" ≠ null.

Voorbeeld: "0.23"

Aanvullende velden: Nee