Atualização de uma devolução

URL do Webservice : https://sws.spartoo.pt/mp/xml_maj_returns.php

Este webservice serve para atualizar uma devolução.

Se precisa enviar uma guia de devolução ao cliente, existem 2 possibilidades:
  • A guia está hospedada no seu sistema: indique label_link com o link para a guia
  • Deseja que a guia fique hospedada em nosso servidor: indique label_file com o ficheiro da guia
Uma vez a devolução enviada, indique statut para
  • ou aceitar a devolução (estatuto 4)
  • ou recusar a devolução (estatuto 3)


> Ver a lista dos estatutos das devoluções

Lista dos parâmetros

Os parâmetros deste webservice devem passar obrigatoriamente em POST

Parâmetro Descrição
partenaire Deve conter a sua identificação:
rID Identificação da devolução a atualizar
statut (opcional) Novo estatuto da devolução ( 3 ou 4 )
label_link (opcional) Link para a guia de devolução
label_file (opcional) Ficheiro da guia de devolução


Formato do XML devolvido


<root>
	<returns>
		<return>
			<partenaire>string</partenaire>
			<rID>int</rID>
			<label_link>url</label_link>
			<label_file>url</label_file>
			<errors>
				<error>
					<id>int</id>
					<description>string</description>
				</error>
			</errors>
		<return>
	</returns>
	<statut>
		<id>int</id>
		<description>string</description>
	</statut>
</root>


Lista dos códigos de erros do webservice


Código Descrição
1 Sem erros nos parâmetros
-1 O parâmetro partenaire não passou no parâmetro ou está vazio
-2 O parâmetro do parceiro não existe
-5 Falta o parâmetro rID ou o parâmetro statut
-6 A devolução não foi encontrada, verifique o parâmetro rID ou o parâmetro do parceiro.
-7 Problema na cronologia da devolução
  • O estatuto 4 só se aplica se a devolução estiver em estatuto 2 ou 3
  • O estatuto 3 só se aplica se a devolução estiver em estatuto 2
-9 O novo estatuto é idêntico ao estatuto atual
-22 Erro ao receber o ficheiro
-23 Erro desconhecido durante a receção do ficheiro
-24 O link da etiqueta é muito comprido
-25 O link fornecido é idêntico ao link atual
-428 A sua conta foi desativada. Não pode mais efetuar chamadas ao webservice
-429 Efetuou demasiado chamadas para o Webservice nesta hora corrida

Exemplos de devolução XML


Exemplo de resposta a uma chamada web serviço KO :

<root>
	<returns>
		<return>
			<partenaire>1EC51BF31B486658</partenaire>
			<rID>	</rID>
			<label_link>http://www.spartoo.fr/pj.php?file_id_crypt=...</label_link>
			<errors>
				<error>
					<id>-6</id>
					<description>
						La commande ou le retour n’ont pas été trouvés, vérifiez le paramètre oID / rID ou le paramètre partenaire.
					</description>
				</error>
			</errors>
		</return>
	</returns>
	<statut>
		<id>6</id>
		<description>retour refusé</description>
	</statut>
</root>

Exemplo de resposta a uma chamada web serviço OK :

<root>
	<returns>
		<return>
			<partenaire>1EC51BF31B486658</partenaire>
			<rID>8883777</rID>
			<label_link>http://www.spartoo.fr/pj.php?file_id_crypt=...</label_link>
			<errors>
				<error>
					<id>1</id>
					<description>Pas d'erreur de paramètres</description>
				</error>
			</errors>
		</return>
	</returns>
	<statut>
		<id>4</id>
		<description>retour accepté</description>
	</statut>
</root>

💡 Conseils d'intégration pour les étiquettes de retour

  • label_link : L'URL fournie pour l'étiquette de retour ne doit pas dépasser 255 caractères (limite stricte de l'API). Si vous utilisez des paramètres d'URL ou d'authentification longs, veuillez raccourcir le lien au préalable.
  • label_file : Si vous soumettez directement le fichier de l'étiquette, vous devez transmettre le contenu binaire brut (raw binary content) du fichier (et non une chaîne encodée en Base64). Les formats acceptés sont le PDF (.pdf) et les formats d'images (.jpg, .jpeg, .png, .gif) pour une taille maximale de 10 Mo.



Saitoo - Assistant (mp)
Bonjour ! Comment puis-je vous aider aujourd'hui ?