Schémas de données: Commandes

Schémas de données: Commandes. Champs, types et contraintes des données acceptées ou renvoyées par l’API.

Schémas de données

Adresse de livraison

AddressData · Schéma · Schémas de données: Commandes

address_line_1Chaîne nullObligatoire: Première ligne d'adresse.
address_line_2Chaîne nullObligatoire: Complément d'adresse.
cityChaîne nullObligatoire: Ville ou localité.
country_codeChaîne nullObligatoire: Code du pays.
first_nameChaîne nullObligatoire: Prénom.
house_numberChaîne nullObligatoire: Numéro de bâtiment.
last_nameChaîne nullObligatoire: Nom de famille.
phoneChaîne nullObligatoire: Numéro de téléphone.
postal_codeChaîne nullObligatoire: Code postal.
regionChaîne nullObligatoire: Région administrative.
streetChaîne nullObligatoire: Nom de rue.

Champs supplémentaires: Non

Lister — Commandes — Réponse

ApiResponse_list_OrderSummaryData__ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataTableau <OrderSummaryData > Obligatoire: Exemple de réponse · ApiResponse_list_OrderSummaryData__.

Exemple: [{"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 Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Obtenir — Commandes — Réponse

ApiResponse_OrderDetailData_ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataOrderDetailData Obligatoire: Exemple de réponse · OrderDetailData.

Exemple: {"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 Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Données du client enregistrées pour cette ressource

CustomerData · Schéma · Schémas de données: Commandes

emailChaîneObligatoire: Adresse e-mail.

Exemple: "customer@example.invalid"
first_nameChaîne nullObligatoire: Prénom.

Exemple: "Example"
last_nameChaîne nullObligatoire: Nom de famille.

Exemple: "Example"
phoneChaîne nullObligatoire: Numéro de téléphone.

Exemple: null

Champs supplémentaires: Non

Dates d’expédition et de livraison

DeliveryDatesData · La liste et le détail des commandes incluent delivery.dates. Les dates YYYY-MM-DD sont prévues et ne confirment pas l’expédition. Les dates actuelles sont prioritaires ; les anciennes commandes utilisent l’estimation enregistrée. Les valeurs effacées ou inconnues sont null. Le détail inclut aussi toutes les lignes et images des produits.

dispatch_timezoneChaîne nullObligatoire: Fuseau horaire d’expédition (IANA; null).

Exemple: "Europe/Warsaw"
estimated_delivery_fromChaîne nullObligatoire: Début de livraison estimé (YYYY-MM-DD; null).

Chaîne:format: "date"

Exemple: "2026-10-20"
estimated_delivery_toChaîne nullObligatoire: Fin de livraison estimée (YYYY-MM-DD; null).

Chaîne:format: "date"

Exemple: "2026-10-21"
planned_dispatch_onChaîne nullObligatoire: Date d’expédition prévue (YYYY-MM-DD; null).

Chaîne:format: "date"

Exemple: "2026-10-19"

Champs supplémentaires: Non

DeliveryPickupPointData

DeliveryPickupPointData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

addressPickupPointAddressData Obligatoire

Adresse de livraison.

codeChaîneObligatoire

Code stable lisible par une machine.

Contraintes

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

coordinatesPickupPointCoordinatesData nullObligatoire

Valeur décrite par le schéma environnant.

country_codeChaîneObligatoire

Code du pays.

Contraintes

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

environmentChaîneObligatoire

Informations d'environnement associées à l'enregistrement.

Contraintes

enum: ["live", "sandbox"]

kindChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["locker", "pickup_point"]

location_descriptionChaîne nullObligatoire

Description dans la langue sélectionnée.

Chaîne:maxLength: 1000

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 160

opening_hoursChaîne nullObligatoire

Opening hours

Chaîne:maxLength: 500

operatorChaîneObligatoire

Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 63

verified_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

Champs supplémentaires: Non

Informations de facturation

InvoiceData · Schéma · Schémas de données: Commandes

address_line_1Chaîne nullObligatoire: Première ligne d'adresse.
address_line_2Chaîne nullObligatoire: Complément d'adresse.
cityChaîne nullObligatoire: Ville ou localité.
company_nameChaîne nullObligatoire: Nom de l'entreprise.
country_codeChaîne nullObligatoire: Code du pays.
house_numberChaîne nullObligatoire: Numéro de bâtiment.
postal_codeChaîne nullObligatoire: Code postal.
regionChaîne nullObligatoire: Région administrative.
streetChaîne nullObligatoire: Nom de rue.
tax_identifierChaîne nullObligatoire: Numéro d'identification fiscale.
tax_schemeChaîne nullObligatoire: Schéma de calcul des taxes.

Champs supplémentaires: Non

Montant net / Montant de taxe / Montant brut

OrderAmountBreakdownData · Les montants et taux proviennent de la commande enregistrée, corrections de lignes comprises. Les données historiques manquantes valent null et ne sont pas remplacées par les taux actuels du catalogue. Les montants restent des chaînes décimales.

grossMoneyData Obligatoire: Montant brut · Après remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullObligatoire: Montant net · Après remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullObligatoire: Montant de taxe · Après remises; Inconnu : null ; zéro connu : 0.

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

Champs supplémentaires: Non

Livraison · Remises

OrderDeliveryDiscountData · Les montants et taux proviennent de la commande enregistrée, corrections de lignes comprises. Les données historiques manquantes valent null et ne sont pas remplacées par les taux actuels du catalogue. Les montants restent des chaînes décimales.

amountMoneyData Obligatoire

Montant brut · Livraison · Remises.

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

campaign_idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

Exemple: "saved-coupon"

codeChaîne nullObligatoire

Code stable lisible par une machine.

Exemple: "SAVE"

kindChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["coupon", "promotion"]

Exemple: "coupon"

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

Exemple: "Saved coupon"

sequenceEntier nullObligatoire

Position dans la collection ordonnée.

Exemple: 1

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 3

Champs supplémentaires: Non

Obtenir — Commandes — Réponse

OrderDetailData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

created_atChaîneObligatoire: Date et heure de création.

format: "date-time"

Exemple: "2026-10-19T10:00:00Z"
customerCustomerData Obligatoire: Données du client enregistrées pour cette ressource.

Exemple: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Obligatoire: Mode de livraison et informations associées.

Exemple: {"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 Obligatoire: Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

Exemple: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsTableau <OrderDiscountData > Obligatoire: Réductions

Exemple: [{"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}]
idChaîneObligatoire: Identifiant de ressource ; conserver la valeur renvoyée. (OrderDetailData).

Exemple: "order-0000"
invoiceInvoiceData nullObligatoire: Informations de facturation.

Exemple: null
invoice_requestedBooléenObligatoire: Indique si une facture a été demandée.

Exemple: false
lifecycle_stateOrderLifecycleState Obligatoire: État du cycle de vie métier.

Exemple: "placed"
linesTableau <OrderLineData > Obligatoire: Instantanés des lignes de commande.

Exemple: [{"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":[]}]
localeChaîneObligatoire: Langue sélectionnée pour cette requête.

Exemple: "pl"
market_idChaîneObligatoire: Identifiant de marché renvoyé par le point d'accès au contexte.

Exemple: "market-pl"
numberChaîneObligatoire: Numéro de commande ou de demande visible par l'utilisateur.

Exemple: "0001"
paymentPaymentData Obligatoire: Détails du paiement enregistrés pour la commande.

Exemple: {"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 nullObligatoire: Point de retrait

Exemple: null
prices_include_taxBooléenObligatoire: Indique si les prix de la liste comprennent les taxes.

Exemple: true
shipping_addressAddressData nullObligatoire: Adresse de livraison.

Exemple: null
shipping_discount_amountMoneyData Obligatoire: Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

Exemple: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligatoire: Statut accepté par cette opération précise.

Exemple: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obligatoire: Montant avant les composantes supplémentaires indiquées dans la réponse.

Exemple: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligatoire: Informations sur les taxes.

Exemple: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Obligatoire: Groupes de taxes · source + tax_rate; unallocated_tax.

Exemple: {"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_codeChaîne nullObligatoire: Pays fiscal · Données enregistrées de la commande · ISO 3166-1 alpha-2; null.

Exemple: "PL"
totalMoneyData Obligatoire: Montant total.

Exemple: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Obligatoire: Totaux · net / tax / gross; Avant remises / Après remises.

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

Champs supplémentaires: Non

Métadonnées et URL de l'image

OrderImageData · Schéma · Schémas de données: Commandes

altChaîne nullObligatoire: Texte alternatif de l'image.
sourceChaîneFacultatif: Source de l'activité enregistrée.

const: "current_catalog"

Valeur par défaut: "current_catalog"
urlChaîneObligatoire: URL de la ressource.

Champs supplémentaires: Non

État du cycle de vie métier

OrderLifecycleState · Schéma · Schémas de données: Commandes

Chaîne

Contraintes

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

Champs supplémentaires: Oui

Instantanés des lignes de commande

OrderLineData · Schéma · Schémas de données: Commandes

discount_amountMoneyData Obligatoire: Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

Exemple: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Obligatoire: Montant brut · Remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObligatoire: Montant net · Remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObligatoire: Montant de taxe · Remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsTableau <OrderDiscountData > Obligatoire: Remises · net / tax / gross.

Exemple: [{"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}]
identifiersObjetChamps supplémentaires: ChaîneObligatoire: Codes d'identification du produit.

Exemple: {}
imageOrderImageData nullObligatoire: Métadonnées et URL de l'image.

Exemple: null
line_idChaîneObligatoire: Identifiant stable de la ligne de commande.

Exemple: "saved-line-a"
manual_discountOrderManualDiscountData nullObligatoire: Remise manuelle; null.

Exemple: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameChaîneObligatoire: Nom de la ressource dans le contexte concerné.

Exemple: "Saved A"
original_totalMoneyData Obligatoire: Montant total.

Exemple: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Obligatoire: Montant brut · Produits · Avant remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullObligatoire: Montant net · Produits · Avant remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullObligatoire: Montant de taxe · Produits · Avant remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"46.00","currency":"PLN","minor_units":2}
positionEntierObligatoire: Position dans la collection ordonnée.

Exemple: 1
product_idChaîneObligatoire: Identifiant du produit.

Exemple: "product-api"
quantityEntierObligatoire: Nombre d'unités.

Exemple: 2
skuChaîneObligatoire: Code de l'unité de gestion des stocks.

Exemple: "A"
taxMoneyData nullObligatoire: Montant de taxe · Une unité · Données enregistrées de la commande; tax ≠ unit_tax; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idChaîne nullObligatoire: Identifiant de catégorie fiscale · Données enregistrées de la commande; null.

Exemple: "standard"
tax_category_nameChaîne nullObligatoire: Nom enregistré de la catégorie fiscale; null.

Exemple: "VAT 23%"
tax_rateChaîne nullObligatoire: tax_rate · Données enregistrées de la commande: "0.23" = 23%; "0" ≠ null.

Exemple: "0.23"
totalMoneyData Obligatoire: Montant total.

Exemple: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Obligatoire: Montant brut · Produits · Après remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullObligatoire: Montant net · Produits · Après remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullObligatoire: Montant de taxe · Produits · Après remises · Données enregistrées de la commande; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Obligatoire: Montant brut · Une unité · Avant remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullObligatoire: Montant net · Une unité · Avant remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obligatoire: Prix unitaire.

Exemple: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullObligatoire: Montant de taxe · Une unité · Avant remises; Inconnu : null ; zéro connu : 0.

Exemple: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idChaîne nullObligatoire: Identifiant de la variante du produit.

Exemple: null
variant_optionsTableau <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Obligatoire: Options de variante associées au produit ou à l'instantané enregistré.

Exemple: []

Champs supplémentaires: Non

Remise manuelle

OrderManualDiscountData · Les montants et taux proviennent de la commande enregistrée, corrections de lignes comprises. Les données historiques manquantes valent null et ne sont pas remplacées par les taux actuels du catalogue. Les montants restent des chaînes décimales.

amountMoneyData Obligatoire

Montant brut · Remise manuelle · Données enregistrées de la commande.

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

kindChaîneObligatoire

Type de remise: percentage / fixed.

Contraintes

enum: ["percentage", "fixed"]

Exemple: "fixed"

valueChaîneObligatoire

Valeur configurée: percentage "10" = 10%; fixed = Montant brut.

Exemple: "12.30"

Champs supplémentaires: Non

Statut accepté par cette opération précise

OrderPaymentStatus · Schéma · Schémas de données: Commandes

Chaîne

Contraintes

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

Champs supplémentaires: Oui

Statut accepté par cette opération précise

OrderStatusData · Schéma · Schémas de données: Commandes

idChaîneObligatoire: Identifiant de ressource ; conserver la valeur renvoyée. (OrderStatusData).

Exemple: "status-0"
nameChaîneObligatoire: Nom de la ressource dans le contexte concerné.

Exemple: "Status 0"
updated_atChaîneObligatoire: Date et heure de la dernière modification.

format: "date-time"

Exemple: "2026-10-19T10:00:00Z"
versionEntierObligatoire: Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Lister · Statuts — Commandes — Réponse

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

created_atChaîneObligatoire: Date et heure de création.

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"
idChaîneObligatoire: Identifiant de ressource ; conserver la valeur renvoyée. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Exemple: "example"
is_initialBooléenObligatoire: Indique s'il s'agit du statut initial.

Exemple: false
nameChaîneObligatoire: Nom de la ressource dans le contexte concerné.

Exemple: "Example"
positionEntierObligatoire: Position dans la collection ordonnée.

Exemple: 1

Champs supplémentaires: Non

Lister · Statuts — Commandes — Réponse

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataTableau <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Obligatoire: Exemple de réponse · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Exemple: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

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

Champs supplémentaires: Non

Modifier · Statut — Commandes — Corps de la requête

OrderStatusUpdate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

expected_versionEntierObligatoire

Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 1maximum: 9223372036854775807

Exemple: 1

status_idChaîneObligatoire

Identifiant obtenu dans le répertoire de statuts correspondant.

Contraintes

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

Exemple: "example"

Champs supplémentaires: Non

Lister — Commandes — Réponse

OrderSummaryData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

created_atChaîneObligatoire: Date et heure de création.

format: "date-time"

Exemple: "2026-10-19T10:00:00Z"
customerCustomerData Obligatoire: Données du client enregistrées pour cette ressource.

Exemple: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Obligatoire: Mode de livraison et informations associées.

Exemple: {"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 Obligatoire: Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

Exemple: {"amount":"24.60","currency":"PLN","minor_units":2}
idChaîneObligatoire: Identifiant de ressource ; conserver la valeur renvoyée. (OrderSummaryData).

Exemple: "order-0000"
lifecycle_stateOrderLifecycleState Obligatoire: État du cycle de vie métier.

Exemple: "placed"
localeChaîneObligatoire: Langue sélectionnée pour cette requête.

Exemple: "pl"
market_idChaîneObligatoire: Identifiant de marché renvoyé par le point d'accès au contexte.

Exemple: "market-pl"
numberChaîneObligatoire: Numéro de commande ou de demande visible par l'utilisateur.

Exemple: "0001"
paymentPaymentData Obligatoire: Détails du paiement enregistrés pour la commande.

Exemple: {"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_taxBooléenObligatoire: Indique si les prix de la liste comprennent les taxes.

Exemple: true
shipping_discount_amountMoneyData Obligatoire: Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

Exemple: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligatoire: Statut accepté par cette opération précise.

Exemple: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obligatoire: Montant avant les composantes supplémentaires indiquées dans la réponse.

Exemple: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligatoire: Informations sur les taxes.

Exemple: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeChaîne nullObligatoire: Pays fiscal · Données enregistrées de la commande · ISO 3166-1 alpha-2; null.

Exemple: "PL"
totalMoneyData Obligatoire: Montant total.

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

Champs supplémentaires: Non

Commande · Groupes de taxes

OrderTaxBreakdownData · Les montants et taux proviennent de la commande enregistrée, corrections de lignes comprises. Les données historiques manquantes valent null et ne sont pas remplacées par les taux actuels du catalogue. Les montants restent des chaînes décimales.

groupsTableau <OrderTaxGroupData > Obligatoire: Groupes de taxes · source + tax_rate; Inconnu : null ; zéro connu : 0.

Exemple: [{"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 Obligatoire: Taxe non affectée = order.tax − Σ groups.tax; ±.

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

Champs supplémentaires: Non

Groupes de taxes

OrderTaxGroupData · Les montants et taux proviennent de la commande enregistrée, corrections de lignes comprises. Les données historiques manquantes valent null et ne sont pas remplacées par les taux actuels du catalogue. Les montants restent des chaînes décimales.

grossMoneyData Obligatoire

Montant brut · Après remises; Inconnu : null ; zéro connu : 0.

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

netMoneyData nullObligatoire

Montant net · Après remises; Inconnu : null ; zéro connu : 0.

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

sourceChaîneObligatoire

Source: products (Produits), shipping (Livraison).

Contraintes

enum: ["products", "shipping"]

Exemple: "products"

taxMoneyData nullObligatoire

Montant de taxe · Après remises; Inconnu : null ; zéro connu : 0.

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

tax_rateChaîne nullObligatoire

tax_rate · Données enregistrées de la commande: "0.23" = 23%; "0" ≠ null.

Exemple: "0.23"

Champs supplémentaires: Non

Commande · Totaux

OrderTotalsData · Les montants et taux proviennent de la commande enregistrée, corrections de lignes comprises. Les données historiques manquantes valent null et ne sont pas remplacées par les taux actuels du catalogue. Les montants restent des chaînes décimales.

before_discountsOrderAmountBreakdownData Obligatoire: Commande · Avant remises · net / tax / gross.

Exemple: {"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 Obligatoire: Remises · net / tax / gross.

Exemple: {"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 Obligatoire: Commande · Après remises · net / tax / gross.

Exemple: {"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 Obligatoire: Produits · Remises · net / tax / gross.

Exemple: {"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 Obligatoire: Produits · Après remises · net / tax / gross.

Exemple: {"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 Obligatoire: Produits · Avant remises · net / tax / gross.

Exemple: {"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 Obligatoire: Livraison · Après remises · net / tax / gross.

Exemple: {"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 Obligatoire: Livraison · Avant remises · net / tax / gross.

Exemple: {"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 Obligatoire: Livraison · Remises · net / tax / gross.

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

Champs supplémentaires: Non

Options de variante associées au produit ou à l'instantané enregistré

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Schéma · Schémas de données: Commandes

nameChaîneObligatoire: Nom de la ressource dans le contexte concerné.
valueChaîneObligatoire: Valeur décrite par le schéma environnant.

Champs supplémentaires: Non

OrderDiscountData

OrderDiscountData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

amountMoneyData Obligatoire

Montant brut · Produits · Remises.

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

campaign_idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

Exemple: "saved-coupon"

codeChaîne nullObligatoire

Code stable lisible par une machine.

Exemple: "SAVE"

kindChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["coupon", "promotion"]

Exemple: "coupon"

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

Exemple: "Saved coupon"

sequenceEntier nullFacultatif

Ordre d’application; null.

Exemple: 1

shipping_amountMoneyData nullFacultatif

Montant brut · Livraison · Remises; null.

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

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 3

Champs supplémentaires: Non

Détails du paiement enregistrés pour la commande

PaymentData · Schéma · Schémas de données: Commandes

amountMoneyData Obligatoire

payment.amount est le total de la commande. Le statut du paiement ne détermine pas les montants payés, remboursés ou restant dus.

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

environmentChaîneObligatoire

Informations d'environnement associées à l'enregistrement.

Contraintes

enum: ["live", "sandbox"]

Exemple: "live"

method_codeChaîne nullObligatoire

Code du mode de livraison ou de paiement.

Exemple: "payment-old"

method_nameChaîne nullObligatoire

Nom du mode de livraison ou de paiement.

Exemple: "Historic method"

paid_atChaîne nullObligatoire

Date et heure du passage au statut payé.

Chaîne:format: "date-time"

Exemple: null

statusOrderPaymentStatus Obligatoire

Statut accepté par cette opération précise.

Exemple: "unpaid"

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

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

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 0

Champs supplémentaires: Non

Modifier · Statut du paiement — Commandes — Corps de la requête

PaymentStatusUpdate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

expected_versionEntierObligatoire: Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 0maximum: 9223372036854775807

Exemple: 1
reasonChaîneObligatoire: Motif enregistré pour la modification.

minLength: 1maxLength: 500

Exemple: "Example"
statusPaymentStatus Obligatoire: Statut accepté par cette opération précise.

Exemple: "paid"

Champs supplémentaires: Non

Statut accepté par cette opération précise

PaymentStatus · Schéma · Schémas de données: Commandes

Chaîne

Contraintes

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

Champs supplémentaires: Oui

PickupPointAddressData

PickupPointAddressData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

address_line_1ChaîneObligatoire: Première ligne d'adresse.

minLength: 1maxLength: 240
cityChaîneObligatoire: Ville ou localité.

minLength: 1maxLength: 160
postal_codeChaîneObligatoire: Code postal.

minLength: 1maxLength: 32

Champs supplémentaires: Non

PickupPointCoordinatesData

PickupPointCoordinatesData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

latitudeNombreObligatoire: WGS84 φ (°)

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

minimum: -180.0maximum: 180.0

Champs supplémentaires: Non

PickupPointData

PickupPointData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

address_line1ChaîneObligatoire

Première ligne d'adresse.

cityChaîneObligatoire

Ville ou localité.

codeChaîneObligatoire

Code stable lisible par une machine.

country_codeChaîneObligatoire

Code du pays.

kindChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["locker", "pickup_point"]

latitudeNombre nullObligatoire

WGS84 φ (°)

location_descriptionChaîne nullObligatoire

Description dans la langue sélectionnée.

longitudeNombre nullObligatoire

WGS84 λ (°)

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

opening_hoursChaîne nullObligatoire

Opening hours

operatorChaîneObligatoire

Nom de la ressource dans le contexte concerné.

postal_codeChaîneObligatoire

Code postal.

Champs supplémentaires: Non

PickupPointSummaryData

PickupPointSummaryData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

codeChaîneObligatoire

Code stable lisible par une machine.

Contraintes

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

country_codeChaîneObligatoire

Code du pays.

Contraintes

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

environmentChaîneObligatoire

Informations d'environnement associées à l'enregistrement.

Contraintes

enum: ["live", "sandbox"]

kindChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["locker", "pickup_point"]

operatorChaîneObligatoire

Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 63

Champs supplémentaires: Non

Données du client enregistrées pour cette ressource

RequestCustomerData · Schéma · Schémas de données: Commandes

emailChaîneObligatoire: Adresse e-mail.

Exemple: "customer@example.invalid"
nameChaîneObligatoire: Nom de la ressource dans le contexte concerné.

Exemple: "Example"

Champs supplémentaires: Non

Mode de livraison et informations associées

ShippingData · Schéma · Schémas de données: Commandes

amountMoneyData Obligatoire

Montant TTC de la livraison enregistré dans la commande sous forme de MoneyData. Les modifications fiscales ultérieures ne changent pas ce montant historique.

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

datesDeliveryDatesData Obligatoire

Dates d’expédition et de livraison. La liste et le détail des commandes incluent delivery.dates. Les dates YYYY-MM-DD sont prévues et ne confirment pas l’expédition. Les dates actuelles sont prioritaires ; les anciennes commandes utilisent l’estimation enregistrée. Les valeurs effacées ou inconnues sont null. Le détail inclut aussi toutes les lignes et images des produits.

Exemple:

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

method_codeChaîne nullObligatoire

Code du mode de livraison ou de paiement.

Exemple: "shipping-old"

method_nameChaîne nullObligatoire

Nom du mode de livraison ou de paiement.

Exemple: "Historic carrier"

pickup_pointPickupPointSummaryData nullObligatoire

Point de retrait

Exemple: null

recipient_modeChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["full_address", "pickup_contact"]

Exemple: "full_address"

Champs supplémentaires: Non

ShippingDetailData

ShippingDetailData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

amountMoneyData Obligatoire

Montant TTC de la livraison enregistré dans la commande sous forme de MoneyData. Les modifications fiscales ultérieures ne changent pas ce montant historique.

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

datesDeliveryDatesData Obligatoire

Exemple:

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

discount_grossMoneyData Obligatoire

Montant brut · Remises; Inconnu : null ; zéro connu : 0.

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

discount_netMoneyData nullObligatoire

Montant net · Remises; Inconnu : null ; zéro connu : 0.

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

discount_taxMoneyData nullObligatoire

Montant de taxe · Remises; Inconnu : null ; zéro connu : 0.

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

discountsTableau <OrderDeliveryDiscountData > nullObligatoire

Livraison · Remises; []: 0; null: Inconnu : null ; zéro connu : 0.

Exemple:

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

Montant brut · Après remises; Inconnu : null ; zéro connu : 0.

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

method_codeChaîne nullObligatoire

Code du mode de livraison ou de paiement.

Exemple: "shipping-old"

method_nameChaîne nullObligatoire

Nom du mode de livraison ou de paiement.

Exemple: "Historic carrier"

netMoneyData nullObligatoire

Montant net · Après remises; Inconnu : null ; zéro connu : 0.

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

original_grossMoneyData Obligatoire

Montant brut · Livraison · Avant remises; Inconnu : null ; zéro connu : 0.

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

original_netMoneyData nullObligatoire

Montant net · Livraison · Avant remises; Inconnu : null ; zéro connu : 0.

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

original_taxMoneyData nullObligatoire

Montant de taxe · Livraison · Avant remises; Inconnu : null ; zéro connu : 0.

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

pickup_pointDeliveryPickupPointData nullObligatoire

Point de retrait

Exemple: null

recipient_modeChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["full_address", "pickup_contact"]

Exemple: "full_address"

taxMoneyData nullObligatoire

Montant de taxe · Après remises; Inconnu : null ; zéro connu : 0.

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

tax_category_idChaîne nullObligatoire

Identifiant de catégorie fiscale · Données enregistrées de la commande; null.

Exemple: "standard"

tax_category_nameChaîne nullObligatoire

Nom enregistré de la catégorie fiscale; null.

Exemple: "VAT 23%"

tax_rateChaîne nullObligatoire

tax_rate · Données enregistrées de la commande: "0.23" = 23%; "0" ≠ null.

Exemple: "0.23"

Champs supplémentaires: Non