Accueil > Webservices > Export des retours

Export des retours

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

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

Chaque retour ne contient qu'un seul produit.

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 : timestamp
oID Identifiant de la commande
rID Identifiant du retour
statut Statut des retours à récupérer. Si le paramètre n'est pas fourni, cela sélectionnera tous les retours.
> Voir la liste des statuts

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

Format du XML retourné


<root>
	<returns>
		<return>
			<return_id>string</return_id>
			<return_date>[DATE]</return_date>
			<return_status_name>string</return_status_name>
			<return_status>int</return_status>
			<return_reason>string</return_reason>
			<order>string</order>
			<product>
				<products_reference>string</products_reference>
				<products_name>string</products_name>
				<products_spartoo>int</products_spartoo>
				<products_manufacturers>string</products_manufacturers>
				<products_size>string</products_size>
				<products_color>string</products_color>
			</product>
			<errors>
				<error>
					<id>int</id>
					<description>string</description>
				</error>
			</errors>
		</return>
		<!-- ... Plusieurs balises "return" possibles ... -->
	</returns>
	<statut>
		<id>int</id>
		<description>string</description>
	</statut>
</root>


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 )
-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
return_id Identifiant du retour
return_date Date de création du retour
return_status_name Nom du statut courant du retour
return_status Id du statut courant du retour
return_reason Raison du retour
order Identifiant de la commande
product Produit retourné
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_manufacturers Nom de la marque
products_size Taille commandée
size_reference Référence du produit à la taille
products_color Couleur du produit


Exemples de retour XML




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

<root>
	<returns>
		<return>
			<return_id>EAJBCC</return_id>
			<return_date>	</return_date>
			<return_status_name><![CDATA[En attente de réception]]></return_status_name>
			<return_status>2</return_status>
			<return_reason><![CDATA[Problème de pointure]]></return_reason>
			<order>90D813EA1A2365A8</order>
			<product>
				<products_reference><![CDATA[ABCD]]></products_reference>
				<products_name><![CDATA[ALL STAR HI]]></products_name>
				<products_spartoo><![CDATA[123456]]></products_spartoo>
				<products_manufacturers><![CDATA[Converse]]></products_manufacturers>
				<products_size>42</products_size>
				<products_color><![CDATA[Blanc]]></products_color>
			</product>
			<errors>
				<error>
					<id>-3</id>
					<description>Il manque un paramètre obligatoire ( date ou oID/rID )</description>
				</error>
			</errors>
		</return>
	</returns>
	<statut>
		<id>3</id>
		<description>Refusé</description>
	</statut>
</root>

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

<root>
	<returns>
		<return>
			<return_id>EEAJBCC</return_id>
			<return_date>2013-04-22 17:56:36</return_date>
			<return_status_name><![CDATA[En attente de réception]]></return_status_name>
			<return_status>2</return_status>
			<return_reason><![CDATA[Problème de pointure]]></return_reason>
			<order>90D813EA1A2365A8</order>
			<product>
				<products_reference><![CDATA[ABCD]]></products_reference>
				<products_name><![CDATA[ALL STAR HI]]></products_name>
				<products_spartoo>123456</products_spartoo>
				<products_manufacturers><![CDATA[Converse]]></products_manufacturers>
				<products_size>42</products_size>
				<products_color><![CDATA[Blanc]]></products_color>
			</product>
		</return>
	</returns>
	<errors>
		<error>
			<id>1</id>
			<description>Pas d'erreur de paramètres</description>
		</error>
	</errors>
	<statut>
		<id>4</id>
		<description>Colis reçu, retour accepté</description>
	</statut>
</root>