XLTracking

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

Table des matières :

1 / Présentation du webservice SOAP XLTracking
2 / Point de terminaison
3 / Méthode GetOrderState
4 / Méthode GetPackTracking
5 / Liste des codes statut détaillé
6 / Liste des codes statut simplifié

1/ Présentation du webservice XLTracking (SOAP)

Ce document décrit l’utilisation des points de terminaison XLTracking en détaillant le format de demande requis, les paramètres optionnels et les exemples de réponses pour assurer une récupération transparente des informations de commandes ou de numéro de tracking et une utilisation efficace du service.

Le webservice XLTracking expose deux méthodes de suivi des commandes : GetOrderState et GetPackTracking.

L’API GetOrderState permet aux utilisateurs de récupérer des évènements de commande.

L’API GetPackTracking permet aux utilisateurs de récupérer tous les évènements d’un numéro de tracking.

2/ Point de terminaison


URL de description WSDL	https://tracking.crossdesk.com/Services/XLTracking.asmx?WSDL
URL de service	https://tracking.crossdesk.com/Services/XLTracking.asmx
Type de requête	POST

3/ Méthode GetOrderState

a) Paramètres

Nom Objet	Nom Propriété	Type	Taille	Requis	Description
AuthenticationHeader	Username	VARCHAR	30	Requis	Identifiant de connexion
AuthenticationHeader	Password	VARCHAR	30	Requis	Mot de passe de connexion
GetOrderState	orderNumber	VARCHAR	20	Requis	Numéro de commande

Exemple de requête

POST /Services/XLTracking.asmx HTTP/1.1
Host: tracking.crossdesk.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://wstracking.crossdesk.com/GetOrderState"

<?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://wstracking.crossdesk.com">
      <Username>string</Username>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetOrderState xmlns="http://wstracking.crossdesk.com">
      <orderNumber>string</orderNumber>
    </GetOrderState>
  </soap:Body>
</soap:Envelope>

b) Réponse

Nom Objet	Nom Propriété	Type	Taille	Requis	Description
GetOrderStateResponse	GetOrderStateResult
GetOrderStateResult	Code	VARCHAR	3	Requis	Code statut commande détaillé
	Label	VARCHAR	70	Requis	Libellé statut commande détaillé
	SimplifyCode	VARCHAR	3	Requis	Code statut commande simplifié
	SimplifyLabel	VARCHAR	70	Requis	Libellé statut commande simplifié

Nom Objet	Nom Propriété	Type	Taille	Requis	Description
GetOrderStateResult	Packs	XLOrderStatePackEntity[]		Requis
GetOrderStateResult	Events	XLOrderStateEventEntity[]		Requis
XLOrderStatePackEntity	TrackingNumber	VARCHAR	40	Requis	Numéro de tracking colis
	Return	BOOLEEN		Requis	Flag colis retour
	ProcessCompleted	BOOLEEN		Requis	Flag colis retour livré
	TrackingUrl	VARCHAR	300	Requis	Lien de suivi colis
	Weight	DECIMAL		Requis	Poids colis

Nom Objet	Nom Propriété	Type	Taille	Requis	Description
XLOrderStateEventEntity	CreatedDate	DATETIME		Requis	Date création statut
	Code	VARCHAR	3	Requis	Code statut commande détaillé
	Label	VARCHAR	70	Requis	Libellé statut commande détaillé
	SimplifyCode	VARCHAR	3	Requis	Code statut commande simplifié
	SimplifyLabel	VARCHAR	70	Requis	Libellé statut commande simplifié

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>
    <GetOrderStateResponse xmlns="http://wstracking.crossdesk.com">
      <GetOrderStateResult>
        <Code>string</Code>
        <Label>string</Label>
        <SimplifyCode>string</SimplifyCode>
        <SimplifyLabel>string</SimplifyLabel>
        <Packs>
          <XLOrderStatePackEntity>
            <TrackingNumber>string</TrackingNumber>
            <Return>boolean</Return>
            <ProcessCompleted>boolean</ProcessCompleted>
            <TrackingUrl>string</TrackingUrl>
            <Weight>decimal</Weight>
          </XLOrderStatePackEntity>
          <XLOrderStatePackEntity>
            <TrackingNumber>string</TrackingNumber>
            <Return>boolean</Return>
            <ProcessCompleted>boolean</ProcessCompleted>
            <TrackingUrl>string</TrackingUrl>
            <Weight>decimal</Weight>
          </XLOrderStatePackEntity>
        </Packs>
        <Events>
          <XLOrderStateEventEntity>
            <CreatedDate>dateTime</CreatedDate>
            <Code>string</Code>
            <Label>string</Label>
            <SimplifyCode>string</SimplifyCode>
            <SimplifyLabel>string</SimplifyLabel>
          </XLOrderStateEventEntity>
          <XLOrderStateEventEntity>
            <CreatedDate>dateTime</CreatedDate>
            <Code>string</Code>
            <Label>string</Label>
            <SimplifyCode>string</SimplifyCode>
            <SimplifyLabel>string</SimplifyLabel>
          </XLOrderStateEventEntity>
        </Events>
      </GetOrderStateResult>
    </GetOrderStateResponse>
  </soap:Body>
</soap:Envelope>

4/ Méthode GetPackTracking

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)

Exemple de requête

POST /Services/XLTracking.asmx HTTP/1.1
Host: tracking.crossdesk.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://wstracking.crossdesk.com/GetPackTracking"

<?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://wstracking.crossdesk.com">
      <Username>string</Username>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetPackTracking xmlns="http://wstracking.crossdesk.com">
      <trackingNumber>string</trackingNumber>
    </GetPackTracking>
  </soap:Body>
</soap:Envelope>

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 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>
    <GetPackTrackingResponse xmlns="http://wstracking.crossdesk.com">
      <GetPackTrackingResult>
        <TrackingNumber>string</TrackingNumber>
        <Return>boolean</Return>
        <ProcessCompleted>boolean</ProcessCompleted>
        <TrackingUrl>string</TrackingUrl>
        <Weight>decimal</Weight>
        <PackEvents>
          <PackTrackingEvent>
            <EventDate>dateTime</EventDate>
            <Code>string</Code>
            <Label>string</Label>
          </PackTrackingEvent>
          <PackTrackingEvent>
            <EventDate>dateTime</EventDate>
            <Code>string</Code>
            <Label>string</Label>
          </PackTrackingEvent>
        </PackEvents>
      </GetPackTrackingResult>
    </GetPackTrackingResponse>
  </soap:Body>
</soap:Envelope>

5/ Liste des codes statut détaillé

Code	Etat Correspondant	Code	Etat Correspondant
10	Incomplète	29	Contacté et rendez-vous pris
116	Complète	929	Contacté et rendez-vous pris - partiel
101	En préparation	289	Livraison planifiée
102	Colisée	290	Commande en Livraison - partiel
904	Expédiée - partiel	97	Livraison en cours
18	En acheminement vers l'aéroport	96	Livraison en cours - partiel
19	En transit aérien	291	Commande en Livraison
24	En acheminement vers le hub d'expédition	36	N'habite pas à l'adresse indiquée
25	Arrivé au hub d'expédition	31	Non livré client absent
124	Colis Déclaré	925	Non livré client absent - partiel
908	Colis Déclaré - partiel	932	N'habite pas à l'adresse indiquée - partiel
12	Expédiée	61	Non livre client absent (2eme Tentative)
122	Informations de livraison transmises	990	Non livre client absent (2eme Tentative) - partiel
906	Informations de livraison transmises - partiel	62	Non livre client absent (3eme Tentative)
121	En acheminement vers plateforme de tri	991	Non livre client absent (3eme Tentative) - partiel
905	En acheminement vers plateforme de tri - partiel	32	Problème d'adresse
915	Pris en charge plateforme de Livraison - partiel	33	Non livré refus client
14	Arrivée en plateforme de tri	98	Livré - partiel
214	Arrivée en plateforme de tri - partiel	70	Ordre de retour
145	En acheminement vers plateforme de livraison	701	Colis en retour
141	En acheminement vers plateforme de livraison - partiel	946	Ordre de retour - partiel
15	Pris en charge plateforme de Livraison	948	Colis en retour - partiel
20	Message répondeur	72	Retourné à la plateforme de livraison
917	Message répondeur - partiel	950	Retourné à la plateforme de livraison - partiel
305	Non livré en attente d'instruction	71	Retourné au HUB
924	Non livré en attente d'instruction - partiel	949	Retourné au HUB - partiel
926	Non livré refus client - partiel	75	Retourné au stock - partiel

Code	Etat Correspondant	Code	Etat Correspondant
73	Retourné au stock	419	Changement de point relais - partiel
79	Retourné à l'expéditeur	35	En instance en point de retrait
953	Retourné à l'expéditeur - partiel	928	En instance en point de retrait - partiel
48	Contact destinataire en cours - partiel	935	Colis réexpédié - partiel
43	Contact destinataire en cours	39	Colis réexpédié
922	Problème de livraison - partiel	37	Colis en attente de distribution
987	Contenu du colis interdit - partiel	38	Colis réacheminé vers le destinataire
988	Colis en avarie - partiel	933	Colis en attente de distribution - partiel
46	Non Livré point de retrait fermé - partiel	934	Colis réacheminé vers le destinataire - partiel
51	Livraison reprogrammée - partiel	400	Entrée en douane
53	Non livré Attente de paiement - partiel	401	Sortie de douane
57	Problème Douane droits/taxes à régler - partiel	402	Problème douane document manquant
59	Problème d enlèvement - partiel	403	Problème douane
30	Problème de livraison	404	Identification marchandise par la douane
984	Contenu du colis interdit	405	En instance de dédouanement
985	Colis en avarie	34	Non livré problème d'accès
42	Non Livré point de retrait fermé	143	Rendez-vous planifié
52	Livraison reprogrammée	914	Rendez-vous planifié - partiel
54	Non livré Attente de paiement	927	Non livré problème d'accès - partiel
58	Problème Douane droits/taxes à régler	937	Entrée en douane - partiel
60	Problème d enlèvement	938	Sortie de douane - partiel
47	Durée limite en point de retrait atteinte - partiel	939	Problème douane document manquant - partiel
501	Problème d'adresse - partiel	940	Problème douane - partiel
44	Durée limite en point de retrait atteinte	941	Identification marchandise par la douane - partiel
931	Non Livré point de retrait fermé - partiel	942	En instance de dédouanement - partiel
920	Avis de passage - partiel	803	Retard de livraison
920	Avis de passage - partiel	803	Retard de livraison
41	Changement de point relais	80	Litige ouvert

Code	Etat correspondant	Code	Etat correspondant
954	Litige ouvert - partiel	56	Non livré Colis réacheminé vers point de retrait
805	Non livraison injustifiée	983	Livré avec paiement
806	Colis ouvert produit manquant	989	Livré à un tiers - partiel
807	Produit cassé	45	Colis retiré en point de retrait - partiel
957	Retard de livraison - partiel	95	Annulé
959	Non livraison injustifiée - partiel	99	Livré
960	Colis ouvert produit manquant - partiel	0	Inconnu
961	Produit cassé - partiel	142	En acheminement vers région
83	Colis perdu	913	En acheminement vers région - partiel
90	Litige clos	969	Colis perdu - partiel
82	Colis détérioré	982	Annulé - partiel
84	Prise en charge acceptée	986	Livré à un tiers
293	Avis de passage	975	Retour à l'expediteur livré
968	Colis détérioré - partiel	40	Colis retiré en point de retrait
971	Prise en charge accéptée - partiel	703	Un ou plusieurs articles sont en cours de retour partiel
978	Litige clos - partiel	702	Un ou plusieurs articles sont en cours de retour
49	Durée limite en point de retrait presque atteint - partiel	704	Retour livré
55	Non livré Colis réacheminé vers point de retrait - partiel	705	Retour livré partiel
50	Durée limite en point de retrait presque atteint	706	Suspicion de fraude

6/ Liste des codes statut simplifié

Code	Etat correspondant	Code	Etat correspondant
1	Expédié	5	Mise en instance
2	En transit	6	Livré
3	En cours de livraison	7	Retour
4	Problème livraison