Datenschemas: Bestellungen

Datenschemas: Bestellungen. Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

Datenschemas

Lieferadresse

AddressData · Schema · Datenschemas: Bestellungen

address_line_1Zeichenfolge nullErforderlich: Erste Adresszeile.
address_line_2Zeichenfolge nullErforderlich: Zusätzliche Adressangaben.
cityZeichenfolge nullErforderlich: Stadt oder Ort.
country_codeZeichenfolge nullErforderlich: Ländercode.
first_nameZeichenfolge nullErforderlich: Vorname.
house_numberZeichenfolge nullErforderlich: Hausnummer.
last_nameZeichenfolge nullErforderlich: Nachname.
phoneZeichenfolge nullErforderlich: Telefonnummer.
postal_codeZeichenfolge nullErforderlich: Postleitzahl.
regionZeichenfolge nullErforderlich: Verwaltungsregion.
streetZeichenfolge nullErforderlich: Straßenname.

Zusätzliche Felder: Nein

Auflisten — Bestellungen — Antwort

ApiResponse_list_OrderSummaryData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <OrderSummaryData > Erforderlich: Beispielantwort · ApiResponse_list_OrderSummaryData__.

Beispiel: [{"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Abrufen — Bestellungen — Antwort

ApiResponse_OrderDetailData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataOrderDetailData Erforderlich: Beispielantwort · OrderDetailData.

Beispiel: {"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Für diese Ressource gespeicherte Kundendaten

CustomerData · Schema · Datenschemas: Bestellungen

emailZeichenfolgeErforderlich: E-Mail-Adresse.

Beispiel: "customer@example.invalid"
first_nameZeichenfolge nullErforderlich: Vorname.

Beispiel: "Example"
last_nameZeichenfolge nullErforderlich: Nachname.

Beispiel: "Example"
phoneZeichenfolge nullErforderlich: Telefonnummer.

Beispiel: null

Zusätzliche Felder: Nein

Versand- und Lieferdaten

DeliveryDatesData · Bestelllisten und Details enthalten delivery.dates. Geplante Daten im Format YYYY-MM-DD bestätigen keinen Versand. Aktuelle Daten haben Vorrang; ältere Bestellungen verwenden die gespeicherte Schätzung. Gelöschte oder unbekannte Werte sind null. Details enthalten auch alle Positionen und Produktbilder.

dispatch_timezoneZeichenfolge nullErforderlich: Versandzeitzone (IANA; null).

Beispiel: "Europe/Warsaw"
estimated_delivery_fromZeichenfolge nullErforderlich: Beginn der voraussichtlichen Lieferung (YYYY-MM-DD; null).

Zeichenfolge:format: "date"

Beispiel: "2026-10-20"
estimated_delivery_toZeichenfolge nullErforderlich: Ende der voraussichtlichen Lieferung (YYYY-MM-DD; null).

Zeichenfolge:format: "date"

Beispiel: "2026-10-21"
planned_dispatch_onZeichenfolge nullErforderlich: Geplantes Versanddatum (YYYY-MM-DD; null).

Zeichenfolge:format: "date"

Beispiel: "2026-10-19"

Zusätzliche Felder: Nein

DeliveryPickupPointData

DeliveryPickupPointData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

addressPickupPointAddressData Erforderlich

Lieferadresse.

codeZeichenfolgeErforderlich

Stabiler maschinenlesbarer Code.

Einschränkungen

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

coordinatesPickupPointCoordinatesData nullErforderlich

Durch das umgebende Schema beschriebener Wert.

country_codeZeichenfolgeErforderlich

Ländercode.

Einschränkungen

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

environmentZeichenfolgeErforderlich

Dem Datensatz zugeordnete Umgebungsinformationen.

Einschränkungen

enum: ["live", "sandbox"]

kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["locker", "pickup_point"]

location_descriptionZeichenfolge nullErforderlich

Beschreibung in der ausgewählten Sprache.

Zeichenfolge:maxLength: 1000

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 160

opening_hoursZeichenfolge nullErforderlich

Opening hours

Zeichenfolge:maxLength: 500

operatorZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 63

verified_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

Zusätzliche Felder: Nein

Rechnungsangaben

InvoiceData · Schema · Datenschemas: Bestellungen

address_line_1Zeichenfolge nullErforderlich: Erste Adresszeile.
address_line_2Zeichenfolge nullErforderlich: Zusätzliche Adressangaben.
cityZeichenfolge nullErforderlich: Stadt oder Ort.
company_nameZeichenfolge nullErforderlich: Firmenname.
country_codeZeichenfolge nullErforderlich: Ländercode.
house_numberZeichenfolge nullErforderlich: Hausnummer.
postal_codeZeichenfolge nullErforderlich: Postleitzahl.
regionZeichenfolge nullErforderlich: Verwaltungsregion.
streetZeichenfolge nullErforderlich: Straßenname.
tax_identifierZeichenfolge nullErforderlich: Steueridentifikationsnummer.
tax_schemeZeichenfolge nullErforderlich: Steuerberechnungsschema.

Zusätzliche Felder: Nein

Nettobetrag / Steuerbetrag / Bruttobetrag

OrderAmountBreakdownData · Beträge und Steuersätze stammen aus der gespeicherten Bestellung einschließlich Positionskorrekturen. Fehlende historische Angaben sind null; aktuelle Katalogsteuersätze ersetzen sie nicht. Geldbeträge bleiben Dezimalzeichenfolgen.

grossMoneyData Erforderlich: Bruttobetrag · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullErforderlich: Nettobetrag · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullErforderlich: Steuerbetrag · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

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

Zusätzliche Felder: Nein

Versand · Rabatte

OrderDeliveryDiscountData · Beträge und Steuersätze stammen aus der gespeicherten Bestellung einschließlich Positionskorrekturen. Fehlende historische Angaben sind null; aktuelle Katalogsteuersätze ersetzen sie nicht. Geldbeträge bleiben Dezimalzeichenfolgen.

amountMoneyData Erforderlich

Bruttobetrag · Versand · Rabatte.

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

campaign_idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

Beispiel: "saved-coupon"

codeZeichenfolge nullErforderlich

Stabiler maschinenlesbarer Code.

Beispiel: "SAVE"

kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["coupon", "promotion"]

Beispiel: "coupon"

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

Beispiel: "Saved coupon"

sequenceGanzzahl nullErforderlich

Position in der geordneten Sammlung.

Beispiel: 1

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 3

Zusätzliche Felder: Nein

Abrufen — Bestellungen — Antwort

OrderDetailData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

created_atZeichenfolgeErforderlich: Zeitpunkt der Erstellung.

format: "date-time"

Beispiel: "2026-10-19T10:00:00Z"
customerCustomerData Erforderlich: Für diese Ressource gespeicherte Kundendaten.

Beispiel: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Erforderlich: Versandart und zugehörige Informationen.

Beispiel: {"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 Erforderlich: Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

Beispiel: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Erforderlich: Rabatte

Beispiel: [{"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}]
idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen. (OrderDetailData).

Beispiel: "order-0000"
invoiceInvoiceData nullErforderlich: Rechnungsangaben.

Beispiel: null
invoice_requestedBoolescher WertErforderlich: Gibt an, ob eine Rechnung angefordert wurde.

Beispiel: false
lifecycle_stateOrderLifecycleState Erforderlich: Geschäftlicher Lebenszyklusstatus.

Beispiel: "placed"
linesArray <OrderLineData > Erforderlich: Gespeicherte Bestellpositionen.

Beispiel: [{"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":[]}]
localeZeichenfolgeErforderlich: Für diese Anfrage ausgewählte Sprache.

Beispiel: "pl"
market_idZeichenfolgeErforderlich: Vom Kontext-Endpunkt zurückgegebene Marktkennung.

Beispiel: "market-pl"
numberZeichenfolgeErforderlich: Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "0001"
paymentPaymentData Erforderlich: Für die Bestellung gespeicherte Zahlungsdetails.

Beispiel: {"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 nullErforderlich: Abholpunkt

Beispiel: null
prices_include_taxBoolescher WertErforderlich: Gibt an, ob Listenpreise Steuern enthalten.

Beispiel: true
shipping_addressAddressData nullErforderlich: Lieferadresse.

Beispiel: null
shipping_discount_amountMoneyData Erforderlich: Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

Beispiel: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Erforderlich: Von dieser konkreten Operation akzeptierter Status.

Beispiel: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Erforderlich: Betrag vor den zusätzlich in der Antwort angegebenen Komponenten.

Beispiel: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Erforderlich: Steuerinformationen.

Beispiel: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Erforderlich: Steuergruppen · source + tax_rate; unallocated_tax.

Beispiel: {"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_codeZeichenfolge nullErforderlich: Steuerland · Gespeicherte Bestelldaten · ISO 3166-1 alpha-2; null.

Beispiel: "PL"
totalMoneyData Erforderlich: Gesamtbetrag.

Beispiel: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Erforderlich: Summen · net / tax / gross; Vor Rabatten / Nach Rabatten.

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

Zusätzliche Felder: Nein

Bildmetadaten und Bild-URL

OrderImageData · Schema · Datenschemas: Bestellungen

altZeichenfolge nullErforderlich: Alternativtext des Bildes.
sourceZeichenfolgeOptional: Quelle der aufgezeichneten Aktivität.

const: "current_catalog"

Standardwert: "current_catalog"
urlZeichenfolgeErforderlich: URL der Ressource.

Zusätzliche Felder: Nein

Geschäftlicher Lebenszyklusstatus

OrderLifecycleState · Schema · Datenschemas: Bestellungen

Zeichenfolge

Einschränkungen

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

Zusätzliche Felder: Ja

Gespeicherte Bestellpositionen

OrderLineData · Schema · Datenschemas: Bestellungen

discount_amountMoneyData Erforderlich: Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

Beispiel: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Erforderlich: Bruttobetrag · Rabatte; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullErforderlich: Nettobetrag · Rabatte; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullErforderlich: Steuerbetrag · Rabatte; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Erforderlich: Rabatte · net / tax / gross.

Beispiel: [{"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}]
identifiersObjektZusätzliche Felder: ZeichenfolgeErforderlich: Identifikationscodes des Produkts.

Beispiel: {}
imageOrderImageData nullErforderlich: Bildmetadaten und Bild-URL.

Beispiel: null
line_idZeichenfolgeErforderlich: Stabile Kennung der Bestellposition.

Beispiel: "saved-line-a"
manual_discountOrderManualDiscountData nullErforderlich: Manueller Rabatt; null.

Beispiel: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameZeichenfolgeErforderlich: Name der Ressource im jeweiligen Kontext.

Beispiel: "Saved A"
original_totalMoneyData Erforderlich: Gesamtbetrag.

Beispiel: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Erforderlich: Bruttobetrag · Produkte · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullErforderlich: Nettobetrag · Produkte · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullErforderlich: Steuerbetrag · Produkte · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"46.00","currency":"PLN","minor_units":2}
positionGanzzahlErforderlich: Position in der geordneten Sammlung.

Beispiel: 1
product_idZeichenfolgeErforderlich: Produktkennung.

Beispiel: "product-api"
quantityGanzzahlErforderlich: Anzahl der Einheiten.

Beispiel: 2
skuZeichenfolgeErforderlich: Artikelcode der Lagerhaltungseinheit.

Beispiel: "A"
taxMoneyData nullErforderlich: Steuerbetrag · Eine Einheit · Gespeicherte Bestelldaten; tax ≠ unit_tax; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idZeichenfolge nullErforderlich: Kennung der Steuerkategorie · Gespeicherte Bestelldaten; null.

Beispiel: "standard"
tax_category_nameZeichenfolge nullErforderlich: Gespeicherter Name der Steuerkategorie; null.

Beispiel: "VAT 23%"
tax_rateZeichenfolge nullErforderlich: tax_rate · Gespeicherte Bestelldaten: "0.23" = 23%; "0" ≠ null.

Beispiel: "0.23"
totalMoneyData Erforderlich: Gesamtbetrag.

Beispiel: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Erforderlich: Bruttobetrag · Produkte · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullErforderlich: Nettobetrag · Produkte · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullErforderlich: Steuerbetrag · Produkte · Nach Rabatten · Gespeicherte Bestelldaten; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Erforderlich: Bruttobetrag · Eine Einheit · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullErforderlich: Nettobetrag · Eine Einheit · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Erforderlich: Preis pro Einheit.

Beispiel: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullErforderlich: Steuerbetrag · Eine Einheit · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

Beispiel: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idZeichenfolge nullErforderlich: Kennung der Produktvariante.

Beispiel: null
variant_optionsArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Erforderlich: Dem Produkt oder der gespeicherten Position zugeordnete Variantenoptionen.

Beispiel: []

Zusätzliche Felder: Nein

Manueller Rabatt

OrderManualDiscountData · Beträge und Steuersätze stammen aus der gespeicherten Bestellung einschließlich Positionskorrekturen. Fehlende historische Angaben sind null; aktuelle Katalogsteuersätze ersetzen sie nicht. Geldbeträge bleiben Dezimalzeichenfolgen.

amountMoneyData Erforderlich

Bruttobetrag · Manueller Rabatt · Gespeicherte Bestelldaten.

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

kindZeichenfolgeErforderlich

Rabattart: percentage / fixed.

Einschränkungen

enum: ["percentage", "fixed"]

Beispiel: "fixed"

valueZeichenfolgeErforderlich

Konfigurierter Wert: percentage "10" = 10%; fixed = Bruttobetrag.

Beispiel: "12.30"

Zusätzliche Felder: Nein

Von dieser konkreten Operation akzeptierter Status

OrderPaymentStatus · Schema · Datenschemas: Bestellungen

Zeichenfolge

Einschränkungen

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

Zusätzliche Felder: Ja

Von dieser konkreten Operation akzeptierter Status

OrderStatusData · Schema · Datenschemas: Bestellungen

idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen. (OrderStatusData).

Beispiel: "status-0"
nameZeichenfolgeErforderlich: Name der Ressource im jeweiligen Kontext.

Beispiel: "Status 0"
updated_atZeichenfolgeErforderlich: Zeitpunkt der letzten Änderung.

format: "date-time"

Beispiel: "2026-10-19T10:00:00Z"
versionGanzzahlErforderlich: Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Auflisten · Statusliste — Bestellungen — Antwort

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

created_atZeichenfolgeErforderlich: Zeitpunkt der Erstellung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"
idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Beispiel: "example"
is_initialBoolescher WertErforderlich: Gibt an, ob dies der Anfangsstatus ist.

Beispiel: false
nameZeichenfolgeErforderlich: Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"
positionGanzzahlErforderlich: Position in der geordneten Sammlung.

Beispiel: 1

Zusätzliche Felder: Nein

Auflisten · Statusliste — Bestellungen — Antwort

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Erforderlich: Beispielantwort · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Beispiel: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Aktualisieren · Status — Bestellungen — Anfrageinhalt

OrderStatusUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1

status_idZeichenfolgeErforderlich

Kennung aus dem entsprechenden Statusverzeichnis.

Einschränkungen

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

Beispiel: "example"

Zusätzliche Felder: Nein

Auflisten — Bestellungen — Antwort

OrderSummaryData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

created_atZeichenfolgeErforderlich: Zeitpunkt der Erstellung.

format: "date-time"

Beispiel: "2026-10-19T10:00:00Z"
customerCustomerData Erforderlich: Für diese Ressource gespeicherte Kundendaten.

Beispiel: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Erforderlich: Versandart und zugehörige Informationen.

Beispiel: {"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 Erforderlich: Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

Beispiel: {"amount":"24.60","currency":"PLN","minor_units":2}
idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen. (OrderSummaryData).

Beispiel: "order-0000"
lifecycle_stateOrderLifecycleState Erforderlich: Geschäftlicher Lebenszyklusstatus.

Beispiel: "placed"
localeZeichenfolgeErforderlich: Für diese Anfrage ausgewählte Sprache.

Beispiel: "pl"
market_idZeichenfolgeErforderlich: Vom Kontext-Endpunkt zurückgegebene Marktkennung.

Beispiel: "market-pl"
numberZeichenfolgeErforderlich: Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "0001"
paymentPaymentData Erforderlich: Für die Bestellung gespeicherte Zahlungsdetails.

Beispiel: {"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_taxBoolescher WertErforderlich: Gibt an, ob Listenpreise Steuern enthalten.

Beispiel: true
shipping_discount_amountMoneyData Erforderlich: Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

Beispiel: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Erforderlich: Von dieser konkreten Operation akzeptierter Status.

Beispiel: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Erforderlich: Betrag vor den zusätzlich in der Antwort angegebenen Komponenten.

Beispiel: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Erforderlich: Steuerinformationen.

Beispiel: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeZeichenfolge nullErforderlich: Steuerland · Gespeicherte Bestelldaten · ISO 3166-1 alpha-2; null.

Beispiel: "PL"
totalMoneyData Erforderlich: Gesamtbetrag.

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

Zusätzliche Felder: Nein

Bestellung · Steuergruppen

OrderTaxBreakdownData · Beträge und Steuersätze stammen aus der gespeicherten Bestellung einschließlich Positionskorrekturen. Fehlende historische Angaben sind null; aktuelle Katalogsteuersätze ersetzen sie nicht. Geldbeträge bleiben Dezimalzeichenfolgen.

groupsArray <OrderTaxGroupData > Erforderlich: Steuergruppen · source + tax_rate; Unbekannt: null; bekannte Null: 0.

Beispiel: [{"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 Erforderlich: Nicht zugeordnete Steuer = order.tax − Σ groups.tax; ±.

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

Zusätzliche Felder: Nein

Steuergruppen

OrderTaxGroupData · Beträge und Steuersätze stammen aus der gespeicherten Bestellung einschließlich Positionskorrekturen. Fehlende historische Angaben sind null; aktuelle Katalogsteuersätze ersetzen sie nicht. Geldbeträge bleiben Dezimalzeichenfolgen.

grossMoneyData Erforderlich

Bruttobetrag · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

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

netMoneyData nullErforderlich

Nettobetrag · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

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

sourceZeichenfolgeErforderlich

Quelle: products (Produkte), shipping (Versand).

Einschränkungen

enum: ["products", "shipping"]

Beispiel: "products"

taxMoneyData nullErforderlich

Steuerbetrag · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

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

tax_rateZeichenfolge nullErforderlich

tax_rate · Gespeicherte Bestelldaten: "0.23" = 23%; "0" ≠ null.

Beispiel: "0.23"

Zusätzliche Felder: Nein

Bestellung · Summen

OrderTotalsData · Beträge und Steuersätze stammen aus der gespeicherten Bestellung einschließlich Positionskorrekturen. Fehlende historische Angaben sind null; aktuelle Katalogsteuersätze ersetzen sie nicht. Geldbeträge bleiben Dezimalzeichenfolgen.

before_discountsOrderAmountBreakdownData Erforderlich: Bestellung · Vor Rabatten · net / tax / gross.

Beispiel: {"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 Erforderlich: Rabatte · net / tax / gross.

Beispiel: {"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 Erforderlich: Bestellung · Nach Rabatten · net / tax / gross.

Beispiel: {"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 Erforderlich: Produkte · Rabatte · net / tax / gross.

Beispiel: {"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 Erforderlich: Produkte · Nach Rabatten · net / tax / gross.

Beispiel: {"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 Erforderlich: Produkte · Vor Rabatten · net / tax / gross.

Beispiel: {"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 Erforderlich: Versand · Nach Rabatten · net / tax / gross.

Beispiel: {"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 Erforderlich: Versand · Vor Rabatten · net / tax / gross.

Beispiel: {"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 Erforderlich: Versand · Rabatte · net / tax / gross.

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

Zusätzliche Felder: Nein

Dem Produkt oder der gespeicherten Position zugeordnete Variantenoptionen

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Schema · Datenschemas: Bestellungen

nameZeichenfolgeErforderlich: Name der Ressource im jeweiligen Kontext.
valueZeichenfolgeErforderlich: Durch das umgebende Schema beschriebener Wert.

Zusätzliche Felder: Nein

OrderDiscountData

OrderDiscountData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

amountMoneyData Erforderlich

Bruttobetrag · Produkte · Rabatte.

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

campaign_idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

Beispiel: "saved-coupon"

codeZeichenfolge nullErforderlich

Stabiler maschinenlesbarer Code.

Beispiel: "SAVE"

kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["coupon", "promotion"]

Beispiel: "coupon"

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

Beispiel: "Saved coupon"

sequenceGanzzahl nullOptional

Anwendungsreihenfolge; null.

Beispiel: 1

shipping_amountMoneyData nullOptional

Bruttobetrag · Versand · Rabatte; null.

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

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 3

Zusätzliche Felder: Nein

Für die Bestellung gespeicherte Zahlungsdetails

PaymentData · Schema · Datenschemas: Bestellungen

amountMoneyData Erforderlich

payment.amount ist die Bestellsumme. Der Zahlungsstatus bestimmt keine bezahlten, erstatteten oder offenen Beträge.

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

environmentZeichenfolgeErforderlich

Dem Datensatz zugeordnete Umgebungsinformationen.

Einschränkungen

enum: ["live", "sandbox"]

Beispiel: "live"

method_codeZeichenfolge nullErforderlich

Code der Versand- oder Zahlungsart.

Beispiel: "payment-old"

method_nameZeichenfolge nullErforderlich

Name der Versand- oder Zahlungsart.

Beispiel: "Historic method"

paid_atZeichenfolge nullErforderlich

Zeitpunkt der Kennzeichnung als bezahlt.

Zeichenfolge:format: "date-time"

Beispiel: null

statusOrderPaymentStatus Erforderlich

Von dieser konkreten Operation akzeptierter Status.

Beispiel: "unpaid"

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

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

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 0

Zusätzliche Felder: Nein

Aktualisieren · Zahlungsstatus — Bestellungen — Anfrageinhalt

PaymentStatusUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

expected_versionGanzzahlErforderlich: Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 0maximum: 9223372036854775807

Beispiel: 1
reasonZeichenfolgeErforderlich: Für die Änderung gespeicherte Begründung.

minLength: 1maxLength: 500

Beispiel: "Example"
statusPaymentStatus Erforderlich: Von dieser konkreten Operation akzeptierter Status.

Beispiel: "paid"

Zusätzliche Felder: Nein

Von dieser konkreten Operation akzeptierter Status

PaymentStatus · Schema · Datenschemas: Bestellungen

Zeichenfolge

Einschränkungen

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

Zusätzliche Felder: Ja

PickupPointAddressData

PickupPointAddressData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

address_line_1ZeichenfolgeErforderlich: Erste Adresszeile.

minLength: 1maxLength: 240
cityZeichenfolgeErforderlich: Stadt oder Ort.

minLength: 1maxLength: 160
postal_codeZeichenfolgeErforderlich: Postleitzahl.

minLength: 1maxLength: 32

Zusätzliche Felder: Nein

PickupPointCoordinatesData

PickupPointCoordinatesData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

latitudeZahlErforderlich: WGS84 φ (°)

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

minimum: -180.0maximum: 180.0

Zusätzliche Felder: Nein

PickupPointData

PickupPointData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

address_line1ZeichenfolgeErforderlich

Erste Adresszeile.

cityZeichenfolgeErforderlich

Stadt oder Ort.

codeZeichenfolgeErforderlich

Stabiler maschinenlesbarer Code.

country_codeZeichenfolgeErforderlich

Ländercode.

kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["locker", "pickup_point"]

latitudeZahl nullErforderlich

WGS84 φ (°)

location_descriptionZeichenfolge nullErforderlich

Beschreibung in der ausgewählten Sprache.

longitudeZahl nullErforderlich

WGS84 λ (°)

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

opening_hoursZeichenfolge nullErforderlich

Opening hours

operatorZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

postal_codeZeichenfolgeErforderlich

Postleitzahl.

Zusätzliche Felder: Nein

PickupPointSummaryData

PickupPointSummaryData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

codeZeichenfolgeErforderlich

Stabiler maschinenlesbarer Code.

Einschränkungen

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

country_codeZeichenfolgeErforderlich

Ländercode.

Einschränkungen

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

environmentZeichenfolgeErforderlich

Dem Datensatz zugeordnete Umgebungsinformationen.

Einschränkungen

enum: ["live", "sandbox"]

kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["locker", "pickup_point"]

operatorZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 63

Zusätzliche Felder: Nein

Für diese Ressource gespeicherte Kundendaten

RequestCustomerData · Schema · Datenschemas: Bestellungen

emailZeichenfolgeErforderlich: E-Mail-Adresse.

Beispiel: "customer@example.invalid"
nameZeichenfolgeErforderlich: Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"

Zusätzliche Felder: Nein

Versandart und zugehörige Informationen

ShippingData · Schema · Datenschemas: Bestellungen

amountMoneyData Erforderlich

Im Auftrag gespeicherter Bruttoversandbetrag als MoneyData. Spätere Steueränderungen ändern diesen historischen Betrag nicht.

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

datesDeliveryDatesData Erforderlich

Versand- und Lieferdaten. Bestelllisten und Details enthalten delivery.dates. Geplante Daten im Format YYYY-MM-DD bestätigen keinen Versand. Aktuelle Daten haben Vorrang; ältere Bestellungen verwenden die gespeicherte Schätzung. Gelöschte oder unbekannte Werte sind null. Details enthalten auch alle Positionen und Produktbilder.

Beispiel:

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

method_codeZeichenfolge nullErforderlich

Code der Versand- oder Zahlungsart.

Beispiel: "shipping-old"

method_nameZeichenfolge nullErforderlich

Name der Versand- oder Zahlungsart.

Beispiel: "Historic carrier"

pickup_pointPickupPointSummaryData nullErforderlich

Abholpunkt

Beispiel: null

recipient_modeZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["full_address", "pickup_contact"]

Beispiel: "full_address"

Zusätzliche Felder: Nein

ShippingDetailData

ShippingDetailData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

amountMoneyData Erforderlich

Im Auftrag gespeicherter Bruttoversandbetrag als MoneyData. Spätere Steueränderungen ändern diesen historischen Betrag nicht.

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

datesDeliveryDatesData Erforderlich

Beispiel:

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

discount_grossMoneyData Erforderlich

Bruttobetrag · Rabatte; Unbekannt: null; bekannte Null: 0.

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

discount_netMoneyData nullErforderlich

Nettobetrag · Rabatte; Unbekannt: null; bekannte Null: 0.

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

discount_taxMoneyData nullErforderlich

Steuerbetrag · Rabatte; Unbekannt: null; bekannte Null: 0.

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

discountsArray <OrderDeliveryDiscountData > nullErforderlich

Versand · Rabatte; []: 0; null: Unbekannt: null; bekannte Null: 0.

Beispiel:

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

Bruttobetrag · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

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

method_codeZeichenfolge nullErforderlich

Code der Versand- oder Zahlungsart.

Beispiel: "shipping-old"

method_nameZeichenfolge nullErforderlich

Name der Versand- oder Zahlungsart.

Beispiel: "Historic carrier"

netMoneyData nullErforderlich

Nettobetrag · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

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

original_grossMoneyData Erforderlich

Bruttobetrag · Versand · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

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

original_netMoneyData nullErforderlich

Nettobetrag · Versand · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

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

original_taxMoneyData nullErforderlich

Steuerbetrag · Versand · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

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

pickup_pointDeliveryPickupPointData nullErforderlich

Abholpunkt

Beispiel: null

recipient_modeZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["full_address", "pickup_contact"]

Beispiel: "full_address"

taxMoneyData nullErforderlich

Steuerbetrag · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

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

tax_category_idZeichenfolge nullErforderlich

Kennung der Steuerkategorie · Gespeicherte Bestelldaten; null.

Beispiel: "standard"

tax_category_nameZeichenfolge nullErforderlich

Gespeicherter Name der Steuerkategorie; null.

Beispiel: "VAT 23%"

tax_rateZeichenfolge nullErforderlich

tax_rate · Gespeicherte Bestelldaten: "0.23" = 23%; "0" ≠ null.

Beispiel: "0.23"

Zusätzliche Felder: Nein