Expédition avec convention

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

Obtenir le manifeste – Module REST

Résumé

Nom :

Obtenir le manifeste

Raison pour utiliser
le service :
  • Une demande de service obligatoire qui doit être présentée pour créer un manifeste. Vous avez besoin d'une réponse positive de la demande de service « Obtenir le manifeste » pour confirmer qu'un manifeste a été créé avec succès. La réponse comprendra un lien vous permettant de récupérer l'étiquette du manifeste par l'entremise d'une demande de service « Obtenir l'artefact ».
  • Elle est également utilisée pour récupérer le numéro de bon de commande afin de l'utiliser pour annuler un manifeste.
Données d'entrée :

Il faut utiliser le lien ou les liens associés au service Transmettre les envois lorsque rel="manifest".

Données de sortie :

Les renseignements suivants sont présentés pour le manifeste déterminé.

  • Le numéro de bon de commande du manifeste.
  • Un lien pour récupérer la copie papier du manifeste (rel="artifact").
  • Un lien pour obtenir les détails du manifeste (rel="details").
  • Un lien vers les liens de tous les envois contenus dans le manifeste. (rel="manifestShipments")
  • Un lien pour récupérer de nouveau ces données de sortie (rel="self").
Exemple d'erreur :

404 – Introuvable

Demande de service précédente habituelle :

Transmettre les envois ou Obtenir les manifestes

Prochaine demande de service habituelle :

Obtenir l'artefact, Obtenir les détails du manifeste

Historique des versions :

Notes de mise à jour

Obtenir le manifeste – Résumé du service

Obtenir le manifeste – Résumé du service

Détails sur la demande

Structure de la demande pour obtenir le manifeste

Point final

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

En-têtes HTTP

Variable des en-têtes HTTP

Valeur

Accept

application/vnd.cpc.manifest-v8+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

Éléments de la demande

Les données d'entrée XML ne sont pas nécessaires pour le service Obtenir le manifeste.

Détails de la réponse

Réponse – Éléments

Le tableau suivant décrit les champs XML dans la réponse.

Pour obtenir un aperçu détaillé de la hiérarchie de la réponse, consultez le diagramme ci-dessous.

Obtenir le manifeste – Aperçu détaillé des éléments de réponse
Nom de l'élément Type Description

manifest

Complexe

Niveau supérieur de la structure

customer-request-id

Simple

Pour utilisation future.

po-number

Simple

(Chaîne alphanumérique – Jusqu'à 10 lettres/chiffres)

Fait partie de manifest.

Il s’agit du numéro de bon de commande associé au manifeste, sauf dans le cas des manifestes vides, qui sont toujours réglés à « EMPTY ». (Consultez la page Transmettre les envois pour obtenir plus de détails.)

links

Complexe

Fait partie de manifest.

Cette structure comprend les liens vers les artefacts et les détails du manifeste déterminé.

link

Complexe

Fait partie de manifest-links.

Occurrence (1 à N fois). Toutefois, à l'heure actuelle, il y a quatre liens :

  1. rel="self"
  2. rel="artifact"
  3. rel="details"
  4. rel="manifestShipments"

Chaque lien vous permet de récupérer différents renseignements sur le manifeste.

Pour obtenir une description des attributs des liens, consultez la section Points finaux fournis.

  1. rel="self"

    Cela représente une répétition de la demande de service Obtenir le manifeste initial utilisé pour obtenir cette liste de liens. On peut le garder pour plus tard.

  2. rel = "artifact"

    Ce lien affichera un fichier PDF à imprimer pour permettre le ramassage ou le dépôt des envois physiques associés. Voir Obtenir l'artefact.

  3. rel = "details"

    Ce lien fournit des détails qui se trouvent dans le manifeste papier, notamment le sommaire des envois et le coût total du manifeste. Voir Obtenir les détails du manifeste.

    Remarque : Ce lien ne serait pas retourné pour un manifeste vide (consultez la page Transmettre les envois pour obtenir plus de détails).

  4. rel – "manifestShipments"

    Ce lien fournira des liens vers chaque envoi inclus dans le manifeste. Voir Obtenir les envois.

    Remarque : Ce lien ne serait pas retourné pour un manifeste vide (consultez la page Transmettre les envois pour obtenir plus de détails).

(Nota : Le lien de l'élément XML est « Complexe », car il contient de nombreux attributs. L'élément de lien ne comprend pas de sous-éléments.)

Réponse – Diagramme XML

Nota : L'attribut « index » de l'élément du lien dans l'image ci-dessous n'est pas utilisé dans le service Obtenir le manifeste.

Réponse – Diagramme XML

Réponse – Réponses d'erreur possibles

Consultez la section Codes de statut HTTP pour obtenir des renseignements généraux concernant le traitement des erreurs.

Les messages d'erreur possibles de type « 400 » pour ce service sont les suivants :

Code Message
1182 La transaction a été refusée. Veuillez sélectionner une autre carte de crédit ou une autre méthode de paiement et retransmettre la commande.
1185 La transaction a été refusée. Veuillez sélectionner un autre compte ou une autre méthode de paiement et retransmettre la commande.
1653 La méthode de paiement Porte au Compte n’est pas disponible. Veuillez choisir une autre méthode de paiement.
9153 Le processus de transmission n’est pas encore complété. Veuillez essayer de nouveau.
9155

Une erreur système est survenue. Veuillez essayer de nouveau plus tard. Si le problème persiste, contactez la ligne d’assistance de la SCP.

* Vous recevrez cette erreur si vous essayez d’utiliser le service Obtenir le manifeste (numéro d’identification de l’artefact) alors que la dernière tentative de Transmettre les envois a échoué.

Les envois sont accompagnés d’un manifeste en différé; par conséquent, l’erreur est renvoyée à la demande suivante.

L’absence d’une carte de crédit par défaut est la cause courante d’un échec de transmission.

Exemples

Exemple de demande REST – Obtenir le manifeste

GET https://XX/rs/1234567/1234567/manifest/123456789012345678
Accept:application/vnd.cpc.manifest-v8+xml
Authorization:Basic s7HD7gwsennesc==

Exemple de réponse XML – Obtenir le manifeste

<manifest>
<po-number>D906367941</po-number>
<links>
<link rel="self" href="https://XX/rs/111111111/222222222/manifest/33333333" media-type="application/vnd.cpc.manifest-v8+xml"></link>
<link rel="details" href="https://XX/rs/111111111/222222222/manifest/666666666/details" media-type="application/vnd.cpc.manifest-v8+xml"></link>
</links>
</manifest>