Expédition avec convention

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

Obtenir les détails du manifeste – Module SOAP

Résumé

Nom :	Obtenir les détails du manifeste
Raison pour utiliser le service :	Pour récupérer les renseignements qui se trouvent sur le manifeste papier, notamment le coût total du manifeste
Données d'entrée :	Numéro de client; manifest-id; locale (optionnel)
Données de sortie :	Le total des frais d’expédition pour tous les envois dans le manifeste et les renseignements apparaissant sur le reçu du paiement par carte de crédit ou par compte de fournisseur, le cas échéant.
Exemple d'erreur :	Numéro d'identification de manifeste invalide (p. ex. le manifeste n'existe pas)
Demande de service précédente habituelle :	Transmettre les envois
Prochaine demande de service habituelle :	Obtenir l'artefact (si ce service n'a pas déjà été utilisé)
Historique des versions :	Notes de mise à jour

Obtenir les détails du manifeste – Résumé du service

Détails sur la demande

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

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 du manifeste – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-manifest-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 ».
manifest-id	simple	requis	(Chaîne alphanumérique – Jusqu'à 32 lettres/chiffres) Numéro d'identification représentant le manifeste existant pour lequel les renseignements sont demandés. Nota : Il faut récupérer le numéro d'identification du manifeste fourni dans le cadre des demandes de service précédentes « Transmettre les envois » et « Obtenir les manifestes ». Les données de sortie de ces services comprendront un numéro d'identification pour l'envoi.

Demande – Diagramme XML

Obtenir les détails du manifeste – 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 du manifeste. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir les détails du manifeste – Éléments de la réponse
Nom de l'élément	Type	Description
get-manifest-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'une erreur.
manifest-details	complexe	Structure XML contenant les résultats liés à l'exécution réussie du service en question.
po-number	simple	Numéro du bon de commande utilisé aux fins de facturation figurant sur le manifeste.
final-shipping-point	simple	Code postal du bureau de poste où l'envoi doit être déposé.
shipping-point-name	simple	Nom descriptif du point d'expédition final.
shipping-point-id	simple	Numéro d'identification de Postes Canada pour le point d'expédition final.
cpc-pickup-indicator	Simple	{true} Affiché si vous avez mentionné que votre courrier est ramassé par Postes Canada à votre emplacement. N'est fourni que quand l'indicateur correspond à « true ».
mailed-by-customer	simple	Numéro de client à 10 chiffres du client « Expédié par ».
mailed-on-behalf-of	simple	Numéro de client à 10 chiffres du client « Expédié au nom de ».
paid-by-customer	simple	Il s'agit du numéro de client à 10 chiffres pour le client qui paie l'envoi. Ce numéro est souvent le même que le numéro du client « Expédié au nom de ».
customer-reference	simple	Numéro de référence défini et fourni dans la demande de transmission.
manifest-date	simple	(AAAA-MM-JJ) Date à laquelle le manifeste a été généré. Nota : La date apparaît également pour l'envoi sur le manifeste imprimé.
manifest-time	simple	(HH:MM TZ) Heure à laquelle le manifeste a été généré.
contract-id	simple	Il s’agit du numéro de la convention utilisée pour la tarification de ce manifeste, s’il y a lieu (p. ex., si vous utilisez un service qui n’est pas indiqué dans votre convention, il n’est pas nécessaire d’indiquer le numéro de cette dernière).
method-of-payment	simple	Désigne votre mode de paiement.
cc-receipt-details	complexe	Cette structure sera fournie si le manifeste a été payé par carte de crédit dans le cadre d'une demande de service « Transmettre les envois ». Cette structure contient les éléments requis pour une copie papier du reçu de carte de crédit.
merchant-name	simple	La valeur sera la suivante : "Canada Post".
merchant-url	simple	La valeur sera la suivante : "www.canadapost.ca".
name-on-card	simple	Nom figurant sur la carte de crédit par défaut sauvegardée par Postes Canada.
auth-code	simple	Code d'autorisation reçu de la société émettrice de la carte de crédit.
auth-timestamp	simple	Date et heure auxquelles la transaction a été autorisée par la société émettrice de cartes de crédit.
card-type	simple	Type de carte de crédit utilisé pour l'achat.
currency	simple	Devise de la transaction : CAD.
transaction-type	simple	La valeur sera la suivante : « Sale ».
supplier-account-receipt-details	complexe	Cette structure sera offerte si le manifeste a été payé par compte de fournisseur dans la demande Transmettre les envois. Cette structure n’est pas retournée dans l’environnement « bac à sable ».
merchant-name	Simple	Fait partie du paramètre « supplier-account-receipt-details » La valeur sera la suivante : « Canada Post ».
merchant-url	Simple	Fait partie du paramètre « supplier-account-receipt-details » La valeur sera la suivante : « www.canadapost.ca ».
auth-code	Simple	Fait partie du paramètre « supplier-account-receipt-details » Le code d’autorisation reçu du fournisseur.
auth-timestamp	Simple	Fait partie du paramètre « supplier-account-receipt-details » La date et l’heure auxquelles le fournisseur a autorisé la transaction.
supplier-id	Simple	Fait partie du paramètre « supplier-account-receipt-details » Le fournisseur qui a autorisé la transaction. Les valeurs sont : FP = FrancoTyp Postalia NE = Neopost PB = Pitney Bowes
charge-amount	Simple	Fait partie du paramètre « supplier-account-receipt-details » Le montant total facturé au compte.
currency	Simple	Fait partie du paramètre « supplier-account-receipt-details » Devise de la transaction : toujours CAD.
transaction-type	Simple	Fait partie du paramètre « supplier-account-receipt-details » La valeur sera la suivante : « Sale ».
manifest-pricing-info	complexe	Contient des renseignements sur la tarification totale de tous les envois inclus dans le manifeste.
base-cost	simple	Total des coûts de base pour tous les envois figurant sur le manifeste.
automation-discount	complexe	Total de la réduction à l'automatisation pour tous les envois figurant sur le manifeste.
options-and-surcharges	simple	Total pour les options et les suppléments pour tous les envois figurant sur le manifeste.
gst	simple	Total de la TPS pour tous les envois figurant sur le manifeste.
pst	simple	Total de la TVP pour tous les envois figurant sur le manifeste.
hst	simple	Total de la TVH pour tous les envois figurant sur le manifeste.
total-due-cpc	simple	Total dû à Postes Canada pour tous les envois figurant sur le manifeste.
manifest-address	complexe	Les éléments de l'adresse figurant sur le manifeste sont identiques aux éléments décrits dans « manifest-address » dans les éléments de réponse de la demande de service « Transmettre les envois ». Les voici : manifest-name, address-details, address-line-1, address-line-2, city, prov-state, country-code and postal-zip-code.

Réponse – Diagramme XML

Obtenir les détails du manifeste – Structure de la réponse XML

Voir l'image en taille réelle

Réponse – Réponses d'erreur possibles

Vous recevrez une erreur404 si vous utilisez le service Obtenir les détails du manifeste plus de 90jours après la création de celui-ci, ou si vous lutilisez pour un manifeste vide (voir la page Transmettre les envois pour obtenir plus de détails).

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 du manifeste


  

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

		<manifest-id>347891314723499921</manifest-id>

	
		</get-manifest-details-request>

Exemple de réponse XML selon le module SOAP – Obtenir les détails du manifeste


  	

		<get-manifest-details-response>
	
		<manifest-details>
	
		<po-number>D906369782</po-number>

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

		<shipping-point-name>BP BROSSARD</shipping-point-name>

		<shipping-point-id>0192</shipping-point-id>

		<mailed-by-customer>0001111111</mailed-by-customer>

		<mailed-on-behalf-of>0001111111</mailed-on-behalf-of>

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

		<manifest-date>2011-09-20</manifest-date>

		<manifest-time>14:10 EDT</manifest-time>

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

		<method-of-payment>account</method-of-payment>

		<manifest-pricing-info>
	
		<base-cost>25.84</base-cost>

		<automation-discount>0</automation-discount>

		<options-and-surcharges>17.58</options-and-surcharges>

		<gst>0.00</gst>

		<pst>0</pst>

		<hst>5.64</hst>

		<total-due-cpc>49.06</total-due-cpc>

	
		</manifest-pricing-info>

		<manifest-address>
	
		<manifest-company>Canada Post Corporation</manifest-company>

		<phone-number>555-555-5555</phone-number>

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

	
		</manifest-address>

	
		</manifest-details>

	
		</get-manifest-details-response>

Ouvrir unesession

Ressources