Expédition avec convention

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

Obtenir l'information sur les clients – Module REST

Résumé

Nom :	Obtenir l'information sur les clients
Raison pour utiliser le service :	Pour récupérer les détails liés aux payeurs autorisés, aux modes de paiement et aux autres renseignements sur les clients afin de déterminer le numéro de client pertinent aux fins de facturation des frais d'expédition
Données d'entrée :	Numéro de client pour lequel l'information est demandée
Données de sortie :	Numéros de convention, payeurs autorisés, modes de paiement permis et liens vers d'autres clients (Expédié au nom de) précédents (le cas échéant)
Exemples d'erreurs :	Numéro de client invalide
Prochaines demandes de service possibles :	Obtenir l'information sur les clients « Expédié au nom de » ou Créer l'envoi
Historique des versions :	Notes de mise à jour

Aperçu du service Obtenir l'information sur les clients

Obtenir l'information sur les clients – Résumé du service

Le service Obtenir l'information sur les clients fournit des renseignements indiquant si un compte client peut être utilisé pour facturer les frais d'expédition.

Détails sur la demande

Structure de la demande pour obtenir l'information sur les clients

Point final

GET https://XX/rs/customer/{Client « Expédié par »}
Remplacez...	Par...
XX (développement)	ct.soa-gw.canadapost.ca
XX (production)	soa-gw.canadapost.ca
{Client « Expédié par »}	votre numéro de client

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	application/vnd.cpc.customer+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 l'information sur les clients.

Détails de la réponse

Réponse – Éléments

Il s'agit de la structure de réponse à une demande de renseignements sur un client pour un numéro de client « Expédié par » donné.

Obtenir l'information sur les clients – REST – Aperçu détaillé des éléments de réponse
Nom du champ	Type	Renseignements dans le champ
customer	Complexe	Élément du niveau supérieur de la structure XML
customer-number	Simple	Client « Expédié par » (Maximum de 10 caractères numériques)
contracts	Complexe	Il s'agit d'une structure renfermant les contrats dont le client est titulaire ou ceux qu'il est autorisé à utiliser. Seuls les contrats en vigueur à compter de la date de la demande sont énumérés.
contract-id	Simple	Numéro de contrat (également appelé numéro de convention) (10 caractères numériques)
authorized-payers	Complexe	Structure contenant les modes de paiement et les numéros de payeurs autorisés
payer	Complexe	Fait partie des authorized-payers.
payer-number	Simple	Numéro de client d'un payeur pouvant être utilisé pour le client « Expédié par » (lorsque les numéros « Expédié par » et « Expédié au nom de » sont les mêmes) (10 caractères numériques)
methods-of-payment	Complexe	Structure contenant les modes de paiement pouvant être utilisés par ce payeur
method-of-payment	Simple	Il peut contenir : account Nota : Si un payeur n'a aucun mode de paiement, il ne peut pas effectuer l'expédition en ce moment. Fait partie des methods-of-payment. `{Chaîne de 10 caractères}`
links	Complexe	Fait partie de customer. Structure contenant des liens vers les combinaisons de contrats et de clients « Expédié au nom de » utilisées précédemment par le client « Expédié par » (client précisé dans la demande). Le client « Expédié par » (numéro du client présentant la demande de service) est exclus de ces liens (p. ex. aucun lien « self »). Si un numéro de client utilisé précédemment est maintenant fermé ou bloqué, il ne fera pas partie de la liste.
link	Simple	Occurrence (1 à N fois) Structure de liens contenant de nombreux éléments de liens, chacun permettant à l'utilisateur de récupérer séparément le profil d'un différent client « Expédié au nom de » Fait partie des links. `rel="behalf-of-customer"` pour ces liens. Consultez la section Points finaux fournis pour obtenir de plus amples renseignements.

Messages d'erreur possibles

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

Obtenir l'information sur les clients (Expédié par) – Diagramme XML

Voir l'image en taille réelle

Exemples

Exemple de demande REST


  GET https://XX/rs/customer/1234567 

    Accept:application/vnd.cpc.customer+xml

    Authorization:s7HD7gwsennesc==

    Accept-Language:fr-ca

Exemple de réponse XML


  
  
 <customer>

     <customer-number>0001234567</customer-number>

      <contracts>

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

      
      </contracts>

      <authorized-payers>

       <payer>

         <payer-number>0001234567</payer-number>

          <methods-of-payment>

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

            
          
          </methods-of-payment>

        
        </payer>

      
      </authorized-payers>

      <links>

       <link rel="behalf-of-customer" href="https://XX/rs/customer/022222222/behalfof/33333333" media-type="application/vnd.cpc.customer+xml"></link>

        <link rel="behalf-of-customer" href="https://XX/rs/customer/22222222/behalfof/33333333" media-type="application/vnd.cpc.customer+xml"></link>

      
      </links>

    
    </customer>

Ouvrir unesession

Ressources