Exporter les commandes

Définition des champs

Les champs obligatoires sont signalés par un crayon. Les définitions de champs se réfèrent à la syntaxe MySQL.

L'exportation contient l'élément ` <orders>`. Cet élément peut contenir entre 1 et n éléments ` <order>`. L'API peut être étendue dans la requête HTTP via ` /xxx` pour appeler un fichier XSLT. Vous obtenez alors un fichier XML qui a été transformé conformément au fichier XSLT sélectionné.

orders_id
int(11)
Numéro de commande
shop_id
int(3)
Numéro de boutique. Pertinent uniquement pour les boutiques multiples (par défaut : 1)
marketplace_id
int(11)
ID de la place de marché
marketplace_data
text
Données spécifiques à la place de marché (encodées en JSON)
invoice_id_individuel
int(11)
Numéro de facture, si la série de numéros de facture individuelle a été activée, sinon 0
invoice_date
date
Date de la facture, si la série de numéros de facture individuelle a été activée
invoice_payment_term_date
date
Délai de paiement
service_date
datetime
Date de prestation
date_de_prestation_estimée
datetime
Date de prestation (prévue)
shipping_date
datetime
Date de livraison (prévue)
estimated_shipping_date
datetime
Date de livraison (prévue)
delivery_option
varchar(30)
Options de livraison spéciales, par exemple date de livraison souhaitée
date_de_livraison_souhaitée
varchar(30)
Date de livraison souhaitée
customers_id
int(11)
Numéro de client
customers_id_extern
VARCHAR(64)
Numéro de client (externe)
manager_id
int(11)
Numéro de client du responsable (uniquement si un responsable passe commande pour le client)
manager_id_extern
VARCHAR(64)
Numéro de client (externe) du responsable (uniquement si un responsable passe commande pour le client)
customers_group_id
int(11)
ID du groupe de clients
customers_firstname
varchar(64)
Client : prénom
customers_lastname
varchar(64)
Client : nom
customers_gender
varchar(1)
Client : sexe (''|m|f|c) - vide, homme, femme, entreprise
customers_dob
date
Client : date de naissance
customers_company
varchar(64)
Client : nom de l'entreprise
customers_street_address
varchar(64)
Client : rue et numéro
customers_suburb
varchar(64)
Client : complément d'adresse
customers_city
varchar(32)
Client : ville
customers_postcode
varchar(10)
Client : code postal
customers_state
varchar(32)
Client : région
customers_country
varchar(32)
Client : Pays (texte)
customers_country_id
int(11)
Client : pays (ID)
customers_telephone
varchar(32)
Client : numéro de téléphone
customers_email_address
varchar(96)
Client : adresse e-mail
customers_address_format_id
int(5)
Client : ID du format d'adresse (par défaut : 5)
delivery_firstname
varchar(64)
Livraison : prénom
delivery_lastname
varchar(64)
Livraison : nom de famille
delivery_gender
varchar(1)
Livraison : sexe (''|m|f|c)
delivery_company
varchar(64)
Livraison : nom de l'entreprise
delivery_street_address
varchar(64)
Livraison : rue et numéro
delivery_suburb
varchar(64)
Livraison : complément d'adresse
delivery_city
varchar(32)
Livraison : ville
delivery_postcode
varchar(10)
Livraison : code postal
delivery_state
varchar(32)
Livraison : région
delivery_country
varchar(32)
Livraison : pays (texte)
delivery_country_id
int(11)
Livraison : pays (ID)
delivery_address_format_id
int(5)
Livraison : ID du format d'adresse (par défaut : 5)
prénom_facturation
varchar(64)
Facturation : prénom
billing_lastname
varchar(64)
Facture : nom de famille
billing_gender
varchar(1)
Facture : sexe (''|m|f|c)
billing_company
varchar(64)
Facture : nom de l'entreprise
billing_company_tax_id
varchar(32)
Facture : numéro d'identification TVA
billing_street_address
varchar(64)
Facture : rue et numéro
billing_suburb
varchar(64)
Facture : complément d'adresse
billing_city
varchar(32)
Facture : ville
billing_postcode
varchar(10)
Facture : code postal
billing_state
varchar(32)
Facture : État
billing_country
varchar(32)
Facture : pays (texte)
billing_country_id
int(11)
Facture : pays (ID)
billing_address_format_id
int(5)
Facture : ID du format d'adresse (par défaut : 5)
payment_method
varchar(64)
Mode de paiement (texte)
cc_type
varchar(64)
-
cc_owner
varchar(64)
-
cc_number
varchar(32)
-
cc_cvv2
varchar(4)
-
cc_expires
varchar(4)
-
last_modified
datetime
Dernière modification
date_purchased
datetime
Date de commande
orders_status
int(5)
Statut actuel de la commande (ID)
orders_date_finished
datetime
-
currency
char(3)
Code de devise (ISO 3)
currency_value
decimal(13,8)
Valeur de la devise (par défaut 1,0, différente si ce n'est pas la devise par défaut de la boutique)
account_name
varchar(32)
-
account_number
varchar(20)
-
po_number
varchar(50)
Numéro de bon de commande (numéro de commande propre)
achat_sans_compte
tinyint(1)
Achat sans compte client (1 = oui, 2 = non)
customers_ip
varchar(15)
Client : adresse IP (masquée)
billing_cf
varchar(25)
-
billing_piva
varchar(25)
-
poids_total_commande
decimal(8,4)
Poids total (kg)
payment_class
varchar(32)
Paiement : classe
payment_module
varchar(32)
Paiement : sous-module (uniquement pour certaines classes)
payment_instructions
text
Instructions de paiement (par exemple, pour un achat sur facture via PayPal)
shipping_class
varchar(32)
Expédition : classe
language_id
int(11)
Langue du client (ID)
strict_id
int(11)
Paiement : numéro d'opération (uniquement pour certaines classes)
pay_id
varchar(64)
ID de paiement 2
document
varchar(32)
-
indiv_text0
longtext
Texte personnalisé de confirmation de commande
indiv_text1
longtext
Texte personnalisé de la facture
indiv_text2
longtext
Texte personnalisé du bon de livraison
indiv_text3
longtext
Texte personnalisé de la liste de colisage
indiv_text4
longtext
Texte personnalisé de l'offre
rating_mail
tinyint(1)
Autorisation d'envoyer un e-mail d'évaluation (système externe)
rating_mail_shop
tinyint(1)
Autorisation d'envoyer un e-mail d'évaluation (système interne)
tax_flag
varchar(1)
Affichage des taxes (0 = brut (taxe comprise), 1 = net (hors taxe), 2 = net (exonéré de TVA))
external_id
varchar(64)
Numéro externe / Identifiant de paiement 1
ebay_username
varchar(150)
Nom d'utilisateur eBay (API eBayLegacy)
ebay_extendedorderid
varchar(20)
Numéro de commande étendu eBay (API eBayLegacy)
hold
tinyint(1)
.
customers_additional_address
mediumtext
Client : - (plus utilisé) 
delivery_additional_address
mediumtext
Livraison : - (plus utilisé) 
billing_additional_address
mediumtext
Paiement : - (n'est plus utilisé) 
fsk_check
varchar(100)
-
fichier de passeport
varchar(200)
-
back_credit_note
int(1)
-
données_du_bureau_de_poste_de_livraison
text_moyen
-
vérification_de_la_confidentialité_de_l'expédition
tinyint(4)
Consentement à la transmission de l'adresse e-mail/du numéro de téléphone au prestataire de services d'expédition (1 = Oui, 0 = Non)
indiv_rg
varchar(64)
Fichier de facturation individuel (remplace l'affichage standard de la facture)
indiv_ls
varchar(64)
Bon de livraison individuel (remplace l'affichage par défaut du bon de livraison)
device
enum('mobile','desktop')
Commande depuis un appareil mobile ou un ordinateur de bureau
frais_de_gestion
décimal(16,8)
Frais de gestion forfaitaires
transaction_fee
decimal(16,8)
Frais de transaction
selling_fee
decimal(16,8)
Frais de vente
other_fee
decimal(16,8)
Autres frais
orders_change_cache
text
- (utilisé en interne pour le remplacement de modules spéciaux)
vca_ready
tinyint(4)
- (uniquement pour la connexion VCA)
vca_exported
tinyint(4)
- (uniquement pour la connexion VCA)
vca_blocked
tinyint(4)
- (uniquement pour la connexion VCA)
vca_last_email
datetime
- (uniquement pour la connexion VCA)
suppliers_id
int(11)
Numéro de fournisseur (une valeur supérieure à 0 indique qu'il s'agit d'une commande fournisseur)
suppliers_orders_id
varchar(40)
Numéro de commande fournisseur
suppliers_order_details
text
-
suppliers_order_details2
text
-
suppliers_order_type
varchar(4)
-
dernière_mise_à_jour_des_détails_de_commande_fournisseurs
datetime
-
dernière_mise_à_jour_des_détails_de_commande_fournisseurs2
date-heure
-
external_order_details
text moyen
-
external_order_details_last_updated
datetime
-
external_order_error_details
text moyen
-
détails_erreur_commande_externe_dernière_mise_à_jour
datetime
-
vérification_produit_commande_externe
tinyint(1)
-
external_document_check
tinyint(1)
-
payment_part_1
DECIMAL(16,8)
Montant de la première tranche
payment_part_2
DECIMAL(16,8)
Montant de la mensualité 2
payment_part_3
DECIMAL(16,8)
Montant de la mensualité 3
payment_part_4
DECIMAL(16,8)
Montant de la mensualité 4
payment_part_5
DECIMAL(16,8)
Montant de la mensualité 5
date_de_paiement_1
DATETIME
Date du versement 1
payment_date_2
DATETIME
Date du versement partiel 2
payment_date_3
DATETIME
Date du versement 3
payment_date_4
DATETIME
Date du versement 4
payment_date_5
DATETIME
Date du versement 5
payment_purpose_1
VARCHAR(255)
Objet du versement partiel 1
payment_purpose_2
VARCHAR(255)
Motif du paiement échelonné 2
payment_purpose_3
VARCHAR(255)
Motif du paiement échelonné 3
payment_purpose_4
VARCHAR(255)
Motif de paiement échelonné 4
payment_purpose_5
VARCHAR(255)
Motif du paiement échelonné 5
payment_hash_1
VARCHAR(255)
Hachage du paiement échelonné 1
payment_hash_2
VARCHAR(255)
Hachage du paiement échelonné 2
hachage_paiement_3
VARCHAR(255)
Hachage du paiement échelonné 3
payment_hash_4
VARCHAR(255)
Hachage du paiement échelonné 4
payment_hash_5
VARCHAR(255)
Hachage du paiement échelonné 5
orders_status_id
int(11)
Statut actuel de la commande (ID)
orders_status_name
varchar(50)
Statut actuel de la commande (nom)
orders_status_label
enum('primary'
Statut actuel de la commande (classe de couleur)
orders_status_label_bg
varchar(7)
Statut actuel de la commande (code hexadécimal de la couleur d'arrière-plan #XXXXXX)
orders_status_label_color
varchar(7)
Statut actuel de la commande (code hexadécimal de la couleur du texte #XXXXXX)
orders_status_sort_order
int(3)
Statut actuel de la commande (ordre de tri)
customers_language_code
varchar(255)
Client : code de langue (ISO-2, minuscules)
customers_country_code
varchar(255)
Client : pays (ISO-2)
delivery_country_code
varchar(255)
Livraison : pays (ISO-2)
billing_country_code
varchar(255)
Facturation : pays (ISO-2)
orders_comment
varchar(255)
Commentaire de commande
products
product
Chaque nœud « products » contient [1..n] nœuds « product ».
product
commandes_produits_id
int(11)
Clé primaire de la ligne de commande
orders_id
int(11)
Numéro de commande
products_id
int(11)
Produit : ID
marketplace_id
INT(11)
Place de marché : ID de la place de marché
bundle_id
INT(11)
Produit : ID du lot
marketplace_external_id
VARCHAR(128)
Place de marché : ID externe de la ligne de commande
marketplace_data
TEXT
Place de marché : données externes supplémentaires relatives au poste de commande (encodées en JSON)
products_model
varchar(255)
Produit : référence
products_name
varchar(255)
Produit : nom
prix_produit_ek
decimal(16,8)
Produit : prix d'achat (net) par unité d'emballage
products_price
décimal(16,8)
Produit : prix de vente (net) par unité d'emballage
final_price
decimal(16,8)
Produit : prix de vente final (net, par exemple pour les attributs payants) par unité d'emballage
products_tax
decimal(8,4)
Produit : taux d'imposition
products_quantity
décimal(16,8)
Produit : quantité
stockages_produits
mediumtext
Produit : répartition du nombre total entre les entrepôts (encodé en JSON, uniquement lorsque la fonctionnalité multi-entrepôts est activée)
products_unit
varchar(128)
Produit : unité
service_date
datetime
Produit : date de prestation
date_de_service_estimée
datetime
Produit : Date de prestation (prévue)
shipping_date
datetime
Produit : date de livraison
estimated_shipping_date
datetime
Produit : date de livraison (prévue)
shipping_profile_id
INT(11)
Produit : profil de statut (ID)
shipping_profile
TEXT
Produit : profil de feux tricolores (texte)
date_available
date
Produit : Date de disponibilité
ebay_transaction_id
varchar(255)
Produit : numéro de transaction eBay (API héritée d'eBay)
ebay_item_id
varchar(255)
Produit : ID d'article eBay (API héritée d'eBay)
ean
varchar(20)
Produit : GTIN
products_review_hash
varchar(256)
- (interne : hachage d'évaluation pour le système d'évaluation interne)
contract_ok_flag
TINYINT(1)
- (interne : indicateur de validation du contrat)
products_weight
varchar(255)
Produit : poids
storage_comment
varchar(255)
Produit : remarque sur la liste de colisage (uniquement pour la liste de colisage)
totals
total
Chaque nœud « totals » contient [1..n] nœuds « total ».
total
orders_total_id
INT(10)
Clé primaire de la ligne OrderTotal
orders_id
INT(11)
Numéro de commande
title
VARCHAR(255)
OrderTotal : titre (par ex. frais de port, montant total)
text
VARCHAR(255)
OrderTotal : valeur sous forme de texte
value
DECIMAL(16,8)
OrderTotal : valeur (nombre à virgule flottante)
overwrite
DECIMAL(16,8)
OrderTotal : valeur de remplacement (en cas de modification via l'éditeur de commande)
tax
decimal(11,8)
OrderTotal : taxe (valeur)
class
VARCHAR(32)
OrderTotal : classe (identifie le type de manière unique, par exemple ot_shipping : frais de port, ot_total : montant total)
sort_order
INT(11)
OrderTotal : ordre de tri (pour l'affichage)
html
TEXT
OrderTotal : HTML (information facultative, par exemple, détail des frais de port)

Modèle openTRANS

Le modèle opentrans (/Export/XML/order/{id}/opentrans) vous permet d'obtenir la commande au format openTRANS 2.1. Chaque article correspond à un poste (ORDER_ITEM), tout comme les lignes de total pour les frais de port, les frais d'expédition spéciaux, les frais de contre-remboursement, le supplément pour quantité minimale, la remise, la remise de fidélité, le coupon, le bon d'achat, les frais de paiement et l'escompte ; pour celles-ci, la classe est indiquée dans BUYER_PID. TOTAL_ITEM_NUM correspond à la somme des quantités d'articles plus le nombre de ces lignes de total, tandis que TOTAL_AMOUNT correspond à la valeur de ot_total.

Modification apportée dans la v2.122.13 (Shop 4.9.174) : la remise de fidélité (ot_loyalty_discount) apparaît sous forme de déduction : un poste avec un montant négatif qui est pris en compte dans TOTAL_ITEM_NUM. Jusqu’à la v2.122.12, le modèle demandait ot_loyality_discount (faute de frappe). La déduction était absente, et le total des lignes dépassait TOTAL_AMOUNT. Exemple : article 119,00 €, remise de fidélité 5,95 €, TOTAL_AMOUNT 113,05 € : jusqu’à la version v2.122.12, le total des lignes s’élevait à 119,00 €. Les modèles personnalisés de la boutique qui ont repris la liste des classes depuis orders-opentrans.xsl conservent cette faute de frappe ; remplacez-y ot_loyality_discount par ot_loyalty_discount (dans le décompte et dans la sélection des articles).

Exemple de fichier XML

Le fichier XML d'exemple contient une commande client comprenant un produit et plusieurs lignes de total.

Télécharger l'exemple :

Télécharger

Last updated: 27 octobre 2026