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 REST

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

Demande – Structure pour le service « Obtenir les détails de l'envoi sans convention »

Point final

POST https://XX/rs/{mailed by customer}/ncshipment/{shipment id}/details
Remplacez...	Par...
XX (Conception)	ct.soa-gw.canadapost.ca
XX (Production)	soa-gw.canadapost.ca
{Client « Expédié par »}	Votre numéro de client*
{Numéro d'identification de l'envoi}	Numéro d'identification de l'envoi pertinent*

*Le lien fourni par la demande de service « Créer l'envoi sans convention » ou « Obtenir l'envoi sans convention » remplacera {Client « Expédié par »} par votre numéro de client et {Numéro d'identification de l'envoi} par le bon numéro d'identification de l'envoi.

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	application/vnd.cpc.ncshipment-v4+xml (Remarque : / à la place de la valeur de l’en-tête affichera un message d’erreur)
Content-Type	application/vnd.cpc.ncshipment-v4+xml (Remarque : / à la place de la valeur de l’en-tête affichera un message d’erreur)
Authorization	Basic {Encodage en base64 du code d'usager:mot de passe}
Accept-language	en-CA ou fr-CA

Corps du message

Aucun

Demande – Éléments

Les données d'entrée XML ne sont pas nécessaires pour le service « Obtenir les détails de l'envoi sans convention ».

Détails de la réponse

Réponse – Éléments

Le tableau suivant décrit les champs XML figurant dans la réponse à la demande d'obtention des détails de l'envoi sans convention.

Obtenir les détails de l'envoi sans convention – Éléments de la réponse
Nom de l'élément	Type	Description
non-contract-shipment-details	Complexe	Élément du niveau supérieur de la structure XML de la réponse.
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	Complexe	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

Aucune erreur n'est prévue pour l'utilisation du service « Créer l'envoi sans convention » ou « Obtenir l'envoi sans convention ». Toutefois, pour obtenir les réponses d'erreur générales, consultez la section Codes de statut HTTP.

Exemples

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

Il n'y a pas de XML lié à cette demande REST. Utilisez le lien fourni dans une demande préalable ou consultez les fichiers du projet soapUI pour obtenir des exemples de demande.

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


  

		<non-contract-shipment-details>
	
		<final-shipping-point>J4W4T0</final-shipping-point>

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

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

		<sender>
	
		<company>Canada Post Corporation</company>

		<contact-phone>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 Doe</name>

		<company>Consumer</company>

		<address-details>
	
		<address-line-1>2701 Receiver 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>

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

Ouvrir unesession

Ressources