Accueil > Webservices > Export des commandes

Export des commandes

URL du Webservice : https://sws.spartoo.com/mp/xml_export_orders.php

Ce webservice permet de récupérer les informations des commandes soit passées après une date donnée, soit via un identifiant.
Les commandes peuvent être filtrées par statut

Liste des paramètres

Paramètre	Description
partenaire	Doit contenir votre identifiant unique :
date	Date à partir de laquelle on souhaite sélectionner les commandes. Format : AAAA-MM-JJ:hh:mm:ss (exemple : 2011-11-27:03:00:00)
oID	Identifiant de la commande
statut	Statut des commandes à récupérer. Si le paramètre n'est pas fourni, cela sélectionnera toutes les commandes. > Voir la liste des statuts

Le paramètre partenaire est obligatoire et l’un des deux paramètres date ou oID est obligatoire. Le paramètre statut est facultatif.

Format du XML retourné

<root>
	<orders>
		<order>
			<orders_id>string</orders_id>
			<customers>
				<customers_firstname>string</customers_firstname>
				<customers_lastname>string</customers_lastname>
				<customers_company>string</customers_company>
				<customers_street_address>string</customers_street_address>
				<customers_suburb>string</customers_suburb>
				<customers_city>string</customers_city>
				<customers_postcode>string</customers_postcode>
				<customers_state>string</customers_state>
				<customers_country>string</customers_country>
				<customers_email_address>string</customers_email_address>
				<customers_telephone>string</customers_telephone>
			</customers>
			<delivery>
				<delivery_firstname>string</delivery_firstname>
				<delivery_lastname>string</delivery_lastname>
				<!-- ... La balise "relay_info" n'est présente que pour une commande livrée en point relais ... -->
				<relay_info>
					<relay_id>int</relay_id>
					<relay_type>string</relay_type>
					<relay_name>string</relay_name>
					<relay_address>string</relay_address>
					<relay_city>string</relay_city>
					<relay_postcode>string</relay_postcode>
					<relay_country_iso>string</relay_country_iso>
				</relay_info>
				<!-- ... Les balises "delivery_*" ci dessous ne sont présentes que pour une commande livrée hors point relais ... -->
				<delivery_company>string</delivery_companyy>
				<delivery_suburb>string</delivery_suburb>
				<delivery_street_address>string</delivery_street_address>
				<delivery_city>string</delivery_city>
				<delivery_postcode>string</delivery_postcode>
				<delivery_state>string</delivery_state>
				<delivery_country>string</delivery_country>
			</delivery>
			<payment_method>string</payment_method>
			<payment_price>float</payment_price>
			<shipping_price>float</shipping_price>
			<shipping_name>string</shipping_name>
			<order_total>float</order_total>
			<orders_status_name>string</orders_status_name>
			<orders_status_id>int</orders_status_id>
			<date_purchased>[DATE]</date_purchased>
			<last_modified>[DATE]</last_modified>
			<products>
				<product>
					<products_reference>string</products_reference>
					<products_name>string</products_name>
					<products_qty>int</products_qty>
					<products_spartoo>int</products_spartoo>
					<products_manufacturers>string</products_manufacturers>
					<products_size>string</products_size>
					<products_size_reference>string</products_size_reference>
					<products_color>string</products_color>
					<products_price_unit>float</products_price_unit>
					<products_price_unit_with_reduce>float</products_price_unit_with_reduce>
					<products_final_price>float</products_final_price>
				</product>
				<!-- ... Plusieurs balises "product" possibles ... -->
			</products>
			<errors>
				<error>
					<id>int</id>
					<description>string</description>
				</error>
			</errors>
		</order>
		<!-- ... Plusieurs balises "order" possibles ... -->
	</orders>
	<statut>
		<id>int</id>
		<description>string</description>
	</statut>
</root>

Balises optionnelles

Dans le cas d'une commande livrée en point relais ajout d'une balise relay_info et suppression des balises delivery_* à l'exception du nom et du prénom.
Si il s'agit d'une commande hors point relais suppression de la balise relay_info et affichage de toutes les balises delivery_*.

Liste des codes d'erreurs du webservice

Code	Description
1	Pas d'erreur de paramètres
-1	Le paramètre partenaire n’est pas passé en paramètre ou est vide
-2	Le paramètre partenaire n’existe pas
-3	Il manque un paramètre obligatoire ( date ou oID/rID )
-4	Format de la date invalide
-428	Votre compte a été désactivé. Vous ne pouvez plus faire d'appels aux webservices
-429	Vous avez fait trop d'appel a ce webservice pour cette heure glissante

Description des champs de la réponse XML

Balise	Description
orders_id	Identifiant de la commande
customers	Informations sur le client pour la facturation
delivery	Informations sur le client pour la livraison
customers_firstname / delivery_firstname	Prénom du client
customers_lastname / delivery_lastname	Nom du client
customers_company / delivery_company	Société du client
customers_street_address / delivery_street_address	Adresse du client
customers_suburb / delivery_suburb	Complément d'adresse du client
customers_city / delivery_city	Ville du client
customers_postcode / delivery_postcode	Code postal du client
customers_country / delivery_country	Pays du client
customers_telephone	Téléphone du client
relay_info	Informations sur le point relais
relay_id	Identifiant du point relais
relay_type	Type du point relais
relay_name	Nom du point relais
relay_address	Adresse du point relais
relay_city	Ville du point relais
relay_postcode	Code postal du point relais
relay_country	Pays du point relais
payment_method	Méthode de paiement
payment_price	Coût du paiement ( actuellement, toujours 0 )
order_total	Total de la commande
orders_status_name	Nom du statut courant de la commande
orders_status_id	Id du statut courant de la commande
date_purchased	Date de la commande
last_modified	Date de dernière modification de la commande
products	Liste des produits
products_reference	Référence du produit chez le partenaire
products_spartoo	Référence du produit chez Spartoo
products_name	Nom du modèle
products_qty	Quantitée commandé
products_manufacturers	Nom de la marque
products_size	Taille commandée
products_color	Couleur du produit
products_price_unit	Prix unitaire
products_price_unit_with_reduce	Prix avec discount
products_final_price	products_price_unit_with_reduce x products_qty

Exemples de retour XML

Exemple de réponse à un appel web service KO :

<root>
	<orders>
		<order>
			<orders_id>90D813EA1A2365A8</orders_id>
			<customers>	</customers>
			<delivery>
				<delivery_firstname><![CDATA[Robert]]></delivery_firstname>
				<delivery_lastname><![CDATA[Durand]]></delivery_lastname>
				<relay_info>
					<relay_id>1505</relay_id>
					<relay_type><![CDATA[kiala]]></relay_type>
					<relay_name><![CDATA[(NP)LE PAPYRUS]]></relay_name>
					<relay_address><![CDATA[Boulevard Gambetta]]></relay_address>
					<relay_city><![CDATA[Grenoble]]></relay_city>
					<relay_postcode><![CDATA[38000]]></relay_postcode>
					<relay_country_iso><![CDATA[FR]]></relay_country_iso>
				</relay_info>
				<delivery_company><![CDATA[Spartoo]]></delivery_company>
				<delivery_suburb><![CDATA[16 rue Henri Barbusse]]></delivery_suburb>
				<delivery_street_address><![CDATA[16 rue Henri Barbusse]]></delivery_street_address>
				<delivery_city><![CDATA[Grenoble]]></delivery_city>
				<delivery_postcode><![CDATA[38100]]></delivery_postcode>
				<delivery_state></delivery_state>
				<delivery_country><![CDATA[France]]></delivery_country>
			</delivery>
			<payment_method><![CDATA[Paiement par carte bancaire]]></payment_method>
			<payment_price>0</payment_price>
			<order_total>120.0000</order_total>
			<orders_status_name><![CDATA[Commande Vérifiée]]></orders_status_name>
			<orders_status_id>11</orders_status_id>
			<date_purchased>2013-02-12 14:00:00</date_purchased>
			<last_modified>2013-02-12 14:00:00</last_modified>
			<products>
				<product>
					<products_reference><![CDATA[ABCD]]></products_reference>
					<products_name><![CDATA[ALL STAR HI]]></products_name>
					<products_qty>2</products_qty>
					<products_spartoo>123456</products_spartoo>
					<products_manufacturers><![CDATA[Converse]]></products_manufacturers>
					<products_size>42</products_size>
					<products_size_reference><![CDATA[AAAAAA]]></products_size_reference>
					<products_color><![CDATA[Blanc]]></products_color>
					<products_price_unit>60.00</products_price_unit>
					<products_price_unit_with_reduce>200.00</products_price_unit_with_reduce>
					<products_final_price>120.00</products_final_price>
				</product>
			</products>
			<errors>
				<error>
					<id>-1</id>
					<description>Le paramètre partenaire n'est passé ou est vide</description>
				</error>
			</errors>
		</order>
	</orders>
	<statut>
		<id>41</id>
		<description>Annulation commande</description>
	</statut>
</root>

Exemple de réponse à un appel web service OK :

<root>
	<orders>
		<order>
			<orders_id>90D813EA1A2365A8</orders_id>
			<customers>
				<customers_firstname><![CDATA[Robert]]></customers_firstname>
				<customers_lastname><![CDATA[Durand]]></customers_lastname>
				<customers_company><![CDATA[Spartoo]]></customers_company>
				<customers_street_address><![CDATA[16 rue Henri Barbusse]]></customers_street_address>
				<customers_suburb><![CDATA[2eme Etage]]></customers_suburb>
				<customers_city><![CDATA[Grenoble]]></customers_city>
				<customers_postcode><![CDATA[38100]]></customers_postcode>
				<customers_state></customers_state>
				<customers_country><![CDATA[France]]></customers_country>
				<customers_telephone><![CDATA[0612345678]]></customers_telephone>
			</customers>
			<delivery>
				<delivery_firstname><![CDATA[Robert]]></delivery_firstname>
				<delivery_lastname><![CDATA[Durand]]></delivery_lastname>
				<relay_info>
					<relay_id>1505</relay_id>
					<relay_type><![CDATA[kiala]]></relay_type>
					<relay_name><![CDATA[(NP)LE PAPYRUS]]></relay_name>
					<relay_address><![CDATA[Boulevard Gambetta]]></relay_address>
					<relay_city><![CDATA[Grenoble]]></relay_city>
					<relay_postcode><![CDATA[38000]]></relay_postcode>
					<relay_country_iso><![CDATA[FR]]></relay_country_iso>
				</relay_info>
				<delivery_company><![CDATA[Spartoo]]></delivery_company>
				<delivery_suburb><![CDATA[16 rue Henri Barbusse]]></delivery_suburb>
				<delivery_street_address><![CDATA[16 rue Henri Barbusse]]> </delivery_street_address>
				<delivery_city><![CDATA[Grenoble]]></delivery_city>
				<delivery_postcode><![CDATA[38100]]></delivery_postcode>
				<delivery_state></delivery_state>
				<delivery_country><![CDATA[France]]></delivery_country>
			</delivery>
			<payment_method><![CDATA[Paiement par carte bancaire]]></payment_method>
			<payment_price>0</payment_price>
			<order_total>120.0000</order_total>
			<orders_status_name><![CDATA[Commande Vérifiée]]></orders_status_name>
			<orders_status_id>11<orders_status_id>
			<date_purchased>2013-02-12 14:00:00</date_purchased>
			<last_modified>2013-02-12 14:00:00</last_modified>
			<products>
				<product>
					<products_reference>ABCD</products_reference>
					<products_name><![CDATA[ALL STAR HI]]></products_name>
					<products_qty>2</products_qty>
					<products_spartoo>123456</products_spartoo>
					<products_manufacturers><![CDATA[Converse]]></products_manufacturers>
					<products_size>42></products_size>
					<products_size_reference><![CDATA[AAAAAA]]></products_size_reference>
					<products_color><![CDATA[Blanc]]></products_color>
					<products_price_unit>60.00</products_price_unit>
					<products_price_unit_with_reduce>200.00</products_price_unit_with_reduce>
					<products_final_price>120.00</products_final_price>
				</product>
			</products>
			<errors>
				<error>
					<id>1</id>
					<description>Pas d'erreur de paramètres</description>
				</error>
			</errors>
		</order>
	</orders>
	<statut>
		<id>11</id>
		<description>Commande vérifiée</description>
	</statut>
</root>