Expédition sans convention

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

Obtenir l'envoi sans convention – Module SOAP

Résumé

Nom :	Obtenir l'envoi sans convention
Raison pour utiliser le service :	Pour récupérer le NIP de repérage et le numéro d'identification de l'artefact associés à un envoi créé précédemment
Données d'entrée :	Numéro d'identification de l'envoi
Données de sortie :	Le numéro de repérage de l'envoi, le numéro d'identification de l'artefact et l'état de l'envoi sont fournis pour l'envoi en question. Nota : Les renseignements fournis par le service « Obtenir l'envoi sans convention » sont identiques à ceux du service « Créer l'envoi sans convention ».
Demande de service précédente habituelle :	Obtenir les envois sans convention
Prochaine demande de service habituelle :	Obtenir l'artefact
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 :	GetNonContractShipment

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 l'envoi sans convention – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-non-contract-shipment-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 : l 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 ».

Demande – Diagramme XML

Obtenir 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 d'un envoi sans convention. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir l'envoi sans convention – Éléments de la réponse
Nom de l'élément	Type	Description
get-non-contract-shipment-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-info	complexe	Structure XML contenant les résultats liés à l'exécution réussie du service en question.
shipment-id	simple	Numéro d'identification unique pour l'envoi.
shipment-status	simple	Indique l'état actuel de l'envoi, notamment : transmitted suspended
tracking-pin	simple	NIP de repérage pour l'envoi. Il 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 ».
artifacts	complexe	Cette structure contient une série d'artefacts (étiquettes) propre à l'envoi.
artifact	complexe	Représente un artefact (étiquette) individuel pour l'envoi. Occurrence (1 à N fois). (Nota : L'élément XML lié à l'artefact est désigné comme « Complexe », car il contient de nombreux attributs. Il ne contient aucun sous-élément.) Cet élément inclura le type d'attribut « XXX » correspondant au type d'étiquette représenté par cet artefact. Voici les valeurs possibles pour cet attribut : "label" – Étiquette d'expédition principale "codRemittanceReturnLabel" – Il s'agit de l'étiquette utilisée lorsque le système doit afficher un paiement CR. Cela signifie que l'étiquette est une combinaison d'un paiement CR et d'un registre de livraison sur une seule feuille de papier. "commercialInvoice" – Existe seulement dans le cas d'un envoi à destination des États-Unis ou du régime international pour lequel il faut présenter une facture commerciale aux douanes.
artifact-id	simple	Numéro d'identification unique pour l'étiquette (artefact) pouvant être utilisé dans le cadre de la demande de service « Obtenir l'artefact » pour récupérer l'étiquette.
page-index	simple	Nota : Cet élément est toujours zéro pour le PDF étant donné que ce dernier appuie plusieurs pages. Il n'est pas requis dans les demandes de récupération des documents PDF.

Réponse – Diagramme XML

Obtenir 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 l'envoi sans convention


  

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

		<locale>EN</locale>

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

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

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


  

		<get-non-contract-shipment-response>
	
		<non-contract-shipment-info>
	
		<shipment-id>406951321983787352</shipment-id>

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

		<artifacts>
	
		<artifacttype="label">
	
		<artifact-id>20238</artifact-id>

		<page-index>0</page-index>

	
		</artifact>

	
		</artifacts>

	
		</non-contract-shipment-info>

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

Ouvrir unesession

Ressources