Expédition avec convention

Exemples de codes pour l'expédition avec convention : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir les détails de l'envoi – Module SOAP

Résumé

Nom :	Obtenir les détails de l'envoi
Raison pour utiliser le service :	Pour récupérer une représentation XML des détails de l'envoi, y compris le NIP de repérage
Données d'entrée :	mailed-by; shipment-id; locale (optionnel)
Données de sortie :	NIP de repérage de l'étiquette d'expédition Point d'expédition final Structure XML dont les données d'entrée d'expédition d'origine ont été utilisées pour créer l'envoi Numéro d'identification de groupe sous lequel l'envoi initial a été créé, au besoin
Exemple d'erreur :	Numéro d'identification invalide ou expiré pour l'envoi
Demande de service précédente habituelle :	Créer l'envoi
Prochaine demande de service habituelle :	Obtenir l'artefact
Prochaine demande de service optionnelle :	Obtenir le tarif de l'envoi (si ce service n'a pas encore été utilisé) ou Créer l'envoi (pour continuer à créer des envois)
Historique des versions :	Notes de mise à jour

Obtenir les détails de l'envoi – Résumé du service

Détails sur la demande

WSDL :	shipment.wsdl
Point final (Conception) :	https://ct.soa-gw.canadapost.ca/rs/soap/shipment/v8
Point final (Production) :	https://soa-gw.canadapost.ca/rs/soap/shipment/v8
Espace de nommage :	http://www.canadapost.ca/ws/soap/shipment/v8
Opération :	GetShipmentDetails

Corps – SOAP

La présente section décrit les éléments XML d'entrée pour ce service. Pour obtenir la structure hiérarchique, consultez le diagramme XML.

Obtenir les détails de l'envoi – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-shipment-details-request	complexe	requis	Élément XML de niveau supérieur de la structure de la réponse.
mailed-by	simple	requis	(1 à 10 caractères numériques) Il s'agit du numéro de client à 10 chiffres du client « Expédié par ». Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début.
mobo	simple	optionnel	(1 à 10 caractères numériques) Il s'agit du numéro de client à 10 chiffres du client « Expédié au nom de ». S'il manque cet élément, le numéro du client « Expédié par » s'affichera par défaut. Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début.
locale	simple	optionnel	Indique votre langue de préférence pour recevoir les messages d'erreur. EN = Anglais FR = Français Si aucune valeur n'est fournie, la langue par défaut est « Anglais ».
shipment-id	simple	requis	(Chaîne alphanumérique – Jusqu'à 32 lettres/chiffres) Numéro d'identification représentant l'envoi existant pour lequel les renseignements sont demandés. Nota : Il faut récupérer le numéro d'identification de l'envoi fourni dans le cadre des demandes de service précédentes « Créer l'envoi » et « Obtenir l'envoi ». Les données de sortie de ces services comprendront un numéro d'identification pour l'envoi.

Demande – Diagramme XML

Obtenir les détails de l'envoi – Structure de la demande XML

Détails de la réponse

Réponse – Éléments

Le tableau suivant décrit les éléments XML figurant dans la réponse à la demande d'obtention des détails de l'envoi. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir les détails de l'envoi – Éléments de la réponse
Nom de l'élément	Type	Description
get-shipment-details-response	complexe	Il s'agit de l'élément XML de niveau supérieur de la structure de la réponse. Il affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur.
shipment-details	complexe	Structure ou élément XML contenant les résultats liés à l'exécution réussie du service en question.
customer-request-id	simple	Votre code de transaction unique, si vous l’avez indiqué dans votre demande.
shipment-status		Les valeurs valides sont les suivantes : Créé Transmis Suspendu Indique l'état actuel de l'envoi.
final-shipping-point	simple	Cet élément est utilisé pour la tarification. Si vous fournissez un élément requested-shipping-point dans votre demande de service « Créer l'envoi », il faut saisir le code postal de l'installation de Postes Canada qui est la plus près de votre lieu de ramassage. Si vous avez réglé l'élément shipping-point-id dans votre demande de service « Créer l'envoi », il s'agit du code postal du lieu de dépôt que vous avez choisi.
shipping-point-id	Simple	Si vous choisissez de déposer vos envois, cet élément contient le numéro d'emplacement de l'installation de Postes Canada que vous avez sélectionné.
cpc-pickup-indicator	Simple	{true} Cet élément s'affiche si vous avez demandé que vos envois soient ramassés.
tracking-pin	simple	Il s'agit du numéro d'identification du produit (NIP) pour l'envoi. Le NIP de repérage peut être utilisé en tant que donnée d'entrée pour toute autre demande de service pour les colis, notamment le service « Obtenir les détails de repérage ».
po-number	simple	Il s'agit du numéro de bon de commande de Postes Canada. Il ne s'applique et n'est affiché que pour pour lequel un manifeste n'est pas requis à titre de preuve de paiement.
destination	complexe	Cet élément contient une des adresses suivantes : Adresse du destinataire du courrier (pour les envois réguliers) Adresse du bureau de poste où l'envoi sera livré (pour les envois expédiés à l'aide de l'option « Livrer au bureau de poste »)
recipient	complexe	Cet élément s'affiche seulement dans la réponse si vous sélectionnez l'option « Livrer au bureau de poste » (D2PO) lorsque vous créez l'envoi. Il contient l'adresse du destinataire du courrier que vous avez indiquée dans l'élément « destination » de votre demande.
return-spec	Complexe	Cette structure est identique à la structure correspondante dans la demande (données d'entrée) pour le service Créer l'envoi.
refund-request-info	Complexe	Cette structure est présente seulement si une demande de remboursement a été soumise pour l'envoi.
service-ticket-date	Simple	Date à laquelle la demande de remboursement a été soumise.
service-ticket-id	Simple	Numéro de billet de service attribué à la demande de remboursement. Veuillez utiliser ce numéro dans toutes les communications que vous entretenez avec Postes Canada au sujet de cette demande de remboursement.
Les autres éléments sont identiques aux éléments qui font partie de la demande (données d'entrée) pour le service « Créer l'envoi » (exception faite de l'élément « requested-shipping-point »). Pour obtenir une description complète de ces éléments, consultez la section Créer l'envoi – Éléments de la demande.

Réponse – Diagramme XML

Le diagramme suivant présente la structure de niveau supérieur de la réponse XML pour ce service.

Obtenir les détails de l'envoi – Structure de la réponse XML

Voir l'image en taille réelle

Réponse – Réponses d'erreur possibles

La réponse à des conditions d'erreur pour ce service en ligne respecte l'approche standard SOAP liée à la réponse d'erreur, laquelle est utilisée pour tous les services en ligne de Postes Canada. Pour obtenir de plus amples renseignements, consultez les Principes de base liés au module SOAP pour les services en ligne de Postes Canada.

Exemples

Exemple de demande XML selon le module SOAP – Obtenir les détails de l'envoi


  

		<get-shipment-details-request>
		<mailed-by>1111111</mailed-by>

		<locale>EN</locale>

		<shipment-id>340531309186521749</shipment-id>

	
		</get-shipment-details-request>

  
  
  Exemple de réponse XML selon le module SOAP – Obtenir les détails de l'envoi
  
  	

		<get-shipment-details-response>
	
		<shipment-details>
	
		<shipment-status>created</shipment-status>

		<final-shipping-point>J4W4T0</final-shipping-point>

        <cpc-pickup-indicator>true</cpc-pickup-indicator>

		<tracking-pin>1111111875783100</tracking-pin>

		<shipment-detail>
	
		<group-id>123456</group-id>

		<expected-mailing-date>2011-09-29</expected-mailing-date>

		<delivery-spec>
	
		<service-code>DOM.EP</service-code>

		<sender>
	
		<name>John Doe</name>

		<company>Canada Post Corporation</company>

		<contact-phone>1-555-555-5555</contact-phone>

		<address-details>
	
		<address-line-1>2701 Riverside Drive</address-line-1>

		<city>Ottawa</city>

		<prov-state>ON</prov-state>

		<country-code>CA</country-code>

		<postal-zip-code>K1A0B1</postal-zip-code>

	
		</address-details>

	
		</sender>

		<destination>
	
		<name>John Doe</name>

		<company>12345678 Ont. Limited</company>

		<address-details>
	
		<address-line-1>123 Any Street</address-line-1>

		<city>Ottawa</city>

		<prov-state>ON</prov-state>

		<country-code>CA</country-code>

		<postal-zip-code>K1K4T3</postal-zip-code>

	
		</address-details>

	
		</destination>

		<options>
	
		<option>
	
		<option-code>DC</option-code>

	
		</option>

	
		</options>

		<parcel-characteristics>
	
		<weight>15.000</weight>

		<dimensions>
	
		<length>12</length>

		<width>9</width>

		<height>6</height>

	
		</dimensions>

		<unpackaged>true</unpackaged>

		<mailing-tube>false</mailing-tube>

		<oversized>false</oversized>

	
		</parcel-characteristics>

		<notification>
	
		<email>this@that.com</email>

		<on-shipment>true</on-shipment>

		<on-exception>false</on-exception>

		<on-delivery>true</on-delivery>

	
		</notification>

		<print-preferences>
	
		<output-format>8.5x11</output-format>

	
		</print-preferences>

		<preferences>
	
		<show-packing-instructions>true</show-packing-instructions>

		<show-postage-rate>false</show-postage-rate>

		<show-insured-value>true</show-insured-value>

	
		</preferences>

		<settlement-info>
	
		<paid-by-customer>0001111111</paid-by-customer>

		<contract-id>0012345678</contract-id>

		<intended-method-of-payment>Account</intended-method-of-payment>

	
		</settlement-info>

	
		</delivery-spec>

	
		</shipment-detail>

	
		</shipment-details>

	
		</get-shipment-details-response>

Ouvrir unesession

Ressources