Interface service Web REST

URL de la ressource

https://ecommerce.dexero.com/service/rest/2/marchand/catalogue/orders.format

Paramètres

Paramètre	Description
count	Indique le nombre d'enregistrements à récupérer. La valeur par défaut 20. Exemple de valeur : 30 Max : 500
offset	Le point de départ de décalage (basé sur 0) du premier objet à retourner dans la liste. La valeur par défaut est 0. Exemple de valeur : 20
sort_key	Le champ sur lequel trier les résultats retournés. Si le champ n'est pas présent sur une entrée, la valeur de chaîne vide est utilisée. La valeur par défaut est purchasedTimestamp. Exemple de valeur : purchasedTimestamp
sort_dir	La direction de triage des resultats. La valeur par défaut est asc. Exemple de valeur : asc, desc
customer_email	Le courriel du client auquel se rapporte les achats. Exemple de valeur : customer@dexero.com
status	Statut de la commande Exemple de valeur : cancelled, completed, pending, treated
earliest_time	Filtres des objets retournés par leur horodatage. Seuls les objets qui ont un horodatage qui est >= earliest_time seront retournés. Le format date est formatée ISO-8601 Exemple de valeur : 2011-11-25T15:58:50-05:00
latest_time	Filtres des objets retournés par leur horodatage. Seuls les objets qui ont un horodatage qui est <= latest_time seront retournés. Le format date est formatée ISO-8601 Exemple de valeur : 2011-11-25T15:58:50-05:00
min_id	Retourne les objets plus grand ou égal à min_id. Exemple de valeur : 10
max_id	Retourne les objets plus petit ou égal à max_id. Exemple de valeur : 100
include_forms	Permet d'inclure les formulaires dans la réponse.Si aucun formulaire n'est configuré au niveau du catalogue, la réponse ne contiendra aucun formulaire. La valeur par défaut est false. Exemple de valeur : true
include_tests	Permet d'inclure les commandes ayant été signalé comme test. La valeur par défaut est false. Exemple de valeur : true
custom_field_identifier	Filtres des objets retournés par la présence de l'identifiant d'un champ personnalisé. Seuls les objets qui ont l'identifiant du champ dans une valeur de produit seront retournés. Exemple de valeur : myfieldid
custom_field_value	Filtres des objets retournés par la présence de la valeur d'un champ personnalisé. Seuls les objets qui ont la valeur du champ personnalisé dans un de produit seront retournés. Exemple de valeur : 123
attribute_identifier	Filtres des objets retournés par la présence de l'identifiant d'un attribute. Seuls les objets qui ont l'identifiant de l'attribute dans une valeur de produit seront retournés. Exemple de valeur : myfieldid
attribute_value	Filtres des objets retournés par la présence de la valeur d'un attribute. Seuls les objets qui ont la valeur de l'attribut dans un de produit seront retournés. Exemple de valeur : 123

Exemple de requête

Objet de réponse "Order"

Champ	Type de donnée	Description
id	long	Le numéro d'identification unique de ce produit . L'ID est généré automatiquement et ne peut pas être changé .
customer_id	long	Le numéro d'identification unique du compte client
purchase_date	Date ISO-8601	La date d'achat
currency	string	Le code ISO à 3 lettres de la devise
customer_comment	text	Un message laissé par le client lors de la commande
customer_email	string	Le courriel du client
locale	string	Le code ISO de langue utilisé lors de la commande
subtotal_order	decimal(20,2)	Montant de sous-total de la commande
subtotal_cancelled	decimal(20,2)	Montant sous-total d'annulation
total_order	decimal(20,2)	Montant total de la commande
total_cancelled	decimal(20,2)	Le montant total de cancellation
total_products	decimal(20,2)	Montant total des produits
total_payment	decimal(20,2)	Le montant total de paiment
total_refunded	decimal(20,2)	Le montant total remboursé
total_transactions	decimal(20,2)	Le montant total des transactions
total_shipping	decimal(20,2)	Le montant total de livraison
total_left_to_pay	decimal(20,2)	Montant restant à payer
total_tax	decimal(20,2)	Montant total des taxes
total_tax_cancelled	decimal(20,2)	Montant total annulé des taxes
ip_address	string	L'adresse IP du client
is_archived	boolean	Indique si la commande a été supprimé (archivé).
status	string	Statut de la commande ex : treated
is_shippable	boolean	Détermine si la commande possède des produits qui sont livrables.
transaction_type	string	Type de transaction.
payment_method	string	Méthode de paiement
payment_provider	string	Le fournisseur de paiement
card_type	string	Le type de carte utilisé lors de la transaction
reference_number	string	Le numéro de référence de la commande
is_test	boolean	Détermine sur la commande a été signalé comme test
billing_address	objet Address	L'adresse de facturation
shipping_address	objet Address	L'adresse de livraison
order_form	List<OrderForm>	Données de formulaires
product	List<OrderProduct>	La liste des produits
customer	objet Customer	Informations sur le client

Objet de réponse "Address"

Champ	Type de donnée	Description
name	string	Le nom de la personne résidant à cette adresse
phone_number	string	Le numéro de téléphone
postal_code	string	Le code postal
company	string	Le nom de la compagnie
street_address	string	L'adresse
city	string	La ville
iso_country	string	Le code ISO du pays
iso_region	string	Le code iso de la région (Province)

Objet de réponse "OrderForm"

Champ	Type de donnée	Description
title	string	Le titre du formulaire
quantity_number	int	Le numéro de quantité
product_id	long	Le numéro d'identification unique du produit . L'ID est généré automatiquement et ne peut pas être changé .
value	List<Value>	La liste des valeurs saisies par le client

Objet de réponse "OrderProduct"

Champ	Type de donnée	Description
id	long	Le numéro d'identification unique du produit . L'ID est généré automatiquement et ne peut pas être changé .
sku	string	Code de produit / Stock Keeping Unit ( SKU )
name	string	Le nom du produit
type	enum('buy', 'refund')	Type de d'action relié au produit buy - un achat refund - un remboursement
product_price	decimal(20,2)	Le prix du produit
total_price	decimal(20,2)	Le prix total "en incluant le rabais"
price_for_quantity	decimal(20,2)	Le prix en fonction de la quantité
rebate_amount	decimal(20,2)	Le montant du rabais
tax_amount	decimal(20,2)	Le montant des taxes
quantity	int	La quantité acheté
custom_param	List<CustomParam>	La liste des valeurs de paramètres personnalisés
attribute	List<Attribute>	La liste des attributs

Objet de réponse "Value"

Champ	Type de donnée	Description
id	long	Le numéro d'identification unique de la valeur. L'ID est généré automatiquement et ne peut pas être changé .
identifier	string	L'identifiant du champ formulaire
label	string	Le label du champ formulaire
value	string	La valeur saisie par le client
fileName	string	Le nom du fichier
fileSizeBytes	string	Taille du fichier en bytes
fileContentBase64	string	Fichier en Base64 (Seulement si le fichier est moins de 10 megs)

Objet de réponse "CustomParam" de produits

Champ	Type de donnée	Description
identifier	string	L'identifiant du champ personnalisé
value	string	La valeur du champ personnalisé

Objet de réponse "Attribute"

Champ	Type de donnée	Description
identifier	string	L'identifiant de l'attribut
value	string	La valeur saisie par le client

Objet de réponse "Customer"

Champ	Type de donnée	Description
id	long	Le numéro d'identification unique du compte client . L'ID est généré automatiquement et ne peut pas être changé .
first_name	string	Le prénom
last_name	string	Le nom
email	string	Courriel de l'utilisateur
default_locale	string	Code de langue
date_created	date	Date de création du compte
custom_field	List<CustomField>	La liste des valeurs de paramètres personnalisés pour le client

Objet de réponse "CustomField" pour "Customer"

Champ	Type de donnée	Description
identifier	string	L'identifiant du champ personnalisé
value	string	La valeur du champ personnalisé

Information de pagination

Propriété	Description
totalResults	Le nombre total d'éléments dans la liste.
startIndex	Le point de départ de décalage (basé sur 0) du premier objet à retourner dans la liste. La valeur par défaut est 0.
itemsPerPage	Le nombre total d'éléments par page.
pageCount	Le nombre de pages.