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 REST

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 :

Utiliser le lien associé au service Créer l'envoi ou Obtenir l'envoi lorsque rel= "details"

Données de sortie :

Voici les renseignements fournis :

  • 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
  • L'élément group-id, sous lequel l'envoi initial a été créé, au besoin
Exemple d'erreur :

Lien invalide ou expiré

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

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

Détails sur la demande

Structure de la demande pour obtenir les détails de l'envoi

Point final

Il faut utiliser le lien associé à une demande de service précédente lorsque rel="details" (voir la section Points finaux fournis).

En-têtes HTTP

Variable des en-têtes HTTP Valeur

Accept

application/vnd.cpc.shipment-v8+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur)

Authorization

Basic {Encodage base64 du code d'usager:mot de passe}

Accept-language

en-CA ou fr-CA

Corps du message

Aucun

Éléments de la demande

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

Détails de la réponse

Réponse – Éléments

Le tableau suivant offre un aperçu général des données XML figurant dans la réponse.

Obtenir les détails de l'envoi – Éléments de la réponse
Nom de l'élément Type Description

shipment-details

Complexe

Élément du niveau supérieur de la structure XML

customer-request-id

Simple

Votre code de transaction unique, si vous l’avez indiqué dans votre demande.

shipment-status

Simple

(Chaîne de caractères – Jusqu'à 14 caractères)

Fait partie des shipment-details.

Les valeurs valides sont les suivantes :

  • created
  • transmitted
  • suspended

Fait partie des details.

Indique l'état actuel de l'envoi.

final-shipping-point

Simple

(Chaîne de six caractères alphanumériques)

Doit être dans un format de code postal valide.

Exemple : A9A9A9

Le format est [A-Z]\d[A-Z]\d[A-Z]\d.

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

(Chaîne de caractères numériques – Jusqu'à 16 chiffres)

Fait partie des shipment-details.

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 en ligne pour les colis, notamment le service Obtenir les détails de suivi.

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 un envoi 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). 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 – Niveau supérieur
Obtenir les détails de l'envoi – Structure de la réponse XML – Niveau supérieur

Réponse – Réponses d'erreur possibles

Aucune erreur n'est prévue pour l'utilisation de ce lien, mais vous apercevrez une erreur 404 si vous utilisez le service Obtenir les détails de l'envoi plus de 90 jours après que le lien a été fourni.

Veuillez consulter la section Codes de statut HTTP pour obtenir de plus amples renseignements.

Exemples

Exemple de demande REST – Obtenir les détails de l'envoi

GET https://XX/rs/0001111111/0001111111/shipment/348821316871829846/details
Accept:application/vnd.cpc.shipment-v8+xml
Authorization:Basic s7HD7gwsennesc==

Nota : Le lien vers le point final HTTP et la valeur « Accept » ne doivent pas être intégrés. Ces valeurs doivent plutôt être fournies à titre de données de sortie pour les services Créer l'envoi et Obtenir l'envoi.

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

<shipment-details>
<shipment-status>reconciled</shipment-status>
<final-shipping-point>K1G1C0</final-shipping-point>
<shipping-point-id>0015</shipping-point-id>
<tracking-pin>1234567890123456</tracking-pin>
<shipment-detail>
<group-id>bobo</group-id>
<requested-shipping-point>K1G1C0</requested-shipping-point>
<expected-mailing-date>2011-09-01</expected-mailing-date>
<delivery-spec>
<service-code>DOM.EP</service-code>
<sender>
<name>Bob</name>
<company>CGI</company>
<address-details>
<address-line-1>502 MAIN ST N</address-line-1>
<city>MONTREAL</city>
<prov-state>QC</prov-state>
<country-code>CA</country-code>
<postal-zip-code>H2B1A0</postal-zip-code>
</address-details>
</sender>
<destination>
<name>Jain</name>
<company>CGI</company>
<address-details>
<address-line-1>23 jardin private</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>20.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>john.doe@yahoo.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>0001234567</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>