UPS (versão prévia)
O Serviço de Encomendas Unidas (UPS) fornece aos clientes e empresas em todo o mundo um amplo portfólio de serviços de transporte, comércio eletrônico e negócios. Conecte-se às APIs ups para validar endereços, locais de pesquisa, criar remessa, acompanhar remessas etc.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Classe | Regions |
|---|---|---|
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Government regiões - Azure regiões da China - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Microsoft Dynamics |
| URL | https://aka.ms/iomsupport |
| iomdri@microsoft.com |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
| Site | 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 | Produtividade |
O conector do UPS (Serviço de Encomendas Unidas) foi desenvolvido especificamente para ser usado para a integração do Provedor do Dynamics 365 Intelligent Order Management.
Pré-requisitos
- Inscreva-se para UPS.com Perfil de https://www.ups.com/upsdeveloperkit?loc=en_US.
Como obter credenciais
- Access https://www.ups.com/upsdeveloperkit?loc=en_US.
- Faça logon para se conectar à sua conta.
- Use "Solicitar uma chave de acesso" para gerar a chave de acesso.
- UPS.Com nome de usuário de logon do perfil, senha 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 habilitar o Provedor de UPS.
Problemas e limitações conhecidos
Esse conector foi desenvolvido especificamente para ser usado para a integração do Provedor ups do Dynamics 365 Intelligent Order Management. O suporte para casos de uso fora do Dynamics 365 Intelligent Order Management será limitado.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia 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: Área restrita ou produção | cadeia | Ambiente de área restrita do UPS ou ambiente de produção | Verdade |
| Chave de Acesso | secureString | Chave de Acesso obtida por meio do processo de integração do UPS | Verdade |
| Nome de usuário | cadeia | Nome de usuário da sua conta do MyUPS | Verdade |
| Senha | secureString | Senha da sua conta do MyUPS | Verdade |
| Origem da transação | cadeia | Identifica os clientes/aplicativo de origem que está chamando | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Acompanhamento |
A API de acompanhamento dá suporte a remessas de frete de carga terrestre e de carga terrestre. |
| Cancelar remessa |
Cancelar a API de Remessa é usada para cancelar a remessa agendada anteriormente. |
| Criar Remessa |
Criar a API de Remessa fornece ao aplicativo várias maneiras de gerenciar a remessa de pacotes para seu destino. |
| Localizador |
A API do localizador fornece locais de serviço completo e autoatendimento do UPS, horas de operação e horas de retirada. |
| Nível da Rua de Validação de Endereço |
A API de Nível de Rua de Validação de Endereços pode ser usada para verificar endereços no banco de dados do Serviço Postal dos Estados Unidos de endereços válidos nos EUA e em Porto Rico. |
Acompanhamento
A API de acompanhamento dá suporte a remessas de frete de carga terrestre e de carga terrestre.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de consulta
|
inquiryNumber | True | string |
O número de investigação usado para acessar informações de acompanhamento do UPS. |
|
ID da Transação
|
transid | True | string |
Um identificador exclusivo da solicitação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
remessa
|
trackResponse.shipment | array of object |
Elemento que contém os detalhes de remessa associados aos números de investigação. |
|
pacote
|
trackResponse.shipment.package | array of object |
Elemento que contém os detalhes do pacote. |
|
número de rastreamento
|
trackResponse.shipment.package.trackingNumber | string |
O pequeno pacote, inovações de correio, frete ou número de acompanhamento noturno. |
|
deliveryDate
|
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, a hora confirmada ou a hora de entrega. |
|
EndTime
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
A hora de término da janela. |
|
atividade
|
trackResponse.shipment.package.activity | array of object |
Um elemento de contêiner que contém a atividade de verificação associada ao inquiryNumber. |
|
local
|
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. |
|
codificar
|
trackResponse.shipment.package.activity.status.code | string |
Código de status. |
|
data
|
trackResponse.shipment.package.activity.date | string |
A data da atividade. |
|
time
|
trackResponse.shipment.package.activity.time | string |
A hora da atividade. |
Cancelar remessa
Cancelar a API de Remessa é usada para cancelar a remessa agendada anteriormente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de identificação de remessa
|
shipmentidentificationnumber | True | string |
O número de identificação da remessa. |
|
Número de Rastreamento
|
trackingnumber | string |
O número de acompanhamento do pacote. |
|
|
ID da Transação
|
transid | True | string |
Um identificador exclusivo da solicitação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
Identifica o êxito ou a falha da transação. |
|
Descrição
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
Descreve o código de status da resposta. Retorna o texto de êxito. |
|
CustomerContext
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
Dados fornecidos pelo cliente. Pode ser XML. Se esses dados estiverem presentes na solicitação, eles serão repercutidos no cliente. |
|
TransactionIdentifier
|
VoidShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Um identificador exclusivo da solicitação. |
|
Code
|
VoidShipmentResponse.SummaryResult.Status.Code | string |
Código para o status do Resultado do Resumo. |
|
Descrição
|
VoidShipmentResponse.SummaryResult.Status.Description | string |
Descrição do status do Resultado do Resumo. |
|
Code
|
VoidShipmentResponse.PackageLevelResult.Status.Code | string |
Código para o status do Resultado do Resumo. |
|
Descrição
|
VoidShipmentResponse.PackageLevelResult.Status.Description | string |
Descrição do status do Resultado do Resumo. |
|
TrackingNumber
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
O número de identificação do pacote. |
Criar Remessa
Criar a API de Remessa fornece ao aplicativo várias maneiras de gerenciar a remessa de pacotes para seu destino.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Transação
|
transid | True | string |
Um identificador exclusivo da solicitação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
ShipmentResponse.Response.ResponseStatus.Code | string |
Identifica o êxito ou a falha da transação. |
|
Descrição
|
ShipmentResponse.Response.ResponseStatus.Description | string |
Descreve o código de status da resposta. Retorna o texto de êxito. |
|
Alerta
|
ShipmentResponse.Response.Alert | ||
|
CustomerContext
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
Dados fornecidos pelo cliente. Pode ser XML. Se esses dados estiverem presentes na solicitação, eles serão repercutidos no cliente. |
|
TransactionIdentifier
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Um identificador exclusivo da solicitação. |
|
Disclaimer
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
Código de moeda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
Tipo de código de moeda BaseServiceCharge. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
Valor do Valor da Taxa de Serviço Base. |
|
Código de moeda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
Tipo de código de moeda de encargos de transporte. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
Valor de transporte e sobretaxas. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
Código de moeda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
Tipo de código de moeda de encargos acessórios. O código de moeda usado na solicitação de remessa é retornado. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
Valor de encargos acessenciais. |
|
TaxCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
Código de moeda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
Tipo de código de moeda de encargos totais. O código de moeda usado na solicitação de remessa é retornado. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
Valor total de encargos. |
|
Código de moeda
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
Tipo de código de moeda TotalChargesWithTaxes. O código de moeda usado na solicitação de remessa é retornado. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
Valor monetário TotalChargesWithTaxes. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
TaxCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
Código de moeda
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
Código de moeda total de encargos. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
Valor monetário total dos encargos. |
|
Código de moeda
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
Tipo de código de moeda TotalChargesWithTaxes. O código de moeda usado na solicitação de remessa é retornado. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
Valor monetário TotalChargesWithTaxes. |
|
Código de moeda
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
Código de moeda de encargos brutos. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
Valor monetário de encargos brutos. |
|
Código de moeda
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
Código de moeda valor de desconto. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
Valor monetário do valor do valor do desconto. |
|
Código de moeda
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
Código de moeda do Net Charge. |
|
Valor Monetário
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
Valor monetário de encargos líquidos. |
|
Densidade
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
A densidade será retornada se o Shipper estiver qualificado para a taxa baseada em densidade. |
|
TotalCubicFeet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
O total de pés cúbicos será retornado se o Shipper estiver qualificado para a taxa baseada em densidade. |
|
HandlingUnits
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
RatingMethod
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
RatingMethod deve indicar se a remessa foi classificada como nível de remessa ou nível de pacote. Essas informações serão retornadas somente se RatingMethodRequestedIndicator estiver presente na solicitação. Valores válidos: 01 = Nível de remessa 02 = Nível do pacote. |
|
BillableWeightCalculationMethod
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
BillableWeightCalculationMethod deve indicar se o método de cálculo de peso faturável utilizado foi : o nível do pacote ou o nível de remessa. Essas informações serão retornadas somente se RatingMethodRequestedIndicator estiver presente na solicitação. |
|
Code
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
Código das unidades de medição de peso de cobrança. 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 cobrança. |
|
Peso
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
Peso de cobrança. Maior do peso real da remessa em comparação com o peso dimensional de remessa. |
|
ShipmentIdentificationNumber
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
Número de ID de remessa UPS retornado.1Z do primeiro pacote na remessa. |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
MIDualReturnShipmentKey é uma chave exclusiva necessária para processar o Envio de Retorno Duplo de Inovações de Email. |
|
ShipmentDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
Parâmetros de remessa codificados necessários para serem passados na fase de aceitação. Aplicável somente para ShipConfirmResponse. |
|
PackageResults
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
Code
|
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 de formato. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Imagem de HTML codificada em Base 64, EPL2, ZPL ou SPL. Aplicável somente para ShipmentResponse e ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Code | string |
Código que indica o tipo de formulário. Aplicável somente 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 somente para ShipmentResponse e ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
Código que representa o formato no qual os formulários são gerados. Aplicável somente para ShipmentResponse e ShipAcceptResponse. Valor válido: PDF = pdf Somente. |
|
Descrição
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
Descrição do código de formato de imagem do formulário. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Imagem de formulários internacionais codificados em Base 64. Aplicável somente para ShipmentResponse e ShipAcceptResponse. |
|
FormGroupId
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
ID exclusiva para recuperação posterior da versão salva dos formulários internacionais concluídos. Sempre retornado quando o código = 01. 01 representa formas internacionais. Aplicável somente para ShipmentResponse e ShipAcceptResponse. |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
Contém o texto de descrição que identifica o grupo de formulários internacionais. Esse elemento faz parte da solicitação e da resposta. Esse elemento não aparece nos formulários. Aplicável somente para ShipmentResponse e ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
Formatar o código da página de entrada COD gerada. Valores válidos: HTML = formato HTML. Somente o formato HTML tem suporte para a página De Entrada COD. Aplicável somente para ShipmentResponse e ShipAcceptResponse. |
|
Descrição
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
Descrição do código de formato da página DE ENTRADA COD gerada. Aplicável somente para ShipmentResponse e ShipAcceptResponse. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Software de renderização de imagem de navegador html codificado em base 64. Aplicável somente para ShipmentResponse e ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
Código que representa o formato no qual 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 de imagem. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Imagem PDF codificada em Base 64. |
|
LabelURL
|
ShipmentResponse.ShipmentResults.LabelURL | string |
A URL apontará para uma página na qual as instruções de rótulo, recibo e outros documentos, se aplicável, como HighValueReport, CustomsInvoice e ImportControl podem ser solicitadas. LabelURL será retornado somente se o LabelLinksIndicator for solicitado para as seguintes remessas: Envio de Impressão/ImportControl Eletrônico, Impressão/Eletrônica, Remessa de retorno, envio de encaminhamento, exceto para Mail Innovations Forward. |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
A URL apontará para uma página na qual as instruções de rótulo, recibo e outros documentos, se aplicável, como HighValueReport, CustomsInvoice e ImportControl podem ser solicitadas. LocalLanguageLabelURL será retornado somente se o LabelLinksIndicator for solicitado para as seguintes remessas: Envio de Impressão/ImportControl Eletrônico, Envio de Impressão/Retorno Eletrônico, Envio de Encaminhamento, exceto para Encaminhamento de Inovações de Email, Não retornado se LabelLinksIndicator for solicitado com o elemento Locale. |
|
ReceiptURL
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
A URL apontará para uma página na qual as instruções de rótulo, recibo e outros documentos, se aplicável, como HighValueReport, CustomsInvoice e ImportControl podem ser solicitadas. ReceiptURL será retornado somente se o LabelLinksIndicator for solicitado para as seguintes remessas: Envio de Impressão/ImportControl Eletrônico, Envio de Impressão/Retorno Eletrônico. |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
A URL apontará para uma página na qual as instruções de rótulo, recibo e outros documentos, se aplicável, como HighValueReport, CustomsInvoice e ImportControl podem ser solicitadas. LocalLanguageReceiptURL será retornado somente se o LabelLinksIndicator for solicitado para as seguintes remessas: Envio de Impressão/ImportControl Eletrônico, Envio de Impressão/Retorno Eletrônico, Envio de Encaminhamento, exceto para Encaminhamento de Inovações de Email, Não retornado se LabelLinksIndicator for solicitado com o elemento Locale. |
|
DGPaperImage
|
ShipmentResponse.ShipmentResults.DGPaperImage | string |
Imagem de bom papel dangrous no formato pdf. Será retornado um documento PDF de várias páginas que conterá todas as cópias de papel de envio da Dangrous Goods necessárias para todos os pacotes de Produtos Perigosos. Retornado somente quando DGSignatoryInfo estiver presente. |
|
MasterCartonID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
ID da Caixa Mestra. MasterCartonID será retornado se MasterCartonIndicator estiver presente na solicitação. |
Localizador
A API do localizador fornece locais de serviço completo e autoatendimento do UPS, horas de operação e horas de retirada.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
CustomerContext
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
Dados fornecidos pelo cliente. Pode ser XML. Se esses dados estiverem presentes na solicitação, eles serão repercutidos no cliente. |
|
XpciVersion
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
Identifica a versão da mensagem. |
|
Código de Status da Resposta
|
LocatorResponse.Response.ResponseStatusCode | string |
Identifica o êxito ou a falha do intercâmbio. |
|
ResponseStatusDescription
|
LocatorResponse.Response.ResponseStatusDescription | string |
Descreve o código de status 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 aguardar até tentar novamente. |
|
ErrorLocationElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
O nome Xpath do elemento em erro. Este é um Xpath válido que aponta para um elemento no documento de solicitação. |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
O nome do atributo em erro. Esse é o nome do atributo contido pelo elemento Local do 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, o ponto central da troca, o ponto central do código postal ou o ponto central da cidade. |
|
longitude
|
LocatorResponse.Geocode.Longitude | string |
A longitude do endereço de origem, o ponto central da troca, o ponto central do código postal ou o ponto central da cidade. |
|
GeocodeCandidate
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
Disclaimer
|
LocatorResponse.SearchResults.Disclaimer | string |
Isenção de Responsabilidade. Caso o usuário solicite tipos de serviço de Terra e Ar e o tamanho máximo da lista de locais ups não tenha sido atendido, a lista de locais continuará com locais que fornecem 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 descarte se for o repositório UPS. |
|
Altura
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Height | string |
O valor fornecido na solicitação será retornado, caso contrário, a largura padrão da imagem reativada é definida em 200 pixels. Outros valores válidos estão entre 100 e 400. |
|
Largura
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Width | string |
O valor fornecido na solicitação será retornado, caso contrário, a largura padrão da imagem reativada é definida em 200 pixels. Outros valores válidos estão entre 100 e 400. |
|
ZoomFactor
|
LocatorResponse.SearchResults.MapNavigation.ZoomFactor | string |
O fator que a imagem precisa ser para mostrar todos os locais de UPS. |
|
PanX
|
LocatorResponse.SearchResults.MapNavigation.PanX | string |
O nível para o qual o usuário deseja fazer pan no eixo X. Nunca mais voltou. Após a resposta inicial, o usuário pode querer exibir a imagem mais à esquerda ou à direita. Para fazer isso, outra solicitação é necessária com um valor de 1, 0 ou 1. |
|
Pany
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
O nível para o qual o usuário deseja fazer pan no eixo Y. A solicitação inicial do valor padrão é 0. Após a resposta inicial, o usuário pode querer exibir a imagem mais para cima ou para baixo no eixo y. Para fazer isso, outra solicitação é necessária com um valor de 1, 0 ou 1. |
|
Mapid
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
Uma lista de 5 IDs de localização são criptografadas dentro da geração MapID for MapID for Map. |
|
MapURL
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
Um link para o mapa com os cinco locais ups e o local de origem especificado no MapID. |
|
LocationID
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
A ID de localização de um local específico do UPS. |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
A coordenada X do local do UPS. |
|
YCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.YCoordinate | string |
A coordenada Y do local do UPS. |
|
Segmento
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Segment | string |
Instruções passo a passo da Origem para o local especificado. |
|
Valor
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.Value | string |
A distância calculada da origem até o local do UPS. |
|
Code
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Code | string |
A unidade de distância do código de medida. A unidade de medida usada na solicitação de pesquisa é retornada. Os valores retornados são: MI-Miles. |
|
Descrição
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Description | string |
Pode retornar a descrição da unidade de medida especificada na solicitação. Os valores válidos são: Milhas e Quilômetros. |
|
Tempo
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Time | string |
O período de tempo estimado total que levaria para dirigir da origem para o local. |
|
Valor
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.Value | string |
A distância de linha reta da origem até o local do UPS. |
|
Code
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Code | string |
A unidade de distância do código de medida. A unidade de medida usada na solicitação de pesquisa é retornada. Os valores retornados são: MI-Miles. |
|
Descrição
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
Pode retornar a descrição da unidade de medida especificada na solicitação. Os valores válidos são: Milhas e Quilômetros. |
|
TotalTime
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
O período de tempo estimado total que levaria para dirigir da origem para o local. Formato: HHMM. |
|
AvailableLocationAttributes
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
ActiveAvailableAccessPointIndicator
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
Indica se o país ou território tem AccessPoints ou não. |
|
AllowAllConfidenceLevels
|
LocatorResponse.AllowAllConfidenceLevels | string |
Indicador para permitir o nível de confiança na pesquisa. |
Nível da Rua de Validação de Endereço
A API de Nível de Rua de Validação de Endereços pode ser usada para verificar endereços no banco de dados do Serviço Postal dos Estados Unidos de endereços válidos nos EUA e em Porto Rico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Opção de solicitação
|
requestoption | True | integer |
A opção de solicitação da solicitação de validação de endereço. |
|
Indicador de Solicitação Regional
|
regionalrequestIndicator | string |
O indicador de solicitação regional da solicitação de validação de endereço. |
|
|
Tamanho máximo da lista de candidatos
|
maximumcandidatelistsize | integer |
O tamanho máximo da lista de candidatos da solicitação de validação de endereço. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
XAVResponse.Response.ResponseStatus.Code | string |
Código de aviso retornado pelo sistema. |
|
Descrição
|
XAVResponse.Response.ResponseStatus.Description | string |
Mensagem retornada do sistema. |
|
ValidAddressIndicator
|
XAVResponse.ValidAddressIndicator | string |
A consulta encontrou uma correspondência válida. |
|
AmbiguousAddressIndicator
|
XAVResponse.AmbiguousAddressIndicator | string |
Indica que a consulta não pôde encontrar uma correspondência com base nas informações fornecidas. |
|
NoCandidatesIndicator
|
XAVResponse.NoCandidatesIndicator | string |
Nenhum candidato encontrado. |
|
Code
|
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 do texto do código de classificação de endereço. |
|
Candidato
|
XAVResponse.Candidate |