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 SOAP

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

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

Détails sur la demande

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

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 l'information sur les clients – Éléments de la demande
Nom de l'élément Type Requis/Optionnel Description

get-customer-information-request

complexe

requis

Élément XML de niveau supérieur de la structure de la réponse.

customer-number

simple

requis

(1 à 10 caractères numériques)

Il s'agit du numéro de client à 10 chiffres du client « Expédié par ».

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

Demande – Diagramme XML

Obtenir l'information sur les clients – Structure de la demande XML

Obtenir l'information sur les clients – 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 de l'information sur les clients. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir l'information sur les clients – Éléments de la réponse
Nom du champ Type Description

get-customer-information-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'un message d'erreur.

customer

Complexe

Contient toute l'information demandée sur les clients.

customer-number

Simple

Numéro du client « Expédié par ».

contracts

Complexe

Contient 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).

authorized-payers

Complexe

Contient les modes de paiement et les numéros de payeurs autorisés.

payer

Complexe

Numéro de client d'un payeur autorisé.

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

methods-of-payment

Complexe

Structure contenant les modes de paiement pouvant être utilisés par ce payeur.

method-of-payment

Simple

Peut contenir les éléments suivants :

  • Account
  • CreditCard

Nota : Si un payeur n'a aucun mode de paiement, il ne peut pas effectuer l'expédition.

mobos

Complexe

Contient l'information sur les clients « Expédié au nom de » associés au numéro de client demandé.

mobo

Simple

Numéro d'un client « Expédié au nom de » précis.

Réponse – Diagramme XML

Obtenir l'information sur les clients – Structure de la réponse XML
Obtenir l'information sur les clients – Structure de la réponse XML

Réponse – Réponses d'erreur possibles

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 l'information sur les clients

<get-customer-information-request>
<customer-number>1111111</customer-number>
</get-customer-information-request>

Exemple de réponse XML selon le module SOAP – Obtenir l'information sur les clients

<get-customer-information-response>
<customer>
<customer-number>0001111111</customer-number>
<contracts>
<contract-id>0012345678</contract-id>
</contracts>
<authorized-payers>
<payer>
<payer-number>0001111111</payer-number>
<methods-of-payment>
<method-of-payment>account</method-of-payment>
<method-of-payment>creditCard</method-of-payment>
</methods-of-payment>
</payer>
</authorized-payers>
</customer>
</get-customer-information-response>