UPS (предварительная версия)
United Parcel Service (UPS) предоставляет клиентам и предприятиям по всему миру широкий портфель транспортных услуг, электронной коммерции и бизнес-услуг. Подключитесь к API UPS для проверки адреса, расположения поиска, создания отгрузки, отслеживания поставок и т. д.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Класс | Регионы |
|---|---|---|
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Microsoft Dynamics |
| URL | https://aka.ms/iomsupport |
| Эл. почта | iomdri@microsoft.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Корпорация Майкрософт |
| Веб-сайт | https://www.ups.com/us/en/services/technology-integration.page |
| Политика конфиденциальности | https://www.ups.com/us/en/help-center/legal-terms-conditions/privacy-notice.page |
| Категории | Продуктивность |
Соединитель United Parcel Service (UPS) специально разработан для интеграции поставщика управления интеллектуальными заказами Dynamics 365.
Необходимые условия
- Зарегистрируйтесь для UPS.com профиля.https://www.ups.com/upsdeveloperkit?loc=en_US
Получение учетных данных
- Доступ https://www.ups.com/upsdeveloperkit?loc=en_US.
- Войдите в систему, чтобы подключиться к учетной записи.
- Используйте команду "Запросить ключ доступа" для создания ключа доступа.
- UPS.Com имя пользователя, пароль и созданный ключ доступа будут обязательными учетными данными.
Начало работы с соединителем
Следуйте инструкциям https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider , чтобы включить поставщика UPS.
Известные проблемы и ограничения
Этот соединитель специально разработан для интеграции поставщика UPS в Dynamics 365 Intelligent Order Management. Поддержка вариантов использования за пределами Dynamics 365 Intelligent Order Management будет ограничена.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Описание | Обязательный |
|---|---|---|---|
| Среда: песочница или рабочая среда | струна | Среда песочницы UPS или рабочая среда | True |
| Ключ доступа | securestring | Ключ доступа, полученный с помощью процесса подключения UPS | True |
| Имя пользователя | струна | Имя пользователя учетной записи MyUPS | True |
| Пароль | securestring | Пароль учетной записи MyUPS | True |
| Источник транзакций | струна | Идентифицирует вызывающие клиенты или исходное приложение. | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Локатор |
API указателя предоставляет полные службы UPS и расположения самообслуживания, часы работы и время сбора. |
| Отмена отправки |
API отмены отгрузки используется для отмены ранее запланированной поставки. |
| Отслеживание |
API отслеживания поддерживает поставки пакетов, наземных грузовых и воздушных грузов. |
| Создание отгрузки |
Создание API отправки дает приложению множество способов управления доставкой пакетов в их назначение. |
| Уровень улицы проверки адресов |
API уровня проверки адресов можно использовать для проверки адресов в базе данных почтовой службы США допустимых адресов в США и Пуэрто-Рико. |
Локатор
API указателя предоставляет полные службы UPS и расположения самообслуживания, часы работы и время сбора.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
CustomerContext
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
Предоставленные клиентом данные. Может быть XML. Если эти данные присутствуют в запросе, он возвращается клиенту. |
|
XpciVersion
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
Определяет версию сообщения. |
|
Код статуса ответа (ResponseStatusCode)
|
LocatorResponse.Response.ResponseStatusCode | string |
Определяет успешность или неудачу обмена. |
|
ResponseStatusDescription
|
LocatorResponse.Response.ResponseStatusDescription | string |
Описывает код состояния ответа. |
|
ErrorSeverity
|
LocatorResponse.Response.Error.ErrorSeverity | string |
Описывает серьезность ошибки. |
|
ErrorCode
|
LocatorResponse.Response.Error.ErrorCode | string |
Числовое значение, описывающее ошибку. |
|
Описание ошибки
|
LocatorResponse.Response.Error.ErrorDescription | string |
Описывает код ошибки. |
|
Минимальные значенияRetrySeconds
|
LocatorResponse.Response.Error.MinimumRetrySeconds | string |
Количество секунд, дожидающегося повторных попыток. |
|
ErrorLocationElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
Имя Xpath элемента в ошибке. Это допустимый Xpath, указывающий на элемент в документе запроса. |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
Имя атрибута в ошибке. Это имя атрибута, содержащегося в элементе Error Location. |
|
ErrorDigest
|
LocatorResponse.Response.Error.ErrorDigest | string |
Содержимое элемента в ошибке. |
|
Широта
|
LocatorResponse.Geocode.Latitude | string |
Широта исходного адреса, центрального пункта обмена, центрального пункта почтового индекса или центрального пункта города. |
|
Долгота
|
LocatorResponse.Geocode.Longitude | string |
Долгота исходного адреса, центрального пункта обмена, центрального пункта почтового индекса или центрального пункта города. |
|
GeocodeCandidate
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
Отказ от ответственности
|
LocatorResponse.SearchResults.Disclaimer | string |
Отказ от ответственности. В случае, если пользователь запрашивал типы наземных и воздушных служб и максимальный размер списка расположений UPS не выполнен, список расположений будет продолжаться с расположениями, которые предоставляют либо землю, либо воздух в радиусе поиска. |
|
DropLocation
|
LocatorResponse.SearchResults.DropLocation | ||
|
Number
|
LocatorResponse.SearchResults.MapNavigation.Number | string |
Центральный номер расположения удаления, если это хранилище UPS. |
|
Высота
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Height | string |
Значение, предоставленное в запросе, будет возвращено, а ширина изображения по умолчанию снова включена в 200 пикселей. Другие допустимые значения : от 100 до 400. |
|
Ширина
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Width | string |
Значение, предоставленное в запросе, будет возвращено, а ширина изображения по умолчанию снова включена в 200 пикселей. Другие допустимые значения : от 100 до 400. |
|
ZoomFactor
|
LocatorResponse.SearchResults.MapNavigation.ZoomFactor | string |
Фактор, который должен быть в изображении, должен быть для отображения всех расположений UPS. |
|
PanX
|
LocatorResponse.SearchResults.MapNavigation.PanX | string |
Уровень, на котором пользователь хочет сдвигаться на оси X. Никогда не возвращался. После первоначального ответа пользователю может потребоваться просмотреть изображение слева или справа. Для этого требуется еще один запрос со значением 1, 0 или 1. |
|
Пани
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
Уровень, на котором пользователь хочет сдвигаться на оси Y. Начальный запрос, значение по умолчанию равно 0. После первоначального ответа пользователю может потребоваться просмотреть изображение дальше вверх или вниз по оси y. Для этого требуется другой запрос со значением 1, 0 или 1. |
|
MapID
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
Список идентификаторов расположения 5 шифруется в mapID для создания карты. |
|
MapURL
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
Ссылка на карту с пятью расположениями UPS и расположением источника, указанным в MapID. |
|
LocationID
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
Идентификатор расположения определенного расположения UPS. |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
Координата X расположения UPS. |
|
YCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.YCoordinate | string |
Координата Y расположения UPS. |
|
Сегмент
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Segment | string |
Пошаговые инструкции из источника в указанное расположение. |
|
Ценность
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.Value | string |
Вычисляемое расстояние от источника до расположения UPS. |
|
Код
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Code | string |
Единица измерения расстояния. Возвращается единица измерения, используемая в запросе поиска. Возвращаемые значения: MI-Miles. |
|
Описание
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Description | string |
Может возвращать описание единицы измерения, указанной в запросе. Допустимые значения: Мили и Километровые. |
|
Time
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Time | string |
Общий предполагаемый период времени, который потребуется для езды от источника к расположению. |
|
Ценность
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.Value | string |
Расстояние от источника до расположения UPS. |
|
Код
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Code | string |
Единица измерения расстояния. Возвращается единица измерения, используемая в запросе поиска. Возвращаемые значения: MI-Miles. |
|
Описание
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
Может возвращать описание единицы измерения, указанной в запросе. Допустимые значения: Мили и Километровые. |
|
общее_время
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
Общий предполагаемый период времени, который потребуется для езды от источника к расположению. Формат: HHMM. |
|
AvailableLocationAttributes
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
ActiveAvailableAccessPointIndicator
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
Указывает, имеет ли страна или территория AccessPoints или нет. |
|
AllowAllConfidenceLevels
|
LocatorResponse.AllowAllConfidenceLevels | string |
Индикатор, позволяющий обеспечить уровень достоверности в поиске. |
Отмена отправки
API отмены отгрузки используется для отмены ранее запланированной поставки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификационный номер отгрузки
|
shipmentidentificationnumber | True | string |
Идентификационный номер отгрузки. |
|
Номер отслеживания
|
trackingnumber | string |
Номер отслеживания пакета. |
|
|
Идентификатор транзакции
|
transid | True | string |
Идентификатор, уникальный для запроса. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
Определяет успешность или сбой транзакции. |
|
Описание
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
Описывает код состояния ответа. Возвращает текст успешного выполнения. |
|
CustomerContext
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
Предоставленные клиентом данные. Может быть XML. Если эти данные присутствуют в запросе, он возвращается клиенту. |
|
TransactionIdentifier
|
VoidShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Идентификатор, уникальный для запроса. |
|
Код
|
VoidShipmentResponse.SummaryResult.Status.Code | string |
Код состояния сводного результата. |
|
Описание
|
VoidShipmentResponse.SummaryResult.Status.Description | string |
Описание состояния сводного результата. |
|
Код
|
VoidShipmentResponse.PackageLevelResult.Status.Code | string |
Код состояния сводного результата. |
|
Описание
|
VoidShipmentResponse.PackageLevelResult.Status.Description | string |
Описание состояния сводного результата. |
|
TrackingNumber
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
Идентификационный номер пакета. |
Отслеживание
API отслеживания поддерживает поставки пакетов, наземных грузовых и воздушных грузов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер запроса
|
inquiryNumber | True | string |
Номер запроса, используемый для доступа к данным отслеживания UPS. |
|
Идентификатор транзакции
|
transid | True | string |
Идентификатор, уникальный для запроса. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отгрузки
|
trackResponse.shipment | array of object |
Элемент, содержащий сведения о доставке, связанные с номерами запроса. |
|
пакет
|
trackResponse.shipment.package | array of object |
Элемент, содержащий сведения о пакете. |
|
отслеживаниеНомер
|
trackResponse.shipment.package.trackingNumber | string |
Небольшой пакет, почтовые инновации, грузовые или ночные номера отслеживания. |
|
DeliveryDate
|
trackResponse.shipment.package.deliveryDate | ||
|
тип
|
trackResponse.shipment.package.deliveryTime.type | string |
Указывает тип доставки. |
|
startTime
|
trackResponse.shipment.package.deliveryTime.startTime | string |
Время начала, зафиксированное время или время доставки. |
|
EndTime
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
Время окончания окна. |
|
активность
|
trackResponse.shipment.package.activity | array of object |
Элемент контейнера, содержащий действие сканирования, связанное с запросом. |
|
location
|
trackResponse.shipment.package.activity.location | ||
|
тип
|
trackResponse.shipment.package.activity.status.type | string |
Тип действия. |
|
описание
|
trackResponse.shipment.package.activity.status.description | string |
Описание состояния. |
|
код
|
trackResponse.shipment.package.activity.status.code | string |
Код состояния. |
|
date
|
trackResponse.shipment.package.activity.date | string |
Дата действия. |
|
Время
|
trackResponse.shipment.package.activity.time | string |
Время действия. |
Создание отгрузки
Создание API отправки дает приложению множество способов управления доставкой пакетов в их назначение.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор транзакции
|
transid | True | string |
Идентификатор, уникальный для запроса. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код
|
ShipmentResponse.Response.ResponseStatus.Code | string |
Определяет успешность или сбой транзакции. |
|
Описание
|
ShipmentResponse.Response.ResponseStatus.Description | string |
Описывает код состояния ответа. Возвращает текст успешного выполнения. |
|
Alert
|
ShipmentResponse.Response.Alert | ||
|
CustomerContext
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
Предоставленные клиентом данные. Может быть XML. Если эти данные присутствуют в запросе, он возвращается клиенту. |
|
TransactionIdentifier
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Идентификатор, уникальный для запроса. |
|
Отказ от ответственности
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
Код валюты
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
Тип кода валюты BaseServiceCharge. |
|
Денежное значение
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
Сумма базовой платы за обслуживание. |
|
Код валюты
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
Транспортный код взимается. |
|
Денежное значение
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
Сумма стоимости транспорта и дополнительных сборов. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
Код валюты
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
Тип кода валюты для оплаты доступа. Возвращается код валюты, используемый в запросе на доставку. |
|
Денежное значение
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
Сумма стоимости оплаты доступа. |
|
TaxCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
Код валюты
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
Общий тип кода валюты. Возвращается код валюты, используемый в запросе на доставку. |
|
Денежное значение
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
Общая сумма расходов. |
|
Код валюты
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
Тип кода валюты TotalChargesWithTaxes. Возвращается код валюты, используемый в запросе на доставку. |
|
Денежное значение
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
Сумма денежного значения TotalChargesWithTaxes. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
TaxCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
Код валюты
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
Общий код валюты. |
|
Денежное значение
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
Общая сумма расходов на денежное значение. |
|
Код валюты
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
Тип кода валюты TotalChargesWithTaxes. Возвращается код валюты, используемый в запросе на доставку. |
|
Денежное значение
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
Сумма денежного значения TotalChargesWithTaxes. |
|
Код валюты
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
Код валюты валовых сборов. |
|
Денежное значение
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
Валовая стоимость денежных сборов. |
|
Код валюты
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
Код валюты скидок. |
|
Денежное значение
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
Сумма скидки денежной стоимости. |
|
Код валюты
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
Код валюты Net Charge. |
|
Денежное значение
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
Чистая стоимость денежных расходов. |
|
Плотность
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
Плотность возвращается, если грузоотправитель имеет право на частоту на основе плотности. |
|
TotalCubicFeet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
Общий объем кубических футов возвращается, если грузоотправитель имеет право на частоту на основе плотности. |
|
ОбработкаUnits
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
RatingMethod
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
RatingMethod заключается в том, чтобы указать, был ли указан уровень отгрузки или уровень пакета. Эти сведения будут возвращены только в том случае, если в запросе присутствует RatingMethodRequestedIndicator. Допустимые значения: 01 = уровень отгрузки 02 = уровень пакета. |
|
BillableWeightCalculationMethod
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
BillableWeightCalculationMethod заключается в том, чтобы указать, использовался ли оплачиваемый метод вычисления веса — уровень пакета или уровень отгрузки. Эти сведения будут возвращены только в том случае, если в запросе присутствует RatingMethodRequestedIndicator. |
|
Код
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
Код единиц измерения веса выставления счетов. Значения: КГС или LBS. |
|
Описание
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Description | string |
Описание единиц измерения веса выставления счетов. |
|
Вес
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
Вес выставления счетов. Выше фактического веса отгрузки по сравнению с объемным объемом отгрузки. |
|
ОтправкаIdentificationNumber
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
Возвращен идентификатор поставки UPS.1Z первого пакета в отгрузке. |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
MIDualReturnShipmentKey является уникальным ключом, необходимым для обработки почтовых инноваций двойной возвращаемой отправки. |
|
ДоставкаDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
Параметры доставки в кодировке, необходимые для прохождения на этапе принятия. Применимо только для ShipConfirmResponse. |
|
PackageResults
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
Код
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Code | string |
Код для типа графического изображения для отчета с высоким значением. |
|
Описание
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Description | string |
Описание кода формата. |
|
Графическийimage
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Базовый 64 кодированный html, EPL2, ZPL или SPL-образ. Применимо только для ShipmentResponse и ShipAcceptResponse. |
|
Код
|
ShipmentResponse.ShipmentResults.Form.Code | string |
Код, указывающий тип формы. Применимо только для ShipmentResponse и ShipAcceptResponse. Допустимые значения: 01 — все запрошенные международные формы. |
|
Описание
|
ShipmentResponse.ShipmentResults.Form.Description | string |
Описание, указывающее тип формы. Возможные значения. Все запрошенные международные формы. Применимо только для ShipmentResponse и ShipAcceptResponse. |
|
Код
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
Код, представляющий формат, в котором создаются формы. Применимо только для ShipmentResponse и ShipAcceptResponse. Допустимое значение: PDF = только pdf. |
|
Описание
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
Описание кода формата изображения формы. |
|
Графическийimage
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Изображение международных форм в кодировке Base 64. Применимо только для ShipmentResponse и ShipAcceptResponse. |
|
FormGroupId
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
Уникальный идентификатор для последующего получения сохраненной версии завершенных международных форм. Всегда возвращается при коде = 01. 01 представляет международные формы. Применимо только для ShipmentResponse и ShipAcceptResponse. |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
Содержит текст описания, определяющий группу международных форм. Этот элемент является частью запроса и ответа. Этот элемент не отображается в формах. Применимо только для ShipmentResponse и ShipAcceptResponse. |
|
Код
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
Форматирование кода созданного кодового поворота страницы. Допустимые значения: HTML = ФОРМАТ HTML. Только html-формат поддерживается для поворота COD-страницы. Применимо только для ShipmentResponse и ShipAcceptResponse. |
|
Описание
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
Описание кода форматирования созданного кодового поворота страницы. Применимо только для ShipmentResponse и ShipAcceptResponse. |
|
Графическийimage
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Программное обеспечение отрисовки изображений браузера в кодировке Base 64. Применимо только для ShipmentResponse и ShipAcceptResponse. |
|
Код
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
Код, представляющий формат, в котором создается отчет с высоким уровнем ценности. Допустимые значения: PDF = pdf. |
|
Описание
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Description | string |
Описание формата изображения. |
|
Графическийimage
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Изображение PDF в кодировке Base 64. |
|
LabelURL
|
ShipmentResponse.ShipmentResults.LabelURL | string |
URL-адрес будет указывать на страницу, на которой можно запросить инструкции По меткам, квитанциям и другим документам, таким как HighValueReport, CustomsInvoice и ImportControl. LabelURL возвращается только в том случае, если labelLinksIndicator запрашивается для следующих поставок: печать/электронная доставка импорта, печать/электронный, возврат поставки, пересылка, за исключением почтовых инноваций Forward. |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
URL-адрес будет указывать на страницу, на которой можно запросить инструкции По меткам, квитанциям и другим документам, таким как HighValueReport, CustomsInvoice и ImportControl. LocalLanguageLabelURL возвращается только в том случае, если LabelLinksIndicator запрашивается для следующих поставок: печать/электронная отправка импорта, отправка печати и электронного возврата, пересылка, за исключением пересылки почтовых инноваций, не возвращается, если LabelLinksIndicator запрашивается с помощью элемента Locale. |
|
ReceiptURL
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
URL-адрес будет указывать на страницу, на которой можно запросить инструкции По меткам, квитанциям и другим документам, таким как HighValueReport, CustomsInvoice и ImportControl. Квитанция возвращается только в том случае, если меткаLinksIndicator запрашивается для следующих поставок: отправка Print/Electronic ImportControl, печать или электронная доставка возврата. |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
URL-адрес будет указывать на страницу, на которой можно запросить инструкции По меткам, квитанциям и другим документам, таким как HighValueReport, CustomsInvoice и ImportControl. LocalLanguageReceiptURL возвращается только в том случае, если LabelLinksIndicator запрашивается для следующих поставок: печать/электронная доставка ImportControl, печать и электронный возврат, пересылка, за исключением пересылки почтовых инноваций, не возвращается, если LabelLinksIndicator запрашивается с помощью элемента Locale. |
|
DGPaperImage
|
ShipmentResponse.ShipmentResults.DGPaperImage | string |
Dangrous Good Paper Image в формате PDF. Будет возвращен один документ PDF с несколькими страницами, содержащий все необходимые копии бумаги для доставки товаров Dangrous для всех пакетов опасных товаров. Возвращается только при наличии DGSignatoryInfo. |
|
MasterCartonID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
Главный картон идентификатор. MasterCartonID будет возвращен, если MasterCartonIndicator присутствует в запросе. |
Уровень улицы проверки адресов
API уровня проверки адресов можно использовать для проверки адресов в базе данных почтовой службы США допустимых адресов в США и Пуэрто-Рико.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Параметр запроса
|
requestoption | True | integer |
Параметр запроса проверки адреса. |
|
Индикатор регионального запроса
|
regionalrequestIndicator | string |
Индикатор регионального запроса проверки адреса. |
|
|
Максимальный размер списка кандидатов
|
maximumcandidatelistsize | integer |
Максимальный размер списка кандидатов запроса на проверку адреса. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код
|
XAVResponse.Response.ResponseStatus.Code | string |
Код предупреждения, возвращаемый системой. |
|
Описание
|
XAVResponse.Response.ResponseStatus.Description | string |
Сообщение, возвращенное системой. |
|
ValidAddressIndicator
|
XAVResponse.ValidAddressIndicator | string |
Запрос нашел допустимое совпадение. |
|
НеоднозначныйAddressIndicator
|
XAVResponse.AmbiguousAddressIndicator | string |
Указывает, что запрос не удалось найти совпадение на основе предоставленной информации. |
|
NoCandidatesIndicator
|
XAVResponse.NoCandidatesIndicator | string |
Кандидат не найден. |
|
Код
|
XAVResponse.AddressClassification.Code | string |
Содержит код классификации входного адреса. |
|
Описание
|
XAVResponse.AddressClassification.Description | string |
Содержит текстовое описание кода классификации адресов. |
|
Кандидат
|
XAVResponse.Candidate |