UPS (préversion)
United Parcel Service (UPS) fournit aux clients et aux entreprises du monde entier un vaste portefeuille de services de transport, de commerce électronique et d’affaires. Connectez-vous aux API UPS pour valider l’adresse, les emplacements de recherche, créer l’expédition, effectuer le suivi des expéditions, etc.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | Classe | Régions |
|---|---|---|
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - régions de chine Azure - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Microsoft Dynamics |
| URL | https://aka.ms/iomsupport |
| Courrier électronique | iomdri@microsoft.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Microsoft |
| Website | https://www.ups.com/us/en/services/technology-integration.page |
| Politique de confidentialité | https://www.ups.com/us/en/help-center/legal-terms-conditions/privacy-notice.page |
| Catégories | Productivité |
Le connecteur UPS (United Parcel Service) a été spécifiquement développé pour être utilisé pour l’intégration des fournisseurs de Dynamics 365 Intelligent Order Management.
Prerequisites
- Inscrivez-vous au profil UPS.com à partir de https://www.ups.com/upsdeveloperkit?loc=en_US.
Comment obtenir des informations d’identification
- Accès https://www.ups.com/upsdeveloperkit?loc=en_US.
- Connectez-vous pour vous connecter à votre compte.
- Utilisez « Demander une clé d’accès » pour générer la clé d’accès.
- UPS.Com nom d’utilisateur, mot de passe et clé d’accès généré seront les informations d’identification requises.
Prise en main de votre connecteur
Suivez https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider pour activer le fournisseur UPS.
Problèmes connus et limitations
Ce connecteur a été spécifiquement développé pour être utilisé pour l’intégration du fournisseur UPS de Dynamics 365 Intelligent Order Management. La prise en charge des cas d’usage en dehors de Dynamics 365 Intelligent Order Management sera limitée.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Description | Obligatoire |
|---|---|---|---|
| Environnement : bac à sable ou production | ficelle | Environnement de bac à sable UPS ou environnement de production | Vrai |
| Clé d’accès | securestring | Clé d’accès obtenue via le processus d’intégration UPS | Vrai |
| Nom d’utilisateur | ficelle | Nom d’utilisateur de votre compte MyUPS | Vrai |
| Mot de passe | securestring | Mot de passe de votre compte MyUPS | Vrai |
| Transaction Source | ficelle | Identifie les clients/l’application source qui appelle | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Annuler l’expédition |
L’API Annuler l’expédition est utilisée pour annuler l’expédition planifiée précédemment. |
| Créer une expédition |
Créer une API d’expédition offre à l’application de nombreuses façons de gérer l’expédition de packages vers leur destination. |
| Locator |
L’API localisateur fournit des emplacements upS en libre-service et en libre-service, des heures d’opération et des heures de prise en charge. |
| Niveau de rue de validation d’adresse |
L’API Validation Street Level d’adresse peut être utilisée pour vérifier les adresses par rapport à la base de données du service postal des États-Unis d’adresses valides aux États-Unis et à Porto Rico. |
| Suivi |
L’API de suivi prend en charge les expéditions de colis, de fret terrestre et de fret aérien. |
Annuler l’expédition
L’API Annuler l’expédition est utilisée pour annuler l’expédition planifiée précédemment.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro d’identification de l’expédition
|
shipmentidentificationnumber | True | string |
Numéro d’identification de l’expédition. |
|
Numéro de suivi
|
trackingnumber | string |
Numéro de suivi du package. |
|
|
ID transaction
|
transid | True | string |
Identificateur unique à la requête. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Code informatique
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
Identifie la réussite ou l’échec de la transaction. |
|
Description
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
Décrit le code d’état de la réponse. Retourne le texte success. |
|
CustomerContext
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
Données fournies par le client. Peut être XML. Si ces données sont présentes dans la demande, elles sont renvoyées au client. |
|
TransactionIdentifier
|
VoidShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Identificateur unique à la requête. |
|
Code informatique
|
VoidShipmentResponse.SummaryResult.Status.Code | string |
Code pour l’état du résultat du résumé. |
|
Description
|
VoidShipmentResponse.SummaryResult.Status.Description | string |
Description de l’état du résultat du résumé. |
|
Code informatique
|
VoidShipmentResponse.PackageLevelResult.Status.Code | string |
Code pour l’état du résultat du résumé. |
|
Description
|
VoidShipmentResponse.PackageLevelResult.Status.Description | string |
Description de l’état du résultat du résumé. |
|
TrackingNumber
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
Numéro d’identification du package. |
Créer une expédition
Créer une API d’expédition offre à l’application de nombreuses façons de gérer l’expédition de packages vers leur destination.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID transaction
|
transid | True | string |
Identificateur unique à la requête. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Code informatique
|
ShipmentResponse.Response.ResponseStatus.Code | string |
Identifie la réussite ou l’échec de la transaction. |
|
Description
|
ShipmentResponse.Response.ResponseStatus.Description | string |
Décrit le code d’état de la réponse. Retourne le texte success. |
|
Alerte
|
ShipmentResponse.Response.Alert | ||
|
CustomerContext
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
Données fournies par le client. Peut être XML. Si ces données sont présentes dans la demande, elles sont renvoyées au client. |
|
TransactionIdentifier
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Identificateur unique à la requête. |
|
Clause d’exclusion de responsabilité
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
Type de code monétaire BaseServiceCharge. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
Montant de la valeur des frais de service de base. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
Type de code monétaire des frais de transport. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
Montant de la valeur du transport et des surcharges. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
Type de code monétaire des frais accessorials. Le code monétaire utilisé dans la demande d’expédition est retourné. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
Montant de la valeur des frais d’accès. |
|
TaxCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
Nombre total de frais de type de code monétaire. Le code monétaire utilisé dans la demande d’expédition est retourné. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
Montant total des frais. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
Type de code monétaire TotalChargesWithTaxes. Le code monétaire utilisé dans la demande d’expédition est retourné. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
Montant de la valeur monétaire TotalChargesWithTaxes. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
TaxCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
Code monétaire total des frais. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
Valeur monétaire totale des frais. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
Type de code monétaire TotalChargesWithTaxes. Le code monétaire utilisé dans la demande d’expédition est retourné. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
Montant de la valeur monétaire TotalChargesWithTaxes. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
Code monétaire des frais bruts. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
Valeur monétaire des frais bruts. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
Code monétaire de montant de remise. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
Valeur monétaire du montant de remise. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
Code monétaire Net Charge. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
Valeur monétaire des frais nets. |
|
Densité
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
La densité est retournée si l’expéditeur est éligible au taux basé sur la densité. |
|
TotalCubicFeet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
Le total des pieds cubes est retourné si l’expéditeur est éligible au taux basé sur la densité. |
|
HandlingUnits
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
RatingMethod
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
RatingMethod indique si l’expédition a été évaluée comme niveau d’expédition ou de package. Ces informations ne seront retournées que si RatingMethodRequestedIndicator est présent dans la demande. Valeurs valides : 01 = Niveau d’expédition 02 = Niveau du package. |
|
BillableWeightCalculationMethod
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
BillableWeightCalculationMethod indique si la méthode de calcul de poids facturable utilisée était : le niveau de package ou le niveau d’expédition. Ces informations ne seront retournées que si RatingMethodRequestedIndicator est présent dans la demande. |
|
Code informatique
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
Code des unités de mesure de poids de facturation. Les valeurs sont : KGS ou LBS. |
|
Description
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Description | string |
Description des unités de mesure de poids de facturation. |
|
Poids
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
Poids de facturation. Plus élevé du poids réel de l’expédition par rapport au poids dimensionnel de l’expédition. |
|
ShipmentIdentificationNumber
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
Numéro d’ID d’expédition UPS retourné.1Z Numéro du premier colis dans l’expédition. |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
MIDualReturnShipmentKey est une clé unique nécessaire pour traiter l’expédition double retour mail Innovations. |
|
ExpéditionDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
Les paramètres d’expédition encodés doivent être passés dans la phase d’acceptation. Applicable uniquement pour ShipConfirmResponse. |
|
PackageResults
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
Code informatique
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Code | string |
Code pour le type d’image graphique pour le rapport à valeur élevée. |
|
Description
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Description | string |
Description du code de format. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Image html encodée en base 64, EPL2, ZPL ou SPL. Applicable uniquement pour ShipResponse et ShipAcceptResponse. |
|
Code informatique
|
ShipmentResponse.ShipmentResults.Form.Code | string |
Code qui indique le type de formulaire. Applicable uniquement pour ShipResponse et ShipAcceptResponse. Valeurs valides : 01 - Tous les formulaires internationaux demandés. |
|
Description
|
ShipmentResponse.ShipmentResults.Form.Description | string |
Description qui indique le type de formulaire. Valeurs possibles. Tous les formulaires internationaux demandés. Applicable uniquement pour ShipResponse et ShipAcceptResponse. |
|
Code informatique
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
Code représentant le format dans lequel les formulaires sont générés. Applicable uniquement pour ShipResponse et ShipAcceptResponse. Valeur valide : PDF = pdf uniquement. |
|
Description
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
Description du code de format d’image de formulaire. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Image de formulaires 64 encodées internationales en base. Applicable uniquement pour ShipResponse et ShipAcceptResponse. |
|
FormGroupId
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
ID unique pour la récupération ultérieure de la version enregistrée des formulaires internationaux terminés. Toujours retourné lorsque le code = 01. 01 représente les formulaires internationaux. Applicable uniquement pour ShipResponse et ShipAcceptResponse. |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
Contient le texte de description qui identifie le groupe de formulaires internationaux. Cet élément fait partie de la demande et de la réponse. Cet élément n’apparaît pas dans les formulaires. Applicable uniquement pour ShipResponse et ShipAcceptResponse. |
|
Code informatique
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
Mettre en forme le code de la page de tour en cod générée. Valeurs valides : HTML = format HTML. Seul le format HTML est pris en charge pour cod Turn In Page. Applicable uniquement pour ShipResponse et ShipAcceptResponse. |
|
Description
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
Description du code de format de la page de tour de cod générée. Applicable uniquement pour ShipResponse et ShipAcceptResponse. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Logiciel de rendu d’image html codé en base 64. Applicable uniquement pour ShipResponse et ShipAcceptResponse. |
|
Code informatique
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
Code représentant le format dans lequel le rapport à valeur élevée est généré. Valeurs valides : PDF = pdf. |
|
Description
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Description | string |
Description du format d’image. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Image PDF encodée en base 64. |
|
LabelURL
|
ShipmentResponse.ShipmentResults.LabelURL | string |
L’URL pointe vers une page où les instructions d’étiquette, de reçu et d’autres documents, le cas échéant, telles que HighValueReport, CustomsInvoice et ImportControl, peuvent être demandées. LabelURL est retourné uniquement si l’étiquette LabelLinksIndicator est demandée pour les expéditions suivantes : expédition Print/Electronic ImportControl, Print/Electronic, Retour d’expédition, Envoi avant, à l’exception de Mail Innovations Forward. |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
L’URL pointe vers une page où les instructions d’étiquette, de reçu et d’autres documents, le cas échéant, telles que HighValueReport, CustomsInvoice et ImportControl, peuvent être demandées. LocalLanguageLabelURL est retourné uniquement si l’étiquette LabelLinksIndicator est demandée pour les expéditions suivantes : Expédition Print/Electronic ImportControl, Expédition Print/Electronic Return, Envoi avant, à l’exception de Mail Innovations Forward, Not retourné si LabelLinksIndicator est demandé avec l’élément Locale. |
|
ReceiptURL
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
L’URL pointe vers une page où les instructions d’étiquette, de reçu et d’autres documents, le cas échéant, telles que HighValueReport, CustomsInvoice et ImportControl, peuvent être demandées. ReceiptURL est retourné uniquement si l’expéditeur LabelLinksIndicator est demandé pour les expéditions suivantes : expédition Print/Electronic ImportControl, Expédition Print/Electronic Return. |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
L’URL pointe vers une page où les instructions d’étiquette, de reçu et d’autres documents, le cas échéant, telles que HighValueReport, CustomsInvoice et ImportControl, peuvent être demandées. LocalLanguageReceiptURL est retourné uniquement si l’indicateur LabelLinksIndicator est demandé pour les expéditions suivantes : expédition Print/Electronic ImportControl, Expédition Print/Electronic Return, Transfert d’expédition à l’exception de Mail Innovations Forward, Not return if LabelLinksIndicator is requested with Locale element. |
|
DGPaperImage
|
ShipmentResponse.ShipmentResults.DGPaperImage | string |
Image dangrous Good Paper au format pdf. Un document PDF à plusieurs pages sera retourné qui contiendra toutes les copies de papier d’expédition de marchandises Dangrous requises pour tous les paquets de marchandises dangereuses. Retourné uniquement lorsque DGSignatoryInfo est présent. |
|
MasterCartonID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
ID de carton principal. MasterCartonID est retourné si MasterCartonIndicator est présent dans la requête. |
Locator
L’API localisateur fournit des emplacements upS en libre-service et en libre-service, des heures d’opération et des heures de prise en charge.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
CustomerContext
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
Données fournies par le client. Peut être XML. Si ces données sont présentes dans la demande, elles sont renvoyées au client. |
|
XpciVersion
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
Identifie la version du message. |
|
ResponseStatusCode
|
LocatorResponse.Response.ResponseStatusCode | string |
Identifie la réussite ou l’échec de l’échange. |
|
ResponseStatusDescription
|
LocatorResponse.Response.ResponseStatusDescription | string |
Décrit le code d’état de la réponse. |
|
ErrorSeverity
|
LocatorResponse.Response.Error.ErrorSeverity | string |
Décrit la gravité de l’erreur. |
|
ErrorCode
|
LocatorResponse.Response.Error.ErrorCode | string |
Valeur numérique qui décrit l’erreur. |
|
Description de l'erreur
|
LocatorResponse.Response.Error.ErrorDescription | string |
Décrit le code d’erreur. |
|
MinimumRetrySeconds
|
LocatorResponse.Response.Error.MinimumRetrySeconds | string |
Nombre de secondes à attendre jusqu’à la nouvelle tentative. |
|
ErrorLocationElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
Nom Xpath de l’élément en erreur. Il s’agit d’un Xpath valide pointant vers un élément dans le document de requête. |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
Nom de l’attribut en erreur. Il s’agit du nom de l’attribut contenu par l’élément Error Location. |
|
ErrorDigest
|
LocatorResponse.Response.Error.ErrorDigest | string |
Contenu de l’élément en erreur. |
|
Latitude
|
LocatorResponse.Geocode.Latitude | string |
Latitude de l’adresse d’origine, point central de l’échange, point central du code postal ou point central de la ville. |
|
Longitude
|
LocatorResponse.Geocode.Longitude | string |
Longitude de l’adresse d’origine, point central de l’échange, point central du code postal ou point central de la ville. |
|
GeocodeCandidate
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
Clause d’exclusion de responsabilité
|
LocatorResponse.SearchResults.Disclaimer | string |
Exclusion de responsabilité. Si l’utilisateur a demandé des types de services terrestres et aériens et que la taille maximale de la liste des emplacements UPS n’a pas été remplie, la liste des emplacements continuera avec les emplacements qui fournissent la terre ou l’air dans le rayon de recherche. |
|
DropLocation
|
LocatorResponse.SearchResults.DropLocation | ||
|
Numéro
|
LocatorResponse.SearchResults.MapNavigation.Number | string |
Numéro central de l’emplacement de dépôt s’il s’agit du magasin UPS. |
|
Hauteur
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Height | string |
La valeur fournie dans la requête est retournée, sinon la largeur par défaut de l’image re-tournée est définie sur 200 pixels. Les autres valeurs valides sont comprises entre 100 et 400. |
|
Largeur
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Width | string |
La valeur fournie dans la requête est retournée, sinon la largeur par défaut de l’image re-tournée est définie sur 200 pixels. Les autres valeurs valides sont comprises entre 100 et 400. |
|
ZoomFactor
|
LocatorResponse.SearchResults.MapNavigation.ZoomFactor | string |
Le facteur que l’image doit être pour afficher tous les emplacements UPS. |
|
Panoramique
|
LocatorResponse.SearchResults.MapNavigation.PanX | string |
Niveau auquel l’utilisateur souhaite faire panoramique sur l’axe X. Jamais retourné. Après la réponse initiale, l’utilisateur peut souhaiter afficher l’image plus à gauche ou à droite. Pour ce faire, une autre requête est requise avec la valeur 1, 0 ou 1. |
|
Pany
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
Niveau auquel l’utilisateur souhaite faire défiler l’axe Y. La requête initiale la valeur par défaut est 0. Après la réponse initiale, l’utilisateur peut souhaiter afficher l’image plus haut ou vers le bas de l’axe y. Pour ce faire, une autre requête est requise avec la valeur 1, 0 ou 1. |
|
MapID
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
Une liste de 5 ID d’emplacement sont chiffrés dans mapID pour la génération de carte. |
|
MapURL
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
Lien vers la carte avec les cinq emplacements UPS et l’emplacement d’origine spécifié dans mapID. |
|
LocationID
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
ID d’emplacement d’un emplacement UPS particulier. |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
Coordonnée X de l’emplacement UPS. |
|
YCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.YCoordinate | string |
Coordonnée Y de l’emplacement UPS. |
|
Segment
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Segment | string |
Instructions pas à pas de l’emplacement d’origine vers l’emplacement spécifié. |
|
Valeur
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.Value | string |
Distance calculée entre l’origine et l’emplacement UPS. |
|
Code informatique
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Code | string |
Unité de distance du code de mesure. L’unité de mesure utilisée dans la requête de recherche est retournée. Les valeurs retournées sont les suivantes : MI-Miles. |
|
Description
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Description | string |
Peut retourner la description de l’unité de mesure spécifiée dans la requête. Les valeurs valides sont les suivantes : Miles et Kilomètres. |
|
Heure
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Time | string |
La période estimée totale nécessaire pour conduire de l’origine à l’emplacement. |
|
Valeur
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.Value | string |
Distance droite entre l’origine et l’emplacement UPS. |
|
Code informatique
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Code | string |
Unité de distance du code de mesure. L’unité de mesure utilisée dans la requête de recherche est retournée. Les valeurs retournées sont les suivantes : MI-Miles. |
|
Description
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
Peut retourner la description de l’unité de mesure spécifiée dans la requête. Les valeurs valides sont les suivantes : Miles et Kilomètres. |
|
temps_total
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
La période estimée totale nécessaire pour conduire de l’origine à l’emplacement. Format : HHMM. |
|
AvailableLocationAttributes
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
ActiveAvailableAccessPointIndicator
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
Indique si le pays ou le territoire a AccessPoints ou non. |
|
AllowAllConfidenceLevels
|
LocatorResponse.AllowAllConfidenceLevels | string |
Indicateur permettant d’autoriser le niveau de confiance dans la recherche. |
Niveau de rue de validation d’adresse
L’API Validation Street Level d’adresse peut être utilisée pour vérifier les adresses par rapport à la base de données du service postal des États-Unis d’adresses valides aux États-Unis et à Porto Rico.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Option de requête
|
requestoption | True | integer |
Option de demande de demande de demande de validation d’adresse. |
|
Indicateur de demande régionale
|
regionalrequestIndicator | string |
Indicateur de demande régionale de la demande de validation d’adresse. |
|
|
Taille maximale de la liste candidate
|
maximumcandidatelistsize | integer |
Taille maximale de la liste candidate de la demande de validation d’adresse. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Code informatique
|
XAVResponse.Response.ResponseStatus.Code | string |
Code d’avertissement retourné par le système. |
|
Description
|
XAVResponse.Response.ResponseStatus.Description | string |
Message retourné par le système. |
|
ValidAddressIndicator
|
XAVResponse.ValidAddressIndicator | string |
La requête a trouvé une correspondance valide. |
|
AmbiguAddressIndicator
|
XAVResponse.AmbiguousAddressIndicator | string |
Indique que la requête n’a pas pu trouver de correspondance en fonction des informations fournies. |
|
NoCandidatesIndicator
|
XAVResponse.NoCandidatesIndicator | string |
Aucun candidat trouvé. |
|
Code informatique
|
XAVResponse.AddressClassification.Code | string |
Contient le code de classification de l’adresse d’entrée. |
|
Description
|
XAVResponse.AddressClassification.Description | string |
Contient la description textuelle du code de classification d’adresse. |
|
Candidat
|
XAVResponse.Candidate |
Suivi
L’API de suivi prend en charge les expéditions de colis, de fret terrestre et de fret aérien.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro d’enquête
|
inquiryNumber | True | string |
Numéro d’enquête utilisé pour accéder aux informations de suivi UPS. |
|
ID transaction
|
transid | True | string |
Identificateur unique à la requête. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Expédition
|
trackResponse.shipment | array of object |
Élément qui contient les détails de l’expédition associés aux numéros d’enquête. |
|
paquet
|
trackResponse.shipment.package | array of object |
Élément qui contient les détails du package. |
|
numéro de suivi
|
trackResponse.shipment.package.trackingNumber | string |
Le petit paquet, les innovations de courrier, le fret ou le numéro de suivi de la nuit. |
|
deliveryDate
|
trackResponse.shipment.package.deliveryDate | ||
|
type
|
trackResponse.shipment.package.deliveryTime.type | string |
Indique le type de remise. |
|
startTime
|
trackResponse.shipment.package.deliveryTime.startTime | string |
Heure de début, heure validée ou heure de remise. |
|
EndTime
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
Heure de fin de la fenêtre. |
|
activité
|
trackResponse.shipment.package.activity | array of object |
Élément conteneur contenant l’activité d’analyse associée au numéro d’interrogation. |
|
location
|
trackResponse.shipment.package.activity.location | ||
|
type
|
trackResponse.shipment.package.activity.status.type | string |
Type d’activité. |
|
descriptif
|
trackResponse.shipment.package.activity.status.description | string |
Description de l’état. |
|
code
|
trackResponse.shipment.package.activity.status.code | string |
Code d’état. |
|
date
|
trackResponse.shipment.package.activity.date | string |
Date de l’activité. |
|
temps
|
trackResponse.shipment.package.activity.time | string |
Heure de l’activité. |