UPS (versión preliminar)
United Parcel Service (UPS) proporciona a los clientes y empresas de todo el mundo una amplia cartera de servicios de transporte, comercio electrónico y negocios. Conéctese a las API de UPS para validar la dirección, las ubicaciones de búsqueda, crear envíos, realizar un seguimiento de los envíos, etc.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Microsoft Dynamics |
| URL | https://aka.ms/iomsupport |
| Correo electrónico | iomdri@microsoft.com |
| Metadatos del conector | |
|---|---|
| Publicador | Microsoft |
| Sitio web | https://www.ups.com/us/en/services/technology-integration.page |
| Directiva de privacidad | https://www.ups.com/us/en/help-center/legal-terms-conditions/privacy-notice.page |
| Categorías | Productividad |
El conector united Parcel Service (UPS) se ha desarrollado específicamente para su uso para la integración del proveedor de Dynamics 365 Intelligent Order Management.
Prerrequisitos
- Regístrese para obtener UPS.com perfil desde https://www.ups.com/upsdeveloperkit?loc=en_US.
Obtención de credenciales
- Acceda a https://www.ups.com/upsdeveloperkit?loc=en_US.
- Inicie sesión para conectarse a su cuenta.
- Use "Solicitar una clave de acceso" para generar la clave de acceso.
- UPS.Com nombre de usuario, contraseña y clave de acceso generada serán las credenciales necesarias.
Introducción al conector
Siga https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider para habilitar el proveedor de UPS.
Problemas y limitaciones conocidos
Este conector se ha desarrollado específicamente para su uso en la integración del proveedor UPS de Dynamics 365 Intelligent Order Management. La compatibilidad con casos de uso fuera de Dynamics 365 Intelligent Order Management se limitará.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| Entorno: espacio aislado o producción | cuerda / cadena | Entorno de espacio aislado de UPS o entorno de producción | Cierto |
| Clave de acceso | securestring | Clave de acceso obtenida a través del proceso de incorporación de UPS | Cierto |
| Nombre de usuario | cuerda / cadena | Nombre de usuario de la cuenta myUPS | Cierto |
| Contraseña | securestring | Contraseña de la cuenta de MyUPS | Cierto |
| Origen de la transacción | cuerda / cadena | Identifica los clientes o la aplicación de origen que llama a . | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Cancelar envío |
Cancel Shipment API se usa para cancelar el envío programado previamente. |
| Crear envío |
Create Shipment API ofrece a la aplicación muchas maneras de administrar el envío de paquetes a su destino. |
| Localizador |
La API de localizador proporciona ubicaciones de autoservicio y servicio completo de UPS, horas de operación y recogida. |
| Nivel de calle de validación de direcciones |
La API de nivel de calle de validación de direcciones se puede usar para comprobar las direcciones en la base de datos del Servicio Postal de Estados Unidos de direcciones válidas en Estados Unidos y Puerto Rico. |
| Seguimiento |
La API de seguimiento admite envíos de paquete, carga terrestre y flete aéreo. |
Cancelar envío
Cancel Shipment API se usa para cancelar el envío programado previamente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Número de identificación del envío
|
shipmentidentificationnumber | True | string |
Número de identificación del envío. |
|
Número de seguimiento
|
trackingnumber | string |
Número de seguimiento del paquete. |
|
|
Id. de transacción
|
transid | True | string |
Identificador único de la solicitud. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
Identifica el éxito o el error de la transacción. |
|
Descripción
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
Describe el código de estado de respuesta. Devuelve el texto correcto. |
|
CustomerContext
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
Datos proporcionados por el cliente. Puede ser XML. Si estos datos están presentes en la solicitud, se devuelve al cliente. |
|
TransactionIdentifier
|
VoidShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Identificador único de la solicitud. |
|
Código
|
VoidShipmentResponse.SummaryResult.Status.Code | string |
Código para el estado del resultado de resumen. |
|
Descripción
|
VoidShipmentResponse.SummaryResult.Status.Description | string |
Descripción del estado del resultado de resumen. |
|
Código
|
VoidShipmentResponse.PackageLevelResult.Status.Code | string |
Código para el estado del resultado de resumen. |
|
Descripción
|
VoidShipmentResponse.PackageLevelResult.Status.Description | string |
Descripción del estado del resultado de resumen. |
|
TrackingNumber
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
Número de identificación del paquete. |
Crear envío
Create Shipment API ofrece a la aplicación muchas maneras de administrar el envío de paquetes a su destino.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de transacción
|
transid | True | string |
Identificador único de la solicitud. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
ShipmentResponse.Response.ResponseStatus.Code | string |
Identifica el éxito o el error de la transacción. |
|
Descripción
|
ShipmentResponse.Response.ResponseStatus.Description | string |
Describe el código de estado de respuesta. Devuelve el texto correcto. |
|
Alerta
|
ShipmentResponse.Response.Alert | ||
|
CustomerContext
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
Datos proporcionados por el cliente. Puede ser XML. Si estos datos están presentes en la solicitud, se devuelve al cliente. |
|
TransactionIdentifier
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Identificador único de la solicitud. |
|
Aviso de declinación de responsabilidades
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
Código de Moneda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
Tipo de código de moneda BaseServiceCharge. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
Importe del valor de cargo del servicio base. |
|
Código de Moneda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
El transporte cobra el tipo de código de moneda. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
Importe del valor de transporte y suplementos. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
Código de Moneda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
Tipo de código de moneda de cargos descriptores de acceso. Se devuelve el código de moneda usado en la solicitud de envío. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
Importe del valor de los cargos descriptores de acceso. |
|
TaxCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
Código de Moneda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
Total de cargos tipo de código de moneda. Se devuelve el código de moneda usado en la solicitud de envío. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
Importe total de los cargos. |
|
Código de Moneda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
Tipo de código de moneda TotalChargesWithTaxes. Se devuelve el código de moneda usado en la solicitud de envío. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
Importe del valor monetario TotalChargesWithTaxes. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
TaxCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
Código de Moneda
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
Total de cargos código de moneda. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
Total de cargos monetarios. |
|
Código de Moneda
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
Tipo de código de moneda TotalChargesWithTaxes. Se devuelve el código de moneda usado en la solicitud de envío. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
Importe del valor monetario TotalChargesWithTaxes. |
|
Código de Moneda
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
Código de moneda de cargos brutos. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
El valor monetario de los cargos brutos. |
|
Código de Moneda
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
Código de moneda de la cantidad de descuento. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
Valor monetario de la cantidad de descuento. |
|
Código de Moneda
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
Código de moneda de Net Charge. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
Valor monetario de cargos netos. |
|
Densidad
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
La densidad se devuelve si el remitente es apto para la tarifa basada en densidad. |
|
TotalCubicFeet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
Se devuelven los pies cúbicos totales si el remitente es apto para la tarifa basada en densidad. |
|
HandlingUnits
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
RatingMethod
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
RatingMethod es indicar si el envío se ha clasificado como nivel de envío o nivel de paquete. Esta información solo se devolverá si RatingMethodRequestedIndicator está presente en la solicitud. Valores válidos: 01 = Nivel de envío 02 = Nivel de paquete. |
|
BillableWeightCalculationMethod
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
BillableWeightCalculationMethod es indicar si el método de cálculo de peso facturable utilizado era: el nivel de paquete o el nivel de envío. Esta información solo se devolverá si RatingMethodRequestedIndicator está presente en la solicitud. |
|
Código
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
Código de las unidades de medida de peso de facturación. Los valores son: KGS o LBS. |
|
Descripción
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Description | string |
Descripción de las unidades de medida de peso de facturación. |
|
Peso
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
Peso de facturación. Mayor peso real del envío frente al peso dimensional del envío. |
|
ShipmentIdentificationNumber
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
Número de id. de envío UPS devuelto.1Z Número del primer paquete del envío. |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
MIDualReturnShipmentKey es una clave única necesaria para procesar el envío de devolución dual de innovaciones de correo. |
|
ShipmentDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
Parámetros de envío codificados necesarios para pasarse en la fase de aceptación. Solo se aplica a ShipConfirmResponse. |
|
PackageResults
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
Código
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Code | string |
Código para el tipo de imagen gráfica para el informe de alto valor. |
|
Descripción
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Description | string |
Descripción del código de formato. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Imagen html codificada en base 64, EPL2, ZPL o SPL. Solo se aplica a ShipmentResponse y ShipAcceptResponse. |
|
Código
|
ShipmentResponse.ShipmentResults.Form.Code | string |
Código que indica el tipo de formulario. Solo se aplica a ShipmentResponse y ShipAcceptResponse. Valores válidos: 01 - Todos los formularios internacionales solicitados. |
|
Descripción
|
ShipmentResponse.ShipmentResults.Form.Description | string |
Descripción que indica el tipo de formulario. Valores posibles. Todos los formularios internacionales solicitados. Solo se aplica a ShipmentResponse y ShipAcceptResponse. |
|
Código
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
Código que representa el formato en el que se generan los formularios. Solo se aplica a ShipmentResponse y ShipAcceptResponse. Valor válido: PDF = solo pdf. |
|
Descripción
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
Descripción del código de formato de imagen de formulario. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Imagen de formularios internacionales codificadas en Base 64. Solo se aplica a ShipmentResponse y ShipAcceptResponse. |
|
FormGroupId
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
Identificador único para la recuperación posterior de la versión guardada de los formularios internacionales completados. Siempre se devuelve cuando el código = 01. 01 representa formularios internacionales. Solo se aplica a ShipmentResponse y ShipAcceptResponse. |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
Contiene texto de descripción que identifica el grupo de formularios internacionales. Este elemento forma parte de la solicitud y la respuesta. Este elemento no aparece en los formularios. Solo se aplica a ShipmentResponse y ShipAcceptResponse. |
|
Código
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
Dar formato al código de la página de turnos COD generada. Valores válidos: HTML = formato HTML. Solo se admite el formato HTML para la página de turnos COD. Solo se aplica a ShipmentResponse y ShipAcceptResponse. |
|
Descripción
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
Descripción del código de formato de la página Cod Turn In generada. Solo se aplica a ShipmentResponse y ShipAcceptResponse. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Software de representación de imágenes html codificadas en base 64. Solo se aplica a ShipmentResponse y ShipAcceptResponse. |
|
Código
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
Código que representa el formato en el que se genera el informe de valor alto. Valores válidos: PDF = pdf. |
|
Descripción
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Description | string |
Descripción del formato de imagen. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Imagen PDF codificada en base 64. |
|
LabelURL
|
ShipmentResponse.ShipmentResults.LabelURL | string |
La dirección URL apuntará a una página en la que se pueden solicitar instrucciones de etiqueta, recibo y otros documentos, si procede, como HighValueReport, CustomsInvoice e ImportControl. LabelURL solo se devuelve si se solicita labelLinksIndicator para los siguientes envíos: envío Print/Electronic ImportControl, Print/Electronic, Return send, Forward send except for Mail Innovations Forward. |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
La dirección URL apuntará a una página en la que se pueden solicitar instrucciones de etiqueta, recibo y otros documentos, si procede, como HighValueReport, CustomsInvoice e ImportControl. LocalLanguageLabelURL solo se devuelve si se solicita labelLinksIndicator para los siguientes envíos: envío Print/Electronic ImportControl, Envío de impresión/Devolución electrónica, Envío de reenvío excepto Mail Innovations Forward, No se devuelve si LabelLinksIndicator se solicita con el elemento Locale. |
|
ReceiptURL
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
La dirección URL apuntará a una página en la que se pueden solicitar instrucciones de etiqueta, recibo y otros documentos, si procede, como HighValueReport, CustomsInvoice e ImportControl. ReceiptURL solo se devuelve si se solicita labelLinksIndicator para los siguientes envíos: envío Print/Electronic ImportControl, Envío de impresión/Devolución electrónica. |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
La dirección URL apuntará a una página en la que se pueden solicitar instrucciones de etiqueta, recibo y otros documentos, si procede, como HighValueReport, CustomsInvoice e ImportControl. LocalLanguageReceiptURL solo se devuelve si se solicita labelLinksIndicator para los siguientes envíos: envío Print/Electronic ImportControl, Envío de impresión/Devolución electrónica, Envío de reenvío excepto Mail Innovations Forward, No se devuelve si LabelLinksIndicator se solicita con el elemento Locale. |
|
DGPaperImage
|
ShipmentResponse.ShipmentResults.DGPaperImage | string |
Dangrous Good Paper Image en formato pdf. Se devolverá un documento PDF de varias páginas que contendrá todas las copias de papel de envío de Dangrous Goods necesarias para todos los paquetes de mercancías peligrosas. Solo se devuelve cuando DGSignatoryInfo está presente. |
|
MasterCartonID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
Id. de cartón maestro. MasterCartonID se devolverá si MasterCartonIndicator está presente en la solicitud. |
Localizador
La API de localizador proporciona ubicaciones de autoservicio y servicio completo de UPS, horas de operación y recogida.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
CustomerContext
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
Datos proporcionados por el cliente. Puede ser XML. Si estos datos están presentes en la solicitud, se devuelve al cliente. |
|
XpciVersion
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
Identifica la versión del mensaje. |
|
CódigoDeEstadoDeRespuesta (ResponseStatusCode)
|
LocatorResponse.Response.ResponseStatusCode | string |
Identifica el éxito o error del intercambio. |
|
ResponseStatusDescription
|
LocatorResponse.Response.ResponseStatusDescription | string |
Describe el código de estado de respuesta. |
|
ErrorSeverity
|
LocatorResponse.Response.Error.ErrorSeverity | string |
Describe la gravedad del error. |
|
ErrorCode
|
LocatorResponse.Response.Error.ErrorCode | string |
Valor numérico que describe el error. |
|
Descripción del Error
|
LocatorResponse.Response.Error.ErrorDescription | string |
Describe el código de error. |
|
MinimumRetrySeconds
|
LocatorResponse.Response.Error.MinimumRetrySeconds | string |
Número de segundos que se van a esperar hasta el reintento. |
|
ErrorLocationElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
Nombre Xpath del elemento en error. Se trata de un Xpath válido que apunta a un elemento del documento de solicitud. |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
Nombre del atributo en error. Este es el nombre del atributo contenido por el elemento Ubicación de error. |
|
ErrorDigest
|
LocatorResponse.Response.Error.ErrorDigest | string |
Contenido del elemento en error. |
|
Latitud
|
LocatorResponse.Geocode.Latitude | string |
Latitud de la dirección de origen, punto central del intercambio, punto central del código postal o punto central de la ciudad. |
|
longitud
|
LocatorResponse.Geocode.Longitude | string |
Longitud de la dirección de origen, punto central del intercambio, punto central del código postal o punto central de la ciudad. |
|
GeocodeCandidate
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
Aviso de declinación de responsabilidades
|
LocatorResponse.SearchResults.Disclaimer | string |
Exclusión. En caso de que no se cumpla el tamaño máximo de la lista de ubicaciones UPS, la lista de ubicaciones continuará con las ubicaciones que proporcionan tierra o aire dentro del radio de búsqueda. |
|
DropLocation
|
LocatorResponse.SearchResults.DropLocation | ||
|
Número
|
LocatorResponse.SearchResults.MapNavigation.Number | string |
Número central de la ubicación de colocación si es el almacén UPS. |
|
Altura
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Height | string |
Se devolverá el valor proporcionado en la solicitud; de lo contrario, el ancho predeterminado de la imagen se establece en 200 píxeles. Otros valores válidos están comprendidos entre 100 y 400. |
|
Ancho
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Width | string |
Se devolverá el valor proporcionado en la solicitud; de lo contrario, el ancho predeterminado de la imagen se establece en 200 píxeles. Otros valores válidos están comprendidos entre 100 y 400. |
|
ZoomFactor
|
LocatorResponse.SearchResults.MapNavigation.ZoomFactor | string |
El factor que la imagen tiene que ser para mostrar todas las ubicaciones de UPS. |
|
PanX
|
LocatorResponse.SearchResults.MapNavigation.PanX | string |
Nivel al que el usuario desea desplazarse en el eje X. Nunca volvió. Después de la respuesta inicial, es posible que el usuario quiera ver la imagen más a la izquierda o a la derecha. Para ello, se requiere otra solicitud con un valor de 1, 0 o 1. |
|
Panorámica
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
Nivel al que el usuario desea desplazarse en el eje Y. La solicitud inicial que el valor predeterminado es 0. Después de la respuesta inicial, es posible que el usuario quiera ver la imagen hacia arriba o hacia abajo en el eje Y. Para ello, se requiere otra solicitud con un valor de 1, 0 o 1. |
|
MapID
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
Una lista de 5 identificadores de ubicación se cifran dentro del MapID para la generación de mapas. |
|
MapURL
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
Un vínculo al mapa con las cinco ubicaciones UPS y la ubicación de origen especificada en mapID. |
|
LocationID
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
Identificador de ubicación de una ubicación UPS determinada. |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
Coordenada X de la ubicación de UPS. |
|
YCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.YCoordinate | string |
Coordenada Y de la ubicación de UPS. |
|
Segmento
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Segment | string |
Instrucciones paso a paso del origen a la ubicación especificada. |
|
Importancia
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.Value | string |
Distancia calculada desde el origen hasta la ubicación de UPS. |
|
Código
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Code | string |
Unidad de distancia del código de medida. Se devuelve la unidad de medida usada en la solicitud de búsqueda. Los valores devueltos son: MI-Miles. |
|
Descripción
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Description | string |
Puede devolver la descripción de la unidad de medida especificada en la solicitud. Los valores válidos son: Millas y Kilómetro. |
|
Tiempo
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Time | string |
El período estimado total de tiempo que tardaría en conducir desde el origen a la ubicación. |
|
Importancia
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.Value | string |
Distancia recta desde el origen hasta la ubicación de UPS. |
|
Código
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Code | string |
Unidad de distancia del código de medida. Se devuelve la unidad de medida usada en la solicitud de búsqueda. Los valores devueltos son: MI-Miles. |
|
Descripción
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
Puede devolver la descripción de la unidad de medida especificada en la solicitud. Los valores válidos son: Millas y Kilómetro. |
|
TotalTime
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
El período estimado total de tiempo que tardaría en conducir desde el origen a la ubicación. Formato: HHMM. |
|
AvailableLocationAttributes
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
ActiveAvailableAccessPointIndicator
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
Indica si el país o territorio tiene AccessPoints o no. |
|
AllowAllConfidenceLevels
|
LocatorResponse.AllowAllConfidenceLevels | string |
Indicador para permitir el nivel de confianza en la búsqueda. |
Nivel de calle de validación de direcciones
La API de nivel de calle de validación de direcciones se puede usar para comprobar las direcciones en la base de datos del Servicio Postal de Estados Unidos de direcciones válidas en Estados Unidos y Puerto Rico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Opción de solicitud
|
requestoption | True | integer |
Opción de solicitud de solicitud de solicitud de validación de direcciones. |
|
Indicador de solicitud regional
|
regionalrequestIndicator | string |
Indicador de solicitud regional de solicitud de solicitud de validación de direcciones. |
|
|
Tamaño máximo de lista candidata
|
maximumcandidatelistsize | integer |
Tamaño máximo de la lista de candidatos de la solicitud de validación de direcciones. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
XAVResponse.Response.ResponseStatus.Code | string |
Código de advertencia devuelto por el sistema. |
|
Descripción
|
XAVResponse.Response.ResponseStatus.Description | string |
Mensaje devuelto desde el sistema. |
|
ValidAddressIndicator
|
XAVResponse.ValidAddressIndicator | string |
La consulta encontró una coincidencia válida. |
|
AmbiguaAddressIndicator
|
XAVResponse.AmbiguousAddressIndicator | string |
Indica que la consulta no pudo encontrar una coincidencia en función de la información proporcionada. |
|
NoCandidatesIndicator
|
XAVResponse.NoCandidatesIndicator | string |
No se encontró ningún candidato. |
|
Código
|
XAVResponse.AddressClassification.Code | string |
Contiene el código de clasificación de la dirección de entrada. |
|
Descripción
|
XAVResponse.AddressClassification.Description | string |
Contiene la descripción de texto del código de clasificación de direcciones. |
|
Candidato
|
XAVResponse.Candidate |
Seguimiento
La API de seguimiento admite envíos de paquete, carga terrestre y flete aéreo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Número de consulta
|
inquiryNumber | True | string |
Número de consulta usado para acceder a la información de seguimiento de UPS. |
|
Id. de transacción
|
transid | True | string |
Identificador único de la solicitud. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
envío
|
trackResponse.shipment | array of object |
Elemento que contiene los detalles de envío asociados a los números de consulta. |
|
paquete
|
trackResponse.shipment.package | array of object |
Elemento que contiene los detalles del paquete. |
|
trackingNumber
|
trackResponse.shipment.package.trackingNumber | string |
El pequeño paquete, innovaciones de correo, carga o número de seguimiento nocturno. |
|
deliveryDate
|
trackResponse.shipment.package.deliveryDate | ||
|
tipo
|
trackResponse.shipment.package.deliveryTime.type | string |
Indica el tipo de entrega. |
|
startTime
|
trackResponse.shipment.package.deliveryTime.startTime | string |
La hora de inicio, la hora confirmada o la hora de entrega. |
|
EndTime
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
Hora de finalización de la ventana. |
|
actividad
|
trackResponse.shipment.package.activity | array of object |
Elemento contenedor que contiene la actividad de examen asociada a la consultaNumber. |
|
location
|
trackResponse.shipment.package.activity.location | ||
|
tipo
|
trackResponse.shipment.package.activity.status.type | string |
Tipo de actividad. |
|
descripción
|
trackResponse.shipment.package.activity.status.description | string |
Descripción del estado. |
|
código
|
trackResponse.shipment.package.activity.status.code | string |
Código de estado. |
|
date
|
trackResponse.shipment.package.activity.date | string |
Fecha de la actividad. |
|
time
|
trackResponse.shipment.package.activity.time | string |
Hora de la actividad. |