XLFlowTools

Guide de référence et d’utilisation (version 1.3)

Dernière mise à jour le 20 janvier 2025

Table des matières :

1 / Présentation du webservice SOAP XLFlowTools 2 / Point de terminaison 3 / Méthode GetSpecificParcelReturn 4 / Méthode GetSpecificParcelsReturn

1/ Présentation du webservice XLFlowTools (SOAP)

Le webservice XLFlowTools expose deux méthodes de génération d’étiquettes Retour : GetSpecificParcelReturn et GetSpecificParcelsReturn.

L’API GetSpecificParcelReturn permet aux utilisateurs de générer une étiquette Retour pour un numéro de commande.

L’API GetSpecificParcelsReturn permet aux utilisateurs de générer plusieurs étiquettes Retour pour un numéro de commande multi-colis ou de générer une étiquette Retour pour une commande ayant déjà fait l’objet d’un retour.

Ce document décrit l’utilisation du point de terminaison GetSpecificParcelReturn, en détaillant le format de demande requis, les paramètres optionnels et les exemples de réponses pour assurer une génération transparente d’étiquettes et une utilisation efficace du service.XLFlowTools

2/ Point de terminaison


URL de description WSDL	https://mobile.crossdesk.com/Services/XLFlowTools.asmx?WSDL
URL de service	https://mobile.crossdesk.com/Services/XLFlowTools.asmx
Request Type de requête	POST

3/ Méthode GetSpecificParcelReturn

a) Paramètres

Nom Objet	Nom Propriété	Type	Taille	Requis	Description
GetSpecificParcelReturn
	orderNumber	VARCHAR	20	Requis	Numéro de la commande
	carrierServiceCode	VARCHAR	3	Optionnel	Code service transporteur
	parcelFormat	VARCHAR	3	Requis	Format de l’étiquette (ZPL ou PDF)

b) Réponse

Nom Objet	Nom Propriété	Type	Taille	Requis	Description
GetSpecificParcelReturnResponse	GetSpecificParcelReturnResult	XLFlowPackReturnEntity
XLFlowPackReturnEntity	PackNumber	VARCHAR	30	Requis	Numéro de colis
	TrackingNumber	VARCHAR	40	Requis	Numéro de tracking
	ParcelContent	Base64		Requis	Code binaire de l’étiquette

Exemple de demande

<soap:Envelope xmlns:soap=”http://www.w3.org/2003/05/soap-envelope” xmlns:mob=”http://mobile.crossdesk.com/”> <soap:Header> <mob:AuthenticationHeader> <mob:Username>user</mob:Username> <mob:Password>pwd</mob:Password> </mob:AuthenticationHeader> </soap:Header> <soap:Body> <mob:GetSpecificParcelsReturn> <mob:orderNumber>2ShopFRTest0708</mob:orderNumber> <mob:parcelFormat>PDF</mob:parcelFormat> </mob:GetSpecificParcelsReturn> </soap:Body> </soap:Envelope>

Exemple de réponse

HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length

<?xml version=”1.0″ encoding=”utf-8″?> <soap:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:soap=”http://schemas.xmlsoap.org/soap/envelope/”> <soap:Body> <GetSpecificParcelReturnResponse xmlns=”http://mobile.crossdesk.com/”> <GetSpecificParcelReturnResult> <PackNumber>string</PackNumber> <TrackingNumber>string</TrackingNumber> <ParcelContent>base64Binary</ParcelContent> </GetSpecificParcelReturnResult> </GetSpecificParcelReturnResponse> </soap:Body> </soap:Envelope>

4/ Méthode GetSpecificParcelsReturn

a) Paramètres

Nom Objet	Nom Propriété	Type	Taille	Requis	Description
GetSpecificParcelsReturn
	orderNumber	VARCHAR	20	Requis	Numéro de la commande
	carrierCode	VARCHAR	3	Optionnel	Code transporteur
	carrierServiceCode	VARCHAR	3	Optionnel	Code service transporteur
	parcelFormat	VARCHAR	Content	Requis	Format de l’étiquette (ZPL ou PDF)

b) Réponse

Nom Objet	Nom Propriété	Type	Taille	Requis	Description
GetSpecificParcelsReturnResponse	GetSpecificParcelsReturnResult
GetSpecificParcelsReturnResult	PackageInformation1	VARCHAR	20	Optionnel	Information complémentaire 1
	PackageInformation2	VARCHAR	20	Optionnel	Information complémentaire 2
	PackNumber	VARCHAR	30	Requis	Numéro de colis interne
	TrackingNumber	VARCHAR	40	Requis	Numéro de tracking
	TrackingUrl	VARCHAR	300	Optionnel	URL de tracking
	CarrierCode	VARCHAR	3	Optionnel	Code transporteur
	ParcelContent	Base64		Requis	Code binaire de l’étiquette
	Documents	DocumentContent[]		Optionnel
Documents	DocumentContent
DocumentContent	DocumentId	VARCHAR	36	Requis	GUID
	Content	Base64		Requis
	DocumentType	VARCHAR	50	Requis	Ex : Certificat matières dangereuses

Exemple de demande

POST /Services/XLFlowTools.asmx HTTP/1.1
Host: mobile.crossdesk.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://mobile.crossdesk.com/GetSpecificParcelsReturn"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="http://mobile.crossdesk.com/">
      <Username>string</Username>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetSpecificParcelsReturn xmlns="http://mobile.crossdesk.com/">
      <orderNumber>string</orderNumber>
      <carrierCode>string</carrierCode>
      <carrierServiceCode>string</carrierServiceCode>
      <parcelFormat>string</parcelFormat>
    </GetSpecificParcelsReturn>
  </soap:Body>
</soap:Envelope>

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSpecificParcelsReturnResponse xmlns="http://mobile.crossdesk.com/">
      <GetSpecificParcelsReturnResult>
        <PackageInformation1>string</PackageInformation1>
        <PackageInformation2>string</PackageInformation2>
        <PackNumber>string</PackNumber>
        <TrackingNumber>string</TrackingNumber>
        <TrackingUrl>string</TrackingUrl>
        <CarrierCode>string</CarrierCode>
        <ParcelContent>base64Binary</ParcelContent>
        <Documents>
          <DocumentContent>
            <DocumentId>guid</DocumentId>
            <Content>base64Binary</Content>
            <DocumentType>string</DocumentType>
          </DocumentContent>
          <DocumentContent>
            <DocumentId>guid</DocumentId>
            <Content>base64Binary</Content>
            <DocumentType>string</DocumentType>
          </DocumentContent>
        </Documents>
      </GetSpecificParcelsReturnResult>
    </GetSpecificParcelsReturnResponse>
  </soap:Body>
</soap:Envelope>