UPS (Pré-visualização)
A United Parcel Service (UPS) oferece a clientes e empresas de todo o mundo um vasto portefólio de serviços de transporte, comércio eletrónico e negócios. Liga-te às APIs da UPS para validar moradas, pesquisar localizações, criar envios, rastrear envios, etc.
Este conector está disponível nos seguintes produtos e regiões:
| Service | Classe | Regiões |
|---|---|---|
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões Azure Government - Regiões Azure China - Departamento de Defesa dos EUA (DoD) |
| Entrar em contato | |
|---|---|
| Nome | Dinâmica da Microsoft |
| URL | https://aka.ms/iomsupport |
| iomdri@microsoft.com |
| Metadados do conector | |
|---|---|
| Editor | Microsoft |
| Sítio Web | https://www.ups.com/us/en/services/technology-integration.page |
| Política de privacidade | https://www.ups.com/us/en/help-center/legal-terms-conditions/privacy-notice.page |
| Categorias | Productivity |
O conector United Parcel Service (UPS) foi especificamente desenvolvido para ser utilizado na integração com o Provider do Dynamics 365 Intelligent Order Management.
Pré-requisitos
- Inscreva-se para UPS.com Perfil em https://www.ups.com/upsdeveloperkit?loc=en_US.
Como obter credenciais
- Aceder https://www.ups.com/upsdeveloperkit?loc=en_USa .
- Inicie sessão para se ligar à sua conta.
- Use "Solicitar uma Chave de Acesso" para gerar a chave de Acesso.
- UPS.Com Perfil Login Nome de Utilizador, Palavra-passe e a chave de acesso gerada serão as credenciais necessárias.
Introdução ao conector
Siga https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider para ativar o Fornecedor UPS.
Problemas conhecidos e limitações
Este conector foi especificamente desenvolvido para ser utilizado na integração UPS Provider do Dynamics 365 Intelligent Order Management. O suporte para casos de uso fora do Dynamics 365 Intelligent Order Management será limitado.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Ambiente: Sandbox ou Produção | cadeia (de caracteres) | Ambiente UPS Sandbox ou ambiente de produção | Verdade |
| Chave de Acesso | securestring | Chave de acesso obtida através do processo de integração da UPS | Verdade |
| Nome de utilizador | cadeia (de caracteres) | Nome de utilizador da sua conta MyUPS | Verdade |
| Senha | securestring | Palavra-passe da sua conta MyUPS | Verdade |
| Fonte da Transação | cadeia (de caracteres) | Identifica os clientes/aplicação de origem que está a chamar | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Cancelar Envio |
A API de Cancelar Envio é usada para cancelar o envio previamente agendado. |
| Criar Envio |
Create Shipment API oferece à aplicação várias formas de gerir o envio de encomendas para o seu destino. |
| Localizador |
A API Locator fornece locais de serviço completo e autoatendimento da UPS, horários de funcionamento e de recolha. |
| Monitorização |
A API de rastreamento suporta encomendas de encomendas, carga terrestre e carga aérea. |
| Validação de Endereços ao Nível da Rua |
A API de Validação de Endereços ao Nível de Rua pode ser usada para verificar endereços com a base de dados do Serviço Postal dos Estados Unidos de endereços válidos nos EUA e Porto Rico. |
Cancelar Envio
A API de Cancelar Envio é usada para cancelar o envio previamente agendado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de Identificação do Envio
|
shipmentidentificationnumber | True | string |
O número de identificação da carga. |
|
Número de Encomenda
|
trackingnumber | string |
O número de rastreio da encomenda. |
|
|
ID da Transação
|
transid | True | string |
Um identificador único para o pedido. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
Identifica o sucesso ou fracasso da transação. |
|
Descrição
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
Descreve o código de estado da resposta. Retorna o texto de Sucesso. |
|
CustomerContext
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
Dados fornecidos pelo cliente. Pode ser XML. Se estes dados estiverem presentes no pedido, são transmitidos de volta ao cliente. |
|
TransactionIdentifier
|
VoidShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Um identificador único para o pedido. |
|
Código
|
VoidShipmentResponse.SummaryResult.Status.Code | string |
Código para o estado do Resultado Resumo. |
|
Descrição
|
VoidShipmentResponse.SummaryResult.Status.Description | string |
Descrição do estado do Resultado Resumo. |
|
Código
|
VoidShipmentResponse.PackageLevelResult.Status.Code | string |
Código para o estado do Resultado Resumo. |
|
Descrição
|
VoidShipmentResponse.PackageLevelResult.Status.Description | string |
Descrição do estado do Resultado Resumo. |
|
Número de Rastreamento
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
O número de identificação da encomenda. |
Criar Envio
Create Shipment API oferece à aplicação várias formas de gerir o envio de encomendas para o seu destino.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Transação
|
transid | True | string |
Um identificador único para o pedido. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código
|
ShipmentResponse.Response.ResponseStatus.Code | string |
Identifica o sucesso ou fracasso da transação. |
|
Descrição
|
ShipmentResponse.Response.ResponseStatus.Description | string |
Descreve o código de estado da resposta. Retorna o texto de Sucesso. |
|
Alerta
|
ShipmentResponse.Response.Alert | ||
|
CustomerContext
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
Dados fornecidos pelo cliente. Pode ser XML. Se estes dados estiverem presentes no pedido, são transmitidos de volta ao cliente. |
|
TransactionIdentifier
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Um identificador único para o pedido. |
|
Disclaimer
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
Código da moeda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
Tipo de código de moeda BaseServiceCharge. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
Valor da Taxa de Serviço Base. |
|
Código da moeda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
Taxas de transporte, tipo de código de moeda. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
Valor do valor do transporte e das sobretaxas. |
|
Despesas Detalhadas
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
Código da moeda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
Taxas acessórias, tipo de código de moeda. O código de moeda usado no pedido de Envio é devolvido. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
O valor dos acessórios cobra. |
|
TaxCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
Código da moeda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
Cobranças totais, tipo de código de moeda. O código de moeda usado no pedido de Envio é devolvido. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
Valor total das cobranças. |
|
Código da moeda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
Código de moeda TotalChargesWithTaxs. O código de moeda usado no pedido de Envio é devolvido. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
Valor monetário TotalChargesWithImpostos. |
|
Despesas Detalhadas
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
TaxCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
Código da moeda
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
Cobranças totais, código monetário. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
Valor monetário das cobranças totais. |
|
Código da moeda
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
Código de moeda TotalChargesWithTaxs. O código de moeda usado no pedido de Envio é devolvido. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
Valor monetário TotalChargesWithImpostos. |
|
Código da moeda
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
Código monetário de taxas brutas. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
Custos brutos de valor monetário. |
|
Código da moeda
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
Código de moeda do montante de desconto. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
Valor monetário com desconto. |
|
Código da moeda
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
Código de moeda Net Charge. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
Cobranças líquidas de valor monetário. |
|
Densidade
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
A densidade é devolvida se o expedidor for elegível para a taxa baseada em densidade. |
|
TotalCubicFeet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
O total de pés cúbicos é devolvido se o Expedidor for elegível para a taxa baseada em Densidade. |
|
Unidades de Manuseamento
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
Método de Classificação
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
O método de classificação serve para indicar se a Remessa foi classificada como nível de envio ou de pacote. Esta informação só será devolvida se RatingMethodRequestedIndicator estiver presente no pedido. Valores válidos: 01 = Nível de envio 02 = Nível de pacote. |
|
Método de Cálculo de Pesos Faturáveis
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
O método BillableWeightCalculation serve para indicar se o método de cálculo do peso faturável utilizado era - o nível de encomenda ou o nível de envio. Esta informação só será devolvida se RatingMethodRequestedIndicator estiver presente no pedido. |
|
Código
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
Código das unidades de medição de peso de faturação. Os valores são: KGS ou LBS. |
|
Descrição
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Description | string |
Descrição das unidades de medição de peso de faturação. |
|
Peso
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
Peso de faturação. Maior do peso real do envio em relação ao peso dimensional do envio. |
|
Número de Identificação da Encomenda
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
Número de ID de envio UPS devolvido.1Z do primeiro pacote da remessa. |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
O MIDualReturnShipmentKey é uma chave única necessária para processar o Envio de Devolução Dupla da Mail Innovations. |
|
ShipmentDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
Parâmetros de envio codificados que devem ser passados na fase de aceitação. Aplicável apenas ao ShipConfirmResponse. |
|
PackageResults
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
Código
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Code | string |
Código para o tipo de Imagem Gráfica para o Relatório de Alto Valor. |
|
Descrição
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Description | string |
Descrição do código do formato. |
|
ImagemGráfica
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Imagem html codificada em base 64, EPL2, ZPL ou SPL. Aplicável apenas para ShipmentResponse e ShipAcceptResponse. |
|
Código
|
ShipmentResponse.ShipmentResults.Form.Code | string |
Código que indica o tipo de formulário. Aplicável apenas para ShipmentResponse e ShipAcceptResponse. Valores válidos: 01 - Todos os Formulários Internacionais Solicitados. |
|
Descrição
|
ShipmentResponse.ShipmentResults.Form.Description | string |
Descrição que indica o tipo de formulário. Valores possíveis. Todos os formulários internacionais solicitados. Aplicável apenas para ShipmentResponse e ShipAcceptResponse. |
|
Código
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
Código que representa o formato em que os formulários são gerados. Aplicável apenas para ShipmentResponse e ShipAcceptResponse. Valor válido: PDF = PDF Apenas. |
|
Descrição
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
Descrição do código do formato da imagem do formulário. |
|
ImagemGráfica
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Imagem de formulários internacionais codificada em base 64. Aplicável apenas para ShipmentResponse e ShipAcceptResponse. |
|
FormGroupId
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
ID único para recuperação posterior da versão guardada dos formulários internacionais preenchidos. Sempre devolvido quando código = 01. 01 representa formas internacionais. Aplicável apenas para ShipmentResponse e ShipAcceptResponse. |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
Contém texto de descrição que identifica o grupo de formulários internacionais. Este elemento faz parte tanto do pedido como da resposta. Este elemento não aparece nas formas. Aplicável apenas para ShipmentResponse e ShipAcceptResponse. |
|
Código
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
Código de formatação da página de entrega gerada do COD. Valores válidos: HTML = formato HTML. Apenas o formato HTML é suportado para o COD Turn In Page. Aplicável apenas para ShipmentResponse e ShipAcceptResponse. |
|
Descrição
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
Descrição do código de formato da página de entrega gerada do COD. Aplicável apenas para ShipmentResponse e ShipAcceptResponse. |
|
ImagemGráfica
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Software de renderização de imagens de navegador codificado em base 64. Aplicável apenas para ShipmentResponse e ShipAcceptResponse. |
|
Código
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
O código representa o formato em que o Relatório de Alto Valor é gerado. Valores válidos: PDF = pdf. |
|
Descrição
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Description | string |
Descrição do formato da imagem. |
|
ImagemGráfica
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Imagem PDF Codificada Base 64. |
|
LabelURL
|
ShipmentResponse.ShipmentResults.LabelURL | string |
A URL apontará para uma página onde podem ser solicitados documentos de etiqueta, recibo e outros documentos, se aplicável, como HighValueReport, CustomsInvoice e instruções ImportControl. O LabelURL é devolvido apenas se o LabelLinksIndicator for solicitado para os seguintes envios: Impressão/Envio Eletrónico ImportControl, Impressão/Eletrónico, Envio de devolução, envio redirecionado, exceto para Correspondência de Inovações Encaminhadas. |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
A URL apontará para uma página onde podem ser solicitados documentos de etiqueta, recibo e outros documentos, se aplicável, como HighValueReport, CustomsInvoice e instruções ImportControl. LocalLanguageLabelURL é devolvido apenas se o LabelLinksIndicator for solicitado para os seguintes envios: envio Print/Electronic ImportControl, envio Print/Electronic Return, envio encaminhado exceto para Mail Innovations Forward, Não devolvido se LabelLinksIndicator for solicitado com o elemento Local. |
|
ReceiptURL
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
A URL apontará para uma página onde podem ser solicitados documentos de etiqueta, recibo e outros documentos, se aplicável, como HighValueReport, CustomsInvoice e instruções ImportControl. O ReceiptURL é devolvido apenas se o LabelLinksIndicator for solicitado para envios seguintes: envio Print/Electronic ImportControl, envio Print/Electronic Return. |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
A URL apontará para uma página onde podem ser solicitados documentos de etiqueta, recibo e outros documentos, se aplicável, como HighValueReport, CustomsInvoice e instruções ImportControl. LocalLanguageReceiptURL é devolvido apenas se o LabelLinksIndicator for solicitado para os seguintes envios: Envio Print/Electronic ImportControl, Envio Impresso/Eletrónico de Devolução, Envio Encaminhado exceto para Emails Innovations Forward, Não devolvido se LabelLinksIndicator for solicitado com o elemento Local. |
|
DGPaperImagem
|
ShipmentResponse.ShipmentResults.DGPaperImage | string |
Dangrous Good Paper Imagem em formato pdf. Será devolvido um documento PDF de várias páginas, que conterá todas as cópias em papel necessárias da Dangrous Goods para todas as encomendas de Mercadorias Perigosas. Só devolvido quando o DGSignatoryInfo está presente. |
|
MasterCartonID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
Identificação Mestre da Caixa. O MasterCartonID será devolvido se o MasterCartonIndicator estiver presente no pedido. |
Localizador
A API Locator fornece locais de serviço completo e autoatendimento da UPS, horários de funcionamento e de recolha.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
CustomerContext
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
Dados fornecidos pelo cliente. Pode ser XML. Se estes dados estiverem presentes no pedido, são transmitidos de volta ao cliente. |
|
XpciVersion
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
Identifica a versão da mensagem. |
|
CódigoDeEstadoDaResposta
|
LocatorResponse.Response.ResponseStatusCode | string |
Identifica o sucesso ou fracasso do nó. |
|
RespostaEstadoDescrição
|
LocatorResponse.Response.ResponseStatusDescription | string |
Descreve o código de estado de resposta. |
|
ErrorSeverity
|
LocatorResponse.Response.Error.ErrorSeverity | string |
Descreve a gravidade do erro. |
|
ErrorCode
|
LocatorResponse.Response.Error.ErrorCode | string |
Um valor numérico que descreve o erro. |
|
Descrição do Erro
|
LocatorResponse.Response.Error.ErrorDescription | string |
Descreve o código de erro. |
|
MinimumRetrySeconds
|
LocatorResponse.Response.Error.MinimumRetrySeconds | string |
Número de segundos para esperar até tentar novamente. |
|
ErrorLocalizaçãoElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
O nome do Xpath do elemento em erro. Este é um Xpath válido que aponta para um elemento no documento de pedido. |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
O nome do atributo está enganado. Este é o nome do atributo contido pelo elemento Localização de Erro. |
|
ErrorDigest
|
LocatorResponse.Response.Error.ErrorDigest | string |
O conteúdo do elemento em erro. |
|
Latitude
|
LocatorResponse.Geocode.Latitude | string |
A latitude do endereço de origem, ponto central da central, ponto central do código postal ou ponto central da cidade. |
|
Longitude
|
LocatorResponse.Geocode.Longitude | string |
A longitude do endereço de origem, ponto central da central, ponto central do código postal ou ponto central da cidade. |
|
GeocodeCandidate
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
Disclaimer
|
LocatorResponse.SearchResults.Disclaimer | string |
Aviso. No caso de o utilizador ter solicitado tipos de serviço terrestre e aéreo e o tamanho máximo da lista de localizações UPS não ter sido atingido, a lista de localizações continuará com locais que forneçam terra ou ar dentro do raio de pesquisa. |
|
DropLocation
|
LocatorResponse.SearchResults.DropLocation | ||
|
Número
|
LocatorResponse.SearchResults.MapNavigation.Number | string |
O número central do local de entrega se for a loja UPS. |
|
Altura
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Height | string |
O valor fornecido no pedido será devolvido, caso contrário a largura padrão da imagem revirada é definida em 200 pixels. Outros valores válidos situam-se entre 100 e 400. |
|
Largura
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Width | string |
O valor fornecido no pedido será devolvido, caso contrário a largura padrão da imagem revirada é definida em 200 pixels. Outros valores válidos situam-se entre 100 e 400. |
|
ZoomFactor
|
LocatorResponse.SearchResults.MapNavigation.ZoomFactor | string |
A razão que a imagem tem de ser para mostrar todas as localizações da UPS. |
|
PanX
|
LocatorResponse.SearchResults.MapNavigation.PanX | string |
O nível para o qual o utilizador deseja fazer a panorâmica no eixo X. Nunca mais voltou. Após a resposta inicial, o utilizador pode desejar visualizar a imagem mais à esquerda ou à direita. Para tal, é necessário outro pedido com valor de 1, 0 ou 1. |
|
PanY
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
O nível até ao qual o utilizador deseja fazer a panorâmica no eixo Y. O valor padrão do pedido inicial é 0. Após a resposta inicial, o utilizador pode desejar visualizar a imagem mais acima ou abaixo no eixo y. Para tal, é necessário outro pedido com valores de 1, 0 ou 1. |
|
MapID
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
Uma lista de 5 IDs de Localização é encriptada dentro do MapID para geração de Mapas. |
|
MapURL
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
Um link para o mapa com as cinco localizações UPS e a localização de origem especificada no MapID. |
|
LocationID
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
O ID de localização de uma determinada localização da UPS. |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
A coordenada X da localização do UPS. |
|
YCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.YCoordinate | string |
A coordenada Y da localização da UPS. |
|
Segmento
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Segment | string |
Instruções passo a passo desde a Origem até ao local especificado. |
|
valor
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.Value | string |
A distância calculada da origem até à localização da UPS. |
|
Código
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Code | string |
O código da unidade de distância de medida. A unidade de medida utilizada no pedido de pesquisa é devolvida. Os valores devolvidos são: MI-Milhas. |
|
Descrição
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Description | string |
Pode devolver a descrição da unidade de medida especificada no pedido. Os valores válidos são: Milhas e Quilómetro. |
|
Hora
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Time | string |
O período total estimado de tempo que demoraria a conduzir desde a origem até ao local. |
|
valor
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.Value | string |
A distância em linha reta desde a origem até à localização da UPS. |
|
Código
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Code | string |
O código da unidade de distância de medida. A unidade de medida utilizada no pedido de pesquisa é devolvida. Os valores devolvidos são: MI-Milhas. |
|
Descrição
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
Pode devolver a descrição da unidade de medida especificada no pedido. Os valores válidos são: Milhas e Quilómetro. |
|
Tempo Total
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
O período total estimado de tempo que demoraria a conduzir desde a origem até ao local. Formato: HHMM. |
|
DisponibilidadeLocalizaçãoAtributos
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
IndicadorAtivoDisponívelPonto de Acesso
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
Indica se o país ou território tem ou não Pontos de Acesso. |
|
Permitir TodosNíveis de Confiança
|
LocatorResponse.AllowAllConfidenceLevels | string |
Indicador para permitir o nível de confiança na pesquisa. |
Monitorização
A API de rastreamento suporta encomendas de encomendas, carga terrestre e carga aérea.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de Inquérito
|
inquiryNumber | True | string |
O número da consulta é usado para aceder à informação de rastreio da UPS. |
|
ID da Transação
|
transid | True | string |
Um identificador único para o pedido. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
envio
|
trackResponse.shipment | array of object |
Elemento que contém os detalhes do envio associados aos números de consulta. |
|
pacote
|
trackResponse.shipment.package | array of object |
Elemento que contém os detalhes do Pacote. |
|
trackingNumber
|
trackResponse.shipment.package.trackingNumber | string |
O pacote pequeno, inovações no correio, número de rastreio de frete ou durante a noite. |
|
Data de entrega
|
trackResponse.shipment.package.deliveryDate | ||
|
tipo
|
trackResponse.shipment.package.deliveryTime.type | string |
Indica o tipo de entrega. |
|
startTime
|
trackResponse.shipment.package.deliveryTime.startTime | string |
A hora de início, tempo comprometido ou tempo entregue. |
|
EndTime
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
O fim do tempo da janela. |
|
actividade
|
trackResponse.shipment.package.activity | array of object |
Um elemento de contentor contendo a atividade de varrimento associada ao inquiryNumber. |
|
localização
|
trackResponse.shipment.package.activity.location | ||
|
tipo
|
trackResponse.shipment.package.activity.status.type | string |
Tipo de atividade. |
|
descrição
|
trackResponse.shipment.package.activity.status.description | string |
Descrição do estado. |
|
código
|
trackResponse.shipment.package.activity.status.code | string |
Código de estado. |
|
data
|
trackResponse.shipment.package.activity.date | string |
A data da atividade. |
|
time
|
trackResponse.shipment.package.activity.time | string |
A hora da atividade. |
Validação de Endereços ao Nível da Rua
A API de Validação de Endereços ao Nível de Rua pode ser usada para verificar endereços com a base de dados do Serviço Postal dos Estados Unidos de endereços válidos nos EUA e Porto Rico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Opção de Pedido
|
requestoption | True | integer |
A opção de pedido de validação de endereço. |
|
Indicador Regional de Pedidos
|
regionalrequestIndicator | string |
O indicador regional de pedido de validação de endereço. |
|
|
Tamanho Máximo da Lista de Candidatos
|
maximumcandidatelistsize | integer |
O tamanho máximo da lista de candidatos do pedido de validação de endereço. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código
|
XAVResponse.Response.ResponseStatus.Code | string |
Código de aviso devolvido pelo sistema. |
|
Descrição
|
XAVResponse.Response.ResponseStatus.Description | string |
Mensagem devolvida do sistema. |
|
ValidAddressIndicator
|
XAVResponse.ValidAddressIndicator | string |
A consulta encontrou uma correspondência válida. |
|
IndicadorDeendereçoAmbíguo
|
XAVResponse.AmbiguousAddressIndicator | string |
Indica que a consulta não conseguiu encontrar correspondência com base na informação fornecida. |
|
SemCandidatosIndicador
|
XAVResponse.NoCandidatesIndicator | string |
Nenhum candidato encontrado. |
|
Código
|
XAVResponse.AddressClassification.Code | string |
Contém o código de classificação do endereço de entrada. |
|
Descrição
|
XAVResponse.AddressClassification.Description | string |
Contém a descrição em texto do código de classificação de endereços. |
|
Candidato
|
XAVResponse.Candidate |