Webservices EasyColis et EasyColisAdvanced
Guide de référence et d’utilisation (version 3.4)
Table des matières :
A / Présentation des webservices EasyColis et EasyColisAdvanced
B / Liste des erreurs possibles lors de l’identification sur les webservices
C / Méthodes disponibles sur le webservice EasyColis
1) ImportCustomerOrder
2) CancelCustomerOrder
3) CreatePacks
4) GetPacks
5) GetParcelReturn
6) GetParcelReturnUrl
7) CancelPacks
8) CreateManifest
9) CreatePartialManifest
10) GetManifest
D / Méthodes disponibles sur le webservice EasyColisAdvanced
1) GetParcelReturn
2) GetParcelReturnUrl
3) / CreateTruck
4) DeclareTruck
5) GetOrderDocument
A/ Présentation des webservices EasyColis et EasyColisAdvanced
La société Crosslog a développé deux webservices EasyColis et EasyColisAdvanced à l’intention de de ses clients afin qu’ils puissent réaliser les actions relatives à leur activité transport.
Ils permettent :
– La création et l’annulation de commandes client
– Le colisage de commandes
– La déclaration et l’annulation de colis
– La création et récupération du bordereau de remise
– La création de colis retour associés aux commandes expédiées
Ces webservices sont basés sur le protocole d’échange d’information SOAP (Simple Object Access Protocol). Les trames d’échange de données sont donc organisées selon les normes du langage XML. Leur utilisation est possible à l’aide de tout langage informatique pouvant gérer cette technologie.
Les webservices EasyColis et EasyColisAdvanced, sont présentées dans ce document de façon détaillée.
Pour chaque fonctionnalité, la liste des champs à remplir lors de l’appel ainsi que la réponse sont fournis.
EasyColis :
URL : http://mobile.crossdesk.com/Services/EasyColis.asmx?WSDL
Le webservice EasyColis donne accès aux fonctionnalités de base de l’offre EasyColis.
EasyColisAdvanced :
URL : http://mobile.crossdesk.com/Services/EasyColisAdvanced.asmx?WSDL
Le webservice EasyColisAdvanced donne accès aux fonctionnalités avancées de l’offre EasyColis.
B/ Liste des erreurs possibles lors de l’identification sur les webservices
Lors de chaque appel à une méthode d’un des webservices, le client doit s’identifier avec le login et password qui lui ont été fournis par Crosslog.
En cas d’erreur d’authentification, si le login et le password utilisés sont corrects, le problème peut être dû aux raisons suivantes :
– Utilisateur désactivé.
– L’utilisateur ne dispose pas des droits nécessaires pour se connecter à l’application.
– Aucun entrepôt n’est associé à l’utilisateur.
– L’adresse IP de l’utilisateur n’est pas autorisée sur le pare-feu du serveur
Il est alors nécessaire de contacter le service client de Crosslog afin de résoudre le problème.
C/ Méthodes disponibles sur le webservice EasyColis
– ImportCustomerOrder()
– CancelCustomerOrder()
– CreatePacks()
– GetPacks()
– GetParcelReturn()
– GetParcelReturnUrl()
– CancelPacks()
– CreateManifest()
– CreatePartialManifest()
– GetManifest()
1) ImportCustomerOrder()
Description
Cette méthode permet de transmettre une commande client à Crosslog, l’intégration de la commande n’est possible que si toutes les données obligatoires sont renseignées au moment de l’appel.
Avant l’intégration de la commande des contrôles sont effectués tels que la validité du code postal du destinataire et la cohérence du transporteur choisi selon le plan de transport du client.
En cas d’erreur d’intégration de la commande, une exception est générée par le webservice et doit être gérée par l’application du client.
L’erreur doit être corrigée avant de transmettre à nouveau la commande.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
customerOrder |
OrderNumber |
VARCHAR |
20 |
O |
Numéro de la commande |
|
BrandCode |
VARCHAR |
9 |
N |
Code de l'enseigne |
|
|
OrderNumberMother |
VARCHAR |
20 |
N |
Numéro de la commande mère |
|
|
CarrierCode |
VARCHAR |
50 |
O |
Code de service transporteur utilisé |
|
|
CarrierOptionCode |
VARCHAR |
2 |
N |
Code option transporteur |
|
|
Description |
VARCHAR |
40 |
N |
Description marchandise |
|
|
OrderDate |
DATETIME |
|
N |
Date de la commande |
|
|
Recipient |
RecipientEntity |
|
O |
Adresse de livraison |
|
|
Sender |
SenderEntity |
|
N |
Adresse de l’expéditeur |
|
|
BillingAttributes |
BillingAttributesEntity |
|
N |
Information de facturation |
|
|
CustomerOrderRetails |
CustomerOrderRetailEntity[] |
|
O |
Information produit |
|
|
Parameters |
CustomerOrderParameterEntity[] |
|
N |
Paramètres commande |
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
RecipientEntity |
CustomerNumber |
VARCHAR |
20 |
N |
Numéro du client |
|
CompagnyName |
VARCHAR |
50 |
N |
Adresse de livraison : nom de la société |
|
|
LastName |
VARCHAR |
50 |
O si CorporateName vide |
Adresse de livraison : nom du client |
|
|
FirstName |
VARCHAR |
35 |
N |
Adresse de livraison : prénom du client |
|
|
Address1 |
VARCHAR |
40 |
O |
Adresse de livraison : adresse |
|
|
Address2 |
VARCHAR |
40 |
N |
Adresse de livraison : complément d’adresse |
|
|
Address3 |
VARCHAR |
40 |
N |
Adresse de livraison : suite de complément d’adresse |
|
|
ZipCode |
VARCHAR |
20 |
O |
Adresse de livraison : code postal |
|
|
City |
VARCHAR |
35 |
O |
Adresse de livraison : ville |
|
|
Province |
VARCHAR |
40 |
O si Country est US ou CA |
Adresse de livraison : province |
|
|
Country |
VARCHAR |
30 |
O |
Adresse de livraison : code pays iso |
|
|
Observation |
VARCHAR |
255 |
N |
Adresse de livraison : commentaires |
|
|
Phone1 |
VARCHAR |
50 |
N |
Adresse de livraison : numéro de téléphone |
|
|
MobilePhone |
VARCHAR |
50 |
N |
Adresse de livraison : numéro de mobile |
|
|
Email |
VARCHAR |
80 |
N |
Adresse de livraison : email |
|
|
PickupPointNumber |
VARCHAR |
10 |
N |
Adresse de livraison : code de point-relais |
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
SenderEntity |
CompagnyName |
VARCHAR |
35 |
N |
Adresse de l’expéditeur : nom de la société |
|
LastName |
VARCHAR |
30 |
N |
Adresse de l’expéditeur : nom |
|
|
FirstName |
VARCHAR |
30 |
N |
Adresse de l’expéditeur : prénom |
|
|
Address1 |
VARCHAR |
150 |
N |
Adresse de l’expéditeur : adresse |
|
|
Address2 |
VARCHAR |
35 |
N |
Adresse de l’expéditeur : complément d'adresse |
|
|
Address3 |
VARCHAR |
35 |
N |
Adresse de l’expéditeur : suite de complément d'adresse |
|
|
ZipCode |
VARCHAR |
15 |
N |
Adresse de l’expéditeur : code postal |
|
|
City |
VARCHAR |
35 |
N |
Adresse de l’expéditeur : ville |
|
|
Province |
VARCHAR |
2 |
N |
Adresse de l’expéditeur : province |
|
|
Country |
VARCHAR |
35 |
N |
Adresse de l’expéditeur : nom pays |
|
|
PhoneNumber |
VARCHAR |
20 |
N |
Adresse de l’expéditeur : numéro de téléphone |
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
BillingAttributesEntity |
CashOnDeliveryAmount |
DECIMAL |
|
N |
Montant de contre-remboursement |
|
DeliveredDutyPaid |
VARCHAR |
3 |
N |
Incoterm |
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
CustomerOrderRetailEntity |
ProductCode |
VARCHAR |
20 |
N |
Référence de produit |
|
ProductName |
VARCHAR |
120 |
O si ProductCode est renseigné |
Libellée de produit |
|
|
ProductQuantity |
INTEGER |
|
O si ProductCode est renseigné |
Quantité commandé |
|
|
ProductCustomsNomenclature |
VARCHAR |
17 |
N |
Code nomenclature douanière |
|
|
ProductUnitPriceHT |
DECIMAL |
|
N |
Prix unitaire HT |
|
|
ProductWeight |
DECIMAL |
|
N |
Poids produit |
|
|
ProductNature |
VARCHAR |
1 |
N |
Code nature |
|
|
ProductOriginCountry |
VARCHAR |
2 |
N |
Code pays origine produit |
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
CustomerOrderParameterEntity |
Code |
VARCHAR |
20 |
O |
Nom du paramètre |
|
Value |
VARCHAR |
200 |
O |
Valeur du paramètre |
Réponse du webservice
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<ImportCustomerOrderResponse xmlns=”http://mobile.crossdesk.com/” />
</soap12:Body>
</soap12:Envelope>
Erreurs possibles
| MESSAGE | Commentaire |
|---|---|
|
Numéro de commande déjà existant, la création est impossible |
|
|
Une anomalie a été détectée dans le numéro de commande : ... Les espaces en début et fin de chaine
sont interdits |
|
|
Une anomalie a été détectée dans le numéro de commande : ….. Les caractères spéciaux sont interdits |
Les n° de commande ne peuvent contenir que des caractères alphanumérique
ainsi que les caractères « \ » et « / » « _ » et « - » |
|
La valeur du champ .... dépasse le nombre de caractères autorisés |
Se reporter à nos spécifications pour déterminer la taille limite du champ |
|
Le montant pour les expéditions à l'international hors UE est obligatoire pour la déclaration douanière
CN23 |
Pour les expéditions hors Europe il faut nous nous transmettre le prix unitaire de
chaque produit de la commande |
|
La société ou le nom sont obligatoire |
|
|
Une anomalie a été détecté dans l'adresse : ....... Les caractères spéciaux sont interdits |
Pour les adresses seuls les caractères « ? », « ; », « @ » , « » ne sont
pas autorisés |
|
Le point relais pour ce transporteur est obligatoire |
|
|
L'adresse email est incorrecte |
|
|
Le code pays est incorrect ou absent |
|
|
Le format du code postal est incorrect pour le pays de destination |
|
|
Le choix du transporteur est obligatoire |
|
|
Une anomalie a été détectée dans l'adresse : ....... Les caractères spéciaux sont interdits |
Les caractères « ? », « ; », « @ » , « » ne sont pas autorisés dans les
adresses |
|
La ville est obligatoire |
|
|
Le numéro de téléphone n'est pas valide |
Seuls les chiffres, le « + » et les espaces sont acceptés |
|
Votre plan transport ne permet pas la création de commande pour le code transporteur : …, code pays
: …, code postal : …, montant total : … |
Les critères de la commande ne permettent pas de déterminer un mode de
transport ou bien le service demandé n’est pas configuré dans le plan de transport |
2) CancelCustomerOrder()
Description
La méthode permet d’annuler une commande client.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
CancelCustomerOrder |
orderNumber |
VARCHAR |
20 |
O |
Numéro de la commande |
Réponse du webservice
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>
<CancelCustomerOrderResponse xmlns=”http://mobile.crossdesk.com/” />
</soap:Body>
</soap:Envelope>
3) CreatePacks()
Description
La méthode permet de créer les colis et les étiquettes transport d’une commande.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
CreatePacks |
orderNumber |
VARCHAR |
20 |
O |
Numéro de la commande |
|
xlFlowPackEntities |
XLFlowPackEntity[] |
|
O |
Informations du colis |
|
|
parcelFormat |
VARCHAR |
3 |
O |
Format de l’étiquette colis (ZPL,PDF, DMX ou EPL) |
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
XLFlowPackEntity |
Weight |
DECIMAL |
|
O |
Poids du colis |
|
InsuranceAmount |
DECIMAL |
|
N |
Montant de l’assurance |
|
|
Retails |
PackRetailEntity[] |
|
O |
Contenu du colis |
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
PackRetailEntity |
ProductCode |
VARCHAR |
20 |
O |
Code produit |
|
ProductQuantity |
INTEGER |
|
O |
Quantité |
|
|
ProductCustomsNomenclature |
VARCHAR |
17 |
N |
Code douane |
|
|
ProductOriginCountry |
VARCHAR |
2 |
N |
Code pays d’origine |
Réponse du webservice
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<CreatePacksResponse xmlns=”http://mobile.crossdesk.com/”>
<CreatePacksResult>
<XLFlowPackReturnEntity>
<PackNumber>string</PackNumber>
<TrackingNumber>string</TrackingNumber>
<CarrierCode>string</CarrierCode>
<ParcelContent>base64Binary</ParcelContent>
</XLFlowPackReturnEntity>
<XLFlowPackReturnEntity>
<PackNumber>string</PackNumber>
<TrackingNumber>string</TrackingNumber>
<CarrierCode>string</CarrierCode>
<ParcelContent>base64Binary</ParcelContent>
</XLFlowPackReturnEntity>
</CreatePacksResult>
</CreatePacksResponse>
</soap12:Body>
</soap12:Envelope>
Le webservice fournit dans sa réponse les étiquettes correspondant aux colis créés sous forme d’entités XLFlowPackReturnEntity. Les étiquettes sont au format demandé (ZPL, DPL, EPL, ou PDF) et sont codées en base 64. Elles sont transmises dans le champ ParcelContent de chaque entité.
4) GetPacks()
Description
La méthode permet de récupérer les informations des colis d’une commande.
Liste des champs à saisir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
GetPacks |
orderNumber |
VARCHAR |
20 |
O |
Numéro de la commande |
Réponse du webservice
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<GetPacksResponse xmlns=”http://mobile.crossdesk.com/”>
<GetPacksResult>
<XLFlowPackReturnEntity>
<PackNumber>string</PackNumber>
<TrackingNumber>string</TrackingNumber>
<CarrierCode>string</CarrierCode>
<ParcelContent>base64Binary</ParcelContent>
</XLFlowPackReturnEntity>
<XLFlowPackReturnEntity>
<PackNumber>string</PackNumber>
<TrackingNumber>string</TrackingNumber>
<CarrierCode>string</CarrierCode>
<ParcelContent>base64Binary</ParcelContent>
</XLFlowPackReturnEntity>
</GetPacksResult>
</GetPacksResponse>
</soap12:Body>
</soap12:Envelope>
La réponse du webservice fournit un tableau d’entités XLFlowPackReturnEntity qui contiennent les données des colis de la commande.
Les étiquettes sont au format demandé (ZPL, DPL, EPL, ou PDF) et sont codées en base 64. Elles sont contenues dans le champ ParcelContent de chaque entité.
Erreurs possibles
5) GetParcelReturn()
Description
La méthode permet de créer le colis et l’étiquette transport retour d’une commande.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
GetParcelReturn |
orderNumber |
VARCHAR |
20 |
O |
Numéro de la commande |
|
GetParcelReturn |
parcelFormat |
VARCHAR |
3 |
O |
Format de l’étiquette (ZPL, EPL, DMX, PDF) |
Réponse du webservice
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<GetParcelReturnResponse xmlns=”http://mobile.crossdesk.com/”>
<GetParcelReturnResult>
<PackNumber>string</PackNumber>
<TrackingNumber>string</TrackingNumber>
<CarrierCode>string</CarrierCode>
<ParcelContent>base64Binary</ParcelContent>
</GetParcelReturnResult>
</GetParcelReturnResponse>
</soap12:Body>
</soap12:Envelope>
Le webservice fournit l’étiquette du colis retour dans le champ ParcelContent de sa réponse.
L’étiquette est au format spécifié lors de l’appel de la méthode (ZPL, DMX, EPL, ou PDF) et est codée en base 64.
6) GetParcelReturnURL()
Description
La méthode permet de créer le colis et l’étiquette transport retour d’une commande.
On récupère l’url de téléchargement de l’étiquette.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
GetParcelReturnUrl |
orderNumber |
VARCHAR |
20 |
O |
Numéro de la commande |
Réponse du webservice
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<GetParcelReturnUrlResponse xmlns=”http://mobile.crossdesk.com/”>
<GetParcelReturnUrlResult>string</GetParcelReturnUrlResult>
</GetParcelReturnUrlResponse>
</soap12:Body>
</soap12:Envelope>
L’URL permettant de télécharger l’étiquette retour est fournie sous la forme d’une chaine de caractères dans le champ GetParcelReturnUrlResult .
7) CancelPacks()
Description
La méthode permet d’annuler tous les colis d’une commande.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
CancelPacks |
orderNumber |
VARCHAR |
20 |
O |
Numéro de la commande |
Réponse du webservice
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<CancelPacksResponse xmlns=”http://mobile.crossdesk.com/” />
</soap12:Body>
</soap12:Envelope>
8) CreateManifest()
Description
La méthode permet d’expédier informatiquement tous les colis d’un transporteur.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
CreateManifest |
CollectCode |
VARCHAR |
|
O |
Code de Collecte |
Réponse du webservice
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<CreateManifestResponse xmlns=”http://mobile.crossdesk.com/”>
<CreateManifestResult>
<TruckId>int</TruckId>
<TrackingNumbers>
<string>string</string>
<string>string</string>
</TrackingNumbers>
<PackNumbers>
<string>string</string>
<string>string</string>
</PackNumbers>
<DocumentContent>base64Binary</DocumentContent>
</CreateManifestResult>
</CreateManifestResponse>
</soap12:Body>
</soap12:Envelope>
La méthode retourne un numéro de camion ( truckid ) qui identifie l’expédition ainsi que les numéros de suivi et numéros interne Crosslog des colis expédiés.
Elle retourne également le bordereau de remise (au format PDF) codé en base 64 dans le champ DocumentContent de la réponse.
Erreurs possibles
9) CreatePartialManifest()
Description
La méthode permet d’expédier informatiquement une liste de colis pour un transporteur.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
CreatePartialManifest |
collectCode |
VARCHAR |
20 |
O |
Code collecte transporteur |
|
packNumbers |
string[] |
|
O |
Liste des numéros de colis |
|
|
PackNumbers |
string |
VARCHAR |
20 |
O |
Numéro de colis |
Réponse du webservice
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<CreatePartialManifestResponse xmlns=”http://mobile.crossdesk.com/”>
<CreatePartialManifestResult>
<TruckId>int</TruckId>
<TrackingNumbers>
<string>string</string>
<string>string</string>
</TrackingNumbers>
<PackNumbers>
<string>string</string>
<string>string</string>
</PackNumbers>
<DocumentContent>base64Binary</DocumentContent>
</CreatePartialManifestResult>
</CreatePartialManifestResponse>
</soap12:Body>
</soap12:Envelope>
La méthode retourne un numéro de camion ( truckid ) qui identifie l’expédition ainsi que les numéros de suivi et numéros interne Crosslog des colis expédiés.
Elle retourne également le bordereau de remise (au format PDF) codé en base 64 dans le champ DocumentContent de la réponse.
10) GetManifest()
Description
Cette méthode permet de récupérer le bordereau de remise transporteur d’un ensemble de colis expédiés informatiquement.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
GetManifest |
truckId |
INTEGER |
|
O |
Numéro de camion |
Réponse du webservice
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>
<GetManifestResponse xmlns=”http://mobile.crossdesk.com/”>
<GetManifestResult>
<TruckId>int</TruckId>
<TrackingNumbers>
<string>string</string>
<string>string</string>
</TrackingNumbers>
<PackNumbers>
<string>string</string>
<string>string</string>
</PackNumbers>
<DocumentContent>base64Binary</DocumentContent>
</GetManifestResult>
</GetManifestResponse>
</soap:Body>
</soap:Envelope>
La méthode retourne un numéro de camion ( truckid ) qui identifie l’expédition ainsi que les numéros de suivi et numéros interne Crosslog des colis expédiés.
Elle retourne également le bordereau de remise (au format PDF) codé en base 64 dans le champ DocumentContent de la réponse.
Erreurs possibles
D/ Méthodes disponibles sur le webservice EasyColisAdvanced
– GetParcelReturn()
– GetParcelReturnUrl()
– CreateTruck()
– DeclareTruck()
– GetOrderDocument()
1) GetParcelReturn()
Description
La méthode permet de créer le colis et l’étiquette transport retour d’une commande pour un service transport spécifique.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
GetParcelReturn |
orderNumber |
VARCHAR |
20 |
O |
Numéro de la commande |
|
GetParcelReturn |
CarrierServiceCode |
VARCHAR |
20 |
O |
Code du Service Retour |
|
GetParcelReturn |
ParcelFormat |
VARCHAR |
20 |
O |
Format de l’étiquette (ZPL, EPL, DMX, PDF) |
Réponse du webservice
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<GetParcelReturnResponse xmlns=”http://mobile.crossdesk.com/”>
<GetParcelReturnResult>
<PackNumber>string</PackNumber>
<TrackingNumber>string</TrackingNumber>
<CarrierCode>string</CarrierCode>
<ParcelContent>base64Binary</ParcelContent>
</GetParcelReturnResult>
</GetParcelReturnResponse>
</soap12:Body>
</soap12:Envelope>
L’étiquette retour est fournie en base 64 dans le champ ParcelContent de la réponse du webservice. Elle est au format demandé lors de l’appel.
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
GetCustomerOrderInformationResponse |
GetCustomerOrderInformationResult |
|
|
|
|
|
GetCustomerOrderInformationResult |
OrderNumber |
VARCHAR |
20 |
Requis |
|
|
State |
VARCHAR |
20 |
Requis |
|
|
|
StateGlobal |
VARCHAR |
30 |
Requis |
|
|
|
CarrierCode |
VARCHAR |
3 |
Requis |
|
|
|
OrderLines |
XLFlowOrderLineReturnEntity[] |
|
Requis |
|
|
|
OrderEvents |
XLFlowOrderEventReturnEntity[] |
|
Requis |
|
|
|
OrderPacks |
XLFlowOrderPackReturnEntity[] |
|
Optionnel |
|
|
|
XLFlowOrderLineReturnEntity |
Code |
VARCHAR |
70 |
Requis |
|
|
BarCode |
VARCHAR |
60 |
Optionnel |
|
|
|
InitialQuantity |
INTEGER |
|
Requis |
|
|
|
ReservedQuantity |
INTEGER |
|
Requis |
|
|
|
ReturnedQuantity |
INTEGER |
|
Requis |
||
|
SentQuantity |
INTEGER |
|
Requis |
|
|
|
XLFlowOrderEventReturnEntity |
Date |
DATETIME |
|
Requis |
|
|
State |
VARCHAR |
5 |
Requis |
|
|
|
StateGlobal |
VARCHAR |
3 |
Requis |
|
|
|
Comment |
TEXT |
|
Requis |
|
|
|
XLFlowOrderPackReturnEntity |
PackNumber |
VARCHAR |
36 |
Requis |
|
|
TrackingNumber |
BASE64 |
|
Requis |
|
|
|
Weight |
DECIMAL |
|
Requis |
|
|
|
PackLines |
XLFlowOrderPackLineReturnEntity[] |
|
Optionnel |
|
|
|
XLFlowOrderPackLineReturnEntity |
Code |
VARCHAR |
70 |
Requis |
|
|
Quantity |
INTEGER |
|
|
|
|
|
BarCode |
VARCHAR |
|
Optionnel |
|
2) GetParcelReturnUrl()
Description
La méthode permet de créer le colis et l’étiquette transport retour d’une commande pour un service transport spécifique.
On récupère l’url de téléchargement de l’étiquette.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
GetParcelReturnUrl |
orderNumber |
VARCHAR |
20 |
O |
Numéro de la commande |
|
GetParcelReturnUrl |
CarrierServiceCode |
VARCHAR |
20 |
O |
Code du Service Retour demandé |
Réponse du webservice
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<GetParcelReturnUrlResponse xmlns=”http://mobile.crossdesk.com/”>
<GetParcelReturnUrlResult>string</GetParcelReturnUrlResult>
</GetParcelReturnUrlResponse>
</soap12:Body>
</soap12:Envelope>
Une url est retournée dans le champ GetParcelReturnUrlResult de la réponse du webservice. Elle permet le téléchargement de l’étiquette retour
3) CreateTruck()
Description
La méthode permet de définir une liste de colis pour un transporteur en vue de leurs expéditions informatique.
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
CreateTruck |
collectCode |
VARCHAR |
20 |
O |
Code collecte transporteur |
|
packNumbers |
string[] |
|
O |
Liste des numéros de colis |
|
|
packNumber |
string |
VARCHAR |
20 |
O |
Numéro de colis |
Réponse du webservice
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>
<CreateTruckResponse xmlns=”http://mobile.crossdesk.com/”>
<CreateTruckResult>int</CreateTruckResult>
</CreateTruckResponse>
</soap:Body>
</soap:Envelope
La méthode retourne le numéro de camion ( truckid ) qui doit être utilisé pour l’appel à la méthode DeclareTruck()
Erreurs possibles
– Un des colis est déjà déclaré
– Un des colis n’existe pas
– La liste de colis est vide. La création d’un chargement colis est impossible.
4) DeclareTruck()
Description
La méthode permet d’expédier informatiquement un ensemble de colis identifiés par un numéro de camion ( truckid ).
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
DeclareTruck |
truckId |
INTEGER |
|
O |
Numéro de camion |
Réponse du webservice
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>
<DeclareTruckResponse xmlns=”http://mobile.crossdesk.com/” />
</soap:Body>
</soap:Envelope>
Erreurs possibles
5) GetOrderDocument()
Description
La méthode permet de récupérer les documents associés à une commande. Les documents disponibles dépendent de l’état de traitement de la commande.
Ces documents peuvent être (liste non limitative) :
– Les documents associées aux colis
– La facture
– Le bordereau de livraison
Liste des champs à remplir
| NOM OBJET | NOM PROPRIÉTÉ | TYPE | TAILLE | REQUIS | DESCRIPTION |
|---|---|---|---|---|---|
|
GetOrderDocument |
orderNumber |
VARCHAR |
20 |
O |
Numéro de la commande |
Réponse du webservice
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>
<GetOrderDocumentResponse xmlns=”http://mobile.crossdesk.com/”>
<GetOrderDocumentResult>
<XLFlowOrderDocumentReturnEntity>
<DocumentType>string</DocumentType>
<DocumentContent>base64Binary</DocumentContent>
</XLFlowOrderDocumentReturnEntity>
<XLFlowOrderDocumentReturnEntity>
<DocumentType>string</DocumentType>
<DocumentContent>base64Binary</DocumentContent>
</XLFlowOrderDocumentReturnEntity>
</GetOrderDocumentResult>
</GetOrderDocumentResponse>
</soap:Body>
</soap:Envelope>