Expédition sans convention

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

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

Résumé

Nom :	Obtenir les détails de l'envoi sans convention
Raison pour utiliser le service :	Cette demande de service sert à obtenir les détails d'un envoi, y compris les champs générés par le système (p. ex. le numéro de repérage).
Données d'entrée :	Numéro d'identification de l'envoi
Données de sortie :	Détails de l'envoi en format XML
Demande de service précédente habituelle :	Créer l'envoi sans convention ou Obtenir l'envoi sans convention
Prochaine demande de service habituelle :	Obtenir l'artefact ou Créer l'envoi sans convention
Historique des versions :	Notes de mise à jour

Détails sur la demande

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

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 sans convention – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-non-contract-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.
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 les numéros d'identification des envois fournis dans le cadre des demandes de service précédentes « Créer l'envoi sans convention » et « Obtenir l'envoi sans convention ». 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 sans convention – 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 sans convention. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir les détails de l'envoi sans convention – Éléments de la réponse
Nom de l'élément	Type	Description
get-non-contract-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.
non-contract-shipment-details	complexe	Structure XML contenant les résultats liés à l'exécution réussie du service en question.
final-shipping-point	simple	Il s'agit du code postal du bureau de poste où les envois doivent être déposés. Chaque bureau de poste a un code postal unique. Si vous fournissez le code postal d'un bureau de poste valide (en utilisant l'élément requested-shipping-point en tant que données d'entrée pour la création d'un envoi sans convention), le final-shipping-point correspondra à cette valeur. Toutefois, si vous précisez un code postal qui n'est pas valide pour le bureau de poste (en utilisant l'élément requested-shipping-point en tant que données d'entrée pour la création d'un envoi sans convention), la valeur de l'élément final-shipping-point sera générée comme étant le code postal du comptoir postal de Postes Canada qui est le plus près sur le plan géographique du code postal du requested-shipping-point que vous avez fourni.
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 ».
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.
delivery-spec	complex	L'élément « Complexe » contient toutes les données utilisées pour créer l'envoi. Les éléments dans delivery-spec ont la même structure et les mêmes valeurs que celles fournies par la demande « Créer l'envoi sans convention ». Consultez les sections Éléments de la demande et Demande – Diagramme XML pour le service « Créer l'envoi sans convention ».
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 d'identification du 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.

Réponse – Diagramme XML

Obtenir les détails de l'envoi sans convention – 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 sans convention


  

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

		<locale>EN</locale>

		<shipment-id>406951321983787352</shipment-id>

	
		</get-non-contract-shipment-details-request>

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


  

		<get-non-contract-shipment-details-response>
	
		<non-contract-shipment-details>
	
		<final-shipping-point>K1A0B1</final-shipping-point>

		<tracking-pin>11111118901234</tracking-pin>

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

		<sender>
	
		<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>

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

	
		</address-details>

	
		</sender>

		<destination>
	
		<name>John Smith</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>1</length>

		<width>1</width>

		<height>1</height>

	
		</dimensions>

		<document>false</document>

		<unpackaged>false</unpackaged>

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

	
		</parcel-characteristics>

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

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

		<show-insured-value>false</show-insured-value>

	
		</preferences>

	
		</delivery-spec>

	
		</non-contract-shipment-details>

	
		</get-non-contract-shipment-details-response>

Ouvrir unesession

Ressources