UPS (wersja zapoznawcza)
United Parcel Service (UPS) zapewnia klientom i firmom na całym świecie szerokie portfolio usług transportowych, handlu elektronicznego i usług biznesowych. Połącz się z interfejsami API UPS, aby zweryfikować adres, lokalizacje wyszukiwania, utworzyć przesyłkę, śledzić przesyłki itp.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Service | Klasa | Regiony |
|---|---|---|
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: - Azure Government regionów - Azure regionach Chin - Departament Obrony USA (DoD) |
| Kontakt biznesowy | |
|---|---|
| Nazwa | Microsoft Dynamics |
| adres URL | https://aka.ms/iomsupport |
| iomdri@microsoft.com |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft |
| Witryna internetowa | https://www.ups.com/us/en/services/technology-integration.page |
| Zasady ochrony prywatności | https://www.ups.com/us/en/help-center/legal-terms-conditions/privacy-notice.page |
| Kategorie | Produktywność |
Łącznik United Parcel Service (UPS) został specjalnie opracowany do użycia na potrzeby integracji dostawcy usług Dynamics 365 Intelligent Order Management.
Wymagania wstępne
- Zarejestruj się w celu uzyskania profilu UPS.com z witryny https://www.ups.com/upsdeveloperkit?loc=en_US.
Jak uzyskać poświadczenia
- Uzyskaj dostęp.https://www.ups.com/upsdeveloperkit?loc=en_US
- Zaloguj się, aby nawiązać połączenie z kontem.
- Użyj opcji "Zażądaj klucza dostępu", aby wygenerować klucz dostępu.
- UPS.Com nazwa użytkownika logowania profilu, hasło i wygenerowany klucz dostępu będą wymaganymi poświadczeniami.
Wprowadzenie do łącznika
Postępuj zgodnie z instrukcjami https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider , aby włączyć dostawcę UPS.
Znane problemy i ograniczenia
Ten łącznik został specjalnie opracowany do użycia na potrzeby integracji dostawcy UPS usługi Dynamics 365 Intelligent Order Management. Obsługa przypadków użycia poza usługą Dynamics 365 Intelligent Order Management będzie ograniczona.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Nazwa | Typ | Opis | Wymagane |
|---|---|---|---|
| Środowisko: piaskownica lub produkcja | ciąg | Środowisko piaskownicy UPS lub środowisko produkcyjne | Prawda |
| Klucz dostępu | securestring | Klucz dostępu uzyskany za pośrednictwem procesu dołączania ups | Prawda |
| Nazwa użytkownika | ciąg | Nazwa użytkownika konta MyUPS | Prawda |
| Hasło | securestring | Hasło konta myUPS | Prawda |
| Źródło transakcji | ciąg | Identyfikuje klientów/aplikację źródłową wywołującą | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Anulowanie wysyłki |
Interfejs API anulowania wysyłki służy do anulowania wcześniej zaplanowanej wysyłki. |
| Lokalizator |
Interfejs API lokalizatora zapewnia lokalizacje pełnej obsługi i samoobsługi UPS, godziny pracy i odbioru. |
| Poziom ulicy weryfikacji adresów |
Interfejs API poziomu ulicy weryfikacji adresów może służyć do sprawdzania adresów względem bazy danych Usługi pocztowej Stanów Zjednoczonych prawidłowych adresów w STANACH Zjednoczonych i Portoryko. |
| Tworzenie przesyłki |
Interfejs API tworzenia przesyłek udostępnia aplikacji wiele sposobów zarządzania wysyłką pakietów do miejsca docelowego. |
| Śledzenie |
Interfejs API śledzenia obsługuje przesyłki Package, Ground Freight i Air Freight. |
Anulowanie wysyłki
Interfejs API anulowania wysyłki służy do anulowania wcześniej zaplanowanej wysyłki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer identyfikacyjny przesyłki
|
shipmentidentificationnumber | True | string |
Numer identyfikacyjny przesyłki. |
|
Numer śledzenia
|
trackingnumber | string |
Numer śledzenia pakietu. |
|
|
Identyfikator transakcji
|
transid | True | string |
Identyfikator unikatowy dla żądania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Code
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
Określa powodzenie lub niepowodzenie transakcji. |
|
Opis
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
Opisuje kod stanu odpowiedzi. Zwraca tekst powodzenia. |
|
CustomerContext
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
Dane podane przez klienta. Może to być plik XML. Jeśli te dane znajdują się w żądaniu, są zwracane z powrotem do klienta. |
|
TransactionIdentifier
|
VoidShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Identyfikator unikatowy dla żądania. |
|
Code
|
VoidShipmentResponse.SummaryResult.Status.Code | string |
Kod stanu wyniku podsumowania. |
|
Opis
|
VoidShipmentResponse.SummaryResult.Status.Description | string |
Opis stanu wyniku podsumowania. |
|
Code
|
VoidShipmentResponse.PackageLevelResult.Status.Code | string |
Kod stanu wyniku podsumowania. |
|
Opis
|
VoidShipmentResponse.PackageLevelResult.Status.Description | string |
Opis stanu wyniku podsumowania. |
|
Numer śledzenia
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
Numer identyfikacyjny pakietu. |
Lokalizator
Interfejs API lokalizatora zapewnia lokalizacje pełnej obsługi i samoobsługi UPS, godziny pracy i odbioru.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
CustomerContext
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
Dane podane przez klienta. Może to być plik XML. Jeśli te dane znajdują się w żądaniu, są zwracane z powrotem do klienta. |
|
XpciVersion
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
Identyfikuje wersję komunikatu. |
|
KodStatusuOdpowiedzi
|
LocatorResponse.Response.ResponseStatusCode | string |
Określa powodzenie lub niepowodzenie wymiany. |
|
ResponseStatusDescription
|
LocatorResponse.Response.ResponseStatusDescription | string |
Opisuje kod stanu odpowiedzi. |
|
ErrorSeverity (Zależnie od błędów)
|
LocatorResponse.Response.Error.ErrorSeverity | string |
Opisuje ważność błędu. |
|
ErrorCode
|
LocatorResponse.Response.Error.ErrorCode | string |
Wartość liczbowa opisującą błąd. |
|
Opis błędu
|
LocatorResponse.Response.Error.ErrorDescription | string |
Opisuje kod błędu. |
|
MinimumRetrySeconds
|
LocatorResponse.Response.Error.MinimumRetrySeconds | string |
Liczba sekund oczekiwania na ponowienie próby. |
|
ErrorLocationElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
Nazwa Xpath elementu w błędzie. Jest to prawidłowa ścieżka Xpath wskazująca element w dokumencie żądania. |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
Nazwa atrybutu w błędzie. Jest to nazwa atrybutu zawartego w elemecie Error Location. |
|
BłądDigest
|
LocatorResponse.Response.Error.ErrorDigest | string |
Zawartość elementu w błędzie. |
|
Szerokość
|
LocatorResponse.Geocode.Latitude | string |
Szerokość geograficzna adresu początkowego, punkt środkowy wymiany, punkt środkowy kodu pocztowego lub punkt środkowy miasta. |
|
długość geograficzna
|
LocatorResponse.Geocode.Longitude | string |
Długość geograficzna adresu początkowego, punkt środkowy wymiany, punkt środkowy kodu pocztowego lub punkt środkowy miasta. |
|
GeocodeCandidate
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
Disclaimer
|
LocatorResponse.SearchResults.Disclaimer | string |
Zastrzeżenie. W przypadku, gdy użytkownik zażądał typów usług Ground and Air i maksymalny rozmiar listy lokalizacji UPS nie został spełniony, lista lokalizacji będzie kontynuowana z lokalizacjami, które zapewniają ziemię lub powietrze w promieniu wyszukiwania. |
|
DropLocation
|
LocatorResponse.SearchResults.DropLocation | ||
|
Liczba
|
LocatorResponse.SearchResults.MapNavigation.Number | string |
Numer środkowy lokalizacji upuszczania, jeśli jest to sklep UPS. |
|
Wysokość
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Height | string |
Wartość podana w żądaniu zostanie zwrócona, a w przeciwnym razie domyślna szerokość obrazu zostanie ustawiona na 200 pikseli. Inne prawidłowe wartości to od 100 do 400. |
|
Szerokość
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Width | string |
Wartość podana w żądaniu zostanie zwrócona, a w przeciwnym razie domyślna szerokość obrazu zostanie ustawiona na 200 pikseli. Inne prawidłowe wartości to od 100 do 400. |
|
ZoomFactor
|
LocatorResponse.SearchResults.MapNavigation.ZoomFactor | string |
Czynnikiem, który musi być obraz, aby pokazać wszystkie lokalizacje UPS. |
|
PanX
|
LocatorResponse.SearchResults.MapNavigation.PanX | string |
Poziom, na którym użytkownik chce przesuwać się na osi X. Nigdy nie wrócił. Po początkowej odpowiedzi użytkownik może chcieć wyświetlić obraz dalej po lewej stronie lub po prawej stronie. W tym celu wymagane jest inne żądanie z wartością 1, 0 lub 1. |
|
Pany
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
Poziom, na którym użytkownik chce przesuwać się na osi Y. Początkowe żądanie wartości domyślnej to 0. Po początkowej odpowiedzi użytkownik może chcieć wyświetlić obraz dalej w górę lub w dół osi y. W tym celu wymagane jest inne żądanie z wartością 1, 0 lub 1. |
|
Mapid
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
Lista 5 identyfikatorów lokalizacji jest szyfrowana w identyfikatorze MapID dla generowania mapy. |
|
MapURL
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
Link do mapy z pięcioma lokalizacjami UPS i lokalizacją pochodzenia określoną w mapie MapID. |
|
Locationid
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
Identyfikator lokalizacji określonej lokalizacji UPS. |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
Współrzędna X lokalizacji UPS. |
|
YCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.YCoordinate | string |
Współrzędna Y lokalizacji UPS. |
|
Segment
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Segment | string |
Wskazówki krok po kroku z źródła do określonej lokalizacji. |
|
Wartość
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.Value | string |
Obliczona odległość od punktu początkowego do lokalizacji UPS. |
|
Code
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Code | string |
Jednostka odległości kodu miary. Zwracana jest jednostka miary używana w żądaniu wyszukiwania. Zwracane wartości to: MI-Miles. |
|
Opis
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Description | string |
Może zwrócić opis jednostki miary określonej w żądaniu. Prawidłowe wartości to: Mile i Kilometr. |
|
Time
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Time | string |
Łączny szacowany okres czasu, jaki zajęłoby przejście z miejsca początkowego do lokalizacji. |
|
Wartość
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.Value | string |
Prosta odległość od punktu początkowego do lokalizacji UPS. |
|
Code
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Code | string |
Jednostka odległości kodu miary. Zwracana jest jednostka miary używana w żądaniu wyszukiwania. Zwracane wartości to: MI-Miles. |
|
Opis
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
Może zwrócić opis jednostki miary określonej w żądaniu. Prawidłowe wartości to: Mile i Kilometr. |
|
Całkowity czas
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
Łączny szacowany okres czasu, jaki zajęłoby przejście z miejsca początkowego do lokalizacji. Format: HHMM. |
|
AvailableLocationAttributes
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
ActiveAvailableAccessPointIndicator
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
Wskazuje, czy kraj lub terytorium ma punkty dostępu, czy nie. |
|
AllowAllConfidenceLevels
|
LocatorResponse.AllowAllConfidenceLevels | string |
Wskaźnik umożliwiający uzyskanie poziomu ufności w wyszukiwaniu. |
Poziom ulicy weryfikacji adresów
Interfejs API poziomu ulicy weryfikacji adresów może służyć do sprawdzania adresów względem bazy danych Usługi pocztowej Stanów Zjednoczonych prawidłowych adresów w STANACH Zjednoczonych i Portoryko.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Opcja żądania
|
requestoption | True | integer |
Opcja żądania żądania weryfikacji adresu. |
|
Wskaźnik żądania regionalnego
|
regionalrequestIndicator | string |
Regionalny wskaźnik żądania weryfikacji adresu. |
|
|
Maksymalny rozmiar listy kandydatów
|
maximumcandidatelistsize | integer |
Maksymalny rozmiar listy kandydatów żądania weryfikacji adresu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Code
|
XAVResponse.Response.ResponseStatus.Code | string |
Kod ostrzegawczy zwrócony przez system. |
|
Opis
|
XAVResponse.Response.ResponseStatus.Description | string |
Komunikat zwrócony z systemu. |
|
ValidAddressIndicator
|
XAVResponse.ValidAddressIndicator | string |
Zapytanie znalazło prawidłowe dopasowanie. |
|
AmbiguousAddressIndicator
|
XAVResponse.AmbiguousAddressIndicator | string |
Wskazuje, że zapytanie nie może odnaleźć dopasowania na podstawie podanych informacji. |
|
NoCandidatesIndicator
|
XAVResponse.NoCandidatesIndicator | string |
Nie znaleziono kandydata. |
|
Code
|
XAVResponse.AddressClassification.Code | string |
Zawiera kod klasyfikacji adresu wejściowego. |
|
Opis
|
XAVResponse.AddressClassification.Description | string |
Zawiera opis tekstowy kodu klasyfikacji adresów. |
|
Kandydat
|
XAVResponse.Candidate |
Tworzenie przesyłki
Interfejs API tworzenia przesyłek udostępnia aplikacji wiele sposobów zarządzania wysyłką pakietów do miejsca docelowego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator transakcji
|
transid | True | string |
Identyfikator unikatowy dla żądania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Code
|
ShipmentResponse.Response.ResponseStatus.Code | string |
Określa powodzenie lub niepowodzenie transakcji. |
|
Opis
|
ShipmentResponse.Response.ResponseStatus.Description | string |
Opisuje kod stanu odpowiedzi. Zwraca tekst powodzenia. |
|
Alarm
|
ShipmentResponse.Response.Alert | ||
|
CustomerContext
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
Dane podane przez klienta. Może to być plik XML. Jeśli te dane znajdują się w żądaniu, są zwracane z powrotem do klienta. |
|
TransactionIdentifier
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Identyfikator unikatowy dla żądania. |
|
Disclaimer
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
Kod waluty
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
BaseServiceCharge typ kodu waluty. |
|
Wartość pieniężna
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
Podstawowa kwota opłaty za usługę. |
|
Kod waluty
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
Typ kodu waluty opłat za transport. |
|
Wartość pieniężna
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
Kwota wartości transportu i dopłat. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
Kod waluty
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
Typ kodu waluty opłat pomocniczych. Zwracany jest kod waluty używany w żądaniu wysyłki. |
|
Wartość pieniężna
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
Kwota wartości opłat akcesoriów. |
|
Opłaty podatkowe
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
Kod waluty
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
Łączny typ kodu waluty opłat. Zwracany jest kod waluty używany w żądaniu wysyłki. |
|
Wartość pieniężna
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
Łączna kwota wartości opłat. |
|
Kod waluty
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes, typ kodu waluty. Zwracany jest kod waluty używany w żądaniu wysyłki. |
|
Wartość pieniężna
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes kwota wartości pieniężnej. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
Opłaty podatkowe
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
Kod waluty
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
Łączna liczba opłat w kodzie waluty. |
|
Wartość pieniężna
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
Łączna wartość pieniężna opłat. |
|
Kod waluty
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes, typ kodu waluty. Zwracany jest kod waluty używany w żądaniu wysyłki. |
|
Wartość pieniężna
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes kwota wartości pieniężnej. |
|
Kod waluty
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
Kod waluty opłat brutto. |
|
Wartość pieniężna
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
Wartość pieniężna opłat brutto. |
|
Kod waluty
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
Kod waluty kwota rabatu. |
|
Wartość pieniężna
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
Wartość pieniężna kwoty rabatu. |
|
Kod waluty
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
Kod waluty opłaty netto. |
|
Wartość pieniężna
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
Wartość pieniężna opłat netto. |
|
Gęstość
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
Gęstość jest zwracana, jeśli nadawca kwalifikuje się do stawki opartej na gęstości. |
|
TotalCubicFeet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
Całkowita stopa sześcienna jest zwracana, jeśli nadawca kwalifikuje się do współczynnika na podstawie gęstości. |
|
Obsługa jednostek
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
OcenaMethod
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
RatingMethod wskazuje, czy przesyłka została oceniona jako poziom wysyłki, czy poziom pakietu. Te informacje zostaną zwrócone tylko wtedy, gdy element RatingMethodRequestedIndicator znajduje się w żądaniu. Prawidłowe wartości: 01 = poziom wysyłki 02 = poziom pakietu. |
|
BillableWeightCalculationMethod
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
BillableWeightCalculationMethod wskazuje, czy użyto metody obliczania wagi rozliczanej — poziomu pakietu lub poziomu wysyłki. Te informacje zostaną zwrócone tylko wtedy, gdy element RatingMethodRequestedIndicator znajduje się w żądaniu. |
|
Code
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
Kod jednostek miary wagi rozliczeniowej. Wartości to: KGS lub LBS. |
|
Opis
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Description | string |
Opis jednostek miary wagi rozliczeniowej. |
|
Weight
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
Waga rozliczeń. Wyższa od rzeczywistej wagi przesyłki w porównaniu z wagą wymiarową przesyłki. |
|
ShipmentIdentificationNumber
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
Zwrócony numer identyfikacyjny przesyłki UPS.1Z Numer pierwszego pakietu w przesyłki. |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
KLUCZ MIDualReturnShipmentKey jest unikatowym kluczem wymaganym do przetworzenia podwójnej wysyłki zwrotnej Mail Innovation. |
|
WysyłkaDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
Zakodowane parametry wysyłki wymagane do przekazania w fazie akceptowania. Dotyczy tylko elementu ShipConfirmResponse. |
|
PackageResults
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
Code
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Code | string |
Kod typu Obraz graficzny raportu o wysokiej wartości. |
|
Opis
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Description | string |
Opis kodu formatu. |
|
Obraz graficzny
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Kodowany w formacie Base 64 obraz HTML, EPL2, ZPL lub SPL. Dotyczy tylko wysyłkiResponse i ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Code | string |
Kod wskazujący typ formularza. Dotyczy tylko wysyłkiResponse i ShipAcceptResponse. Prawidłowe wartości: 01 — wszystkie żądane formularze międzynarodowe. |
|
Opis
|
ShipmentResponse.ShipmentResults.Form.Description | string |
Opis wskazujący typ formularza. Możliwe wartości. Wszystkie żądane formularze międzynarodowe. Dotyczy tylko wysyłkiResponse i ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
Kod reprezentujący format, w którym są generowane formularze. Dotyczy tylko wysyłkiResponse i ShipAcceptResponse. Prawidłowa wartość: PDF = tylko plik pdf. |
|
Opis
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
Opis kodu formatu obrazu formularza. |
|
Obraz graficzny
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Obraz międzynarodowych formularzy zakodowany w formacie Base 64. Dotyczy tylko wysyłkiResponse i ShipAcceptResponse. |
|
FormGroupId
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
Unikatowy identyfikator późniejszego pobierania zapisanej wersji ukończonych formularzy międzynarodowych. Zawsze zwracany, gdy kod = 01. 01 reprezentuje międzynarodowe formy. Dotyczy tylko wysyłkiResponse i ShipAcceptResponse. |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
Zawiera tekst opisu, który identyfikuje grupę formularzy międzynarodowych. Ten element jest częścią żądania i odpowiedzi. Ten element nie jest wyświetlany w formularzach. Dotyczy tylko wysyłkiResponse i ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
Formatuj kod wygenerowanego zwrotu kodu COD na stronie. Prawidłowe wartości: HTML = format HTML. Tylko format HTML jest obsługiwany dla funkcji COD Turn In Page. Dotyczy tylko wysyłkiResponse i ShipAcceptResponse. |
|
Opis
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
Opis kodu formatu wygenerowanej strony z kolei cod. Dotyczy tylko wysyłkiResponse i ShipAcceptResponse. |
|
Obraz graficzny
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Oprogramowanie do renderowania obrazów przeglądarki HTML zakodowane w formacie Base 64. Dotyczy tylko wysyłkiResponse i ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
Kod reprezentujący format, w którym jest generowany raport o wysokiej wartości. Prawidłowe wartości: PDF = pdf. |
|
Opis
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Description | string |
Opis formatu obrazu. |
|
Obraz graficzny
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Obraz PDF zakodowany w formacie Base 64. |
|
LabelURL
|
ShipmentResponse.ShipmentResults.LabelURL | string |
Adres URL wskazuje stronę, na której można zażądać instrukcji etykiet, potwierdzenia i innych dokumentów, takich jak HighValueReport, CustomsInvoice i ImportControl. Właściwość LabelURL jest zwracana tylko wtedy, gdy żądana jest etykieta LabelLinksIndicator dla następujących przesyłek: Print/Electronic ImportControl, Print/Electronic, Return shipment, Forward z wyjątkiem usługi Mail Innovation Forward. |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
Adres URL wskazuje stronę, na której można zażądać instrukcji etykiet, potwierdzenia i innych dokumentów, takich jak HighValueReport, CustomsInvoice i ImportControl. LocalLanguageLabelURL jest zwracany tylko wtedy, gdy żądana jest etykietaLinksIndicator dla następujących przesyłek: Drukuj/Elektroniczna przesyłka ImportControl, Drukuj/Elektroniczna wysyłka zwrotna, z wyjątkiem wysyłki Mail Innovation Forward, Nie jest zwracana, jeśli element LabelLinksIndicator jest żądany z elementem Ustawień regionalnych. |
|
ReceiptURL
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
Adres URL wskazuje stronę, na której można zażądać instrukcji etykiet, potwierdzenia i innych dokumentów, takich jak HighValueReport, CustomsInvoice i ImportControl. ReceiptURL jest zwracany tylko wtedy, gdy żądana jest etykietaLinksIndicator dla następujących przesyłek: Drukuj/Elektroniczna kontrola importu, Drukuj/Elektroniczna przesyłka zwrotna. |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
Adres URL wskazuje stronę, na której można zażądać instrukcji etykiet, potwierdzenia i innych dokumentów, takich jak HighValueReport, CustomsInvoice i ImportControl. Właściwość LocalLanguageReceiptURL jest zwracana tylko wtedy, gdy żądana jest etykietaLinksIndicator dla następujących przesyłek: Print/Electronic ImportControl, Print/Electronic Return shipment, Forward z wyjątkiem opcji Mail Innovation Forward, Nie zwracana, jeśli element LabelLinksIndicator jest żądany z elementem Ustawień regionalnych. |
|
DGPaperImage
|
ShipmentResponse.ShipmentResults.DGPaperImage | string |
Dangrous Good Paper Image w formacie pdf. Zostanie zwrócony jeden wielostronicowy dokument PDF zawierający wszystkie wymagane kopie papieru wysyłkowego Dangrous Goods dla wszystkich pakietów niebezpiecznych towarów. Zwracany jest tylko wtedy, gdy jest obecna dgSignatoryInfo. |
|
Identyfikator MasterCartonID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
Identyfikator głównego kartonu. Identyfikator MasterCartonID zostanie zwrócony, jeśli parametr MasterCartonIndicator jest obecny w żądaniu. |
Śledzenie
Interfejs API śledzenia obsługuje przesyłki Package, Ground Freight i Air Freight.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer zapytania
|
inquiryNumber | True | string |
Numer zapytania używany do uzyskiwania dostępu do informacji śledzenia UPS. |
|
Identyfikator transakcji
|
transid | True | string |
Identyfikator unikatowy dla żądania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wysyłka
|
trackResponse.shipment | array of object |
Element zawierający szczegóły wysyłki skojarzone z numerami zapytania. |
|
pakiet
|
trackResponse.shipment.package | array of object |
Element zawierający szczegóły pakietu. |
|
trackingNumber (numer przesyłki)
|
trackResponse.shipment.package.trackingNumber | string |
Mały pakiet, innowacje poczty, fracht lub numer śledzenia z dnia na dzień. |
|
deliveryDate
|
trackResponse.shipment.package.deliveryDate | ||
|
typ
|
trackResponse.shipment.package.deliveryTime.type | string |
Wskazuje typ dostawy. |
|
startTime
|
trackResponse.shipment.package.deliveryTime.startTime | string |
Godzina rozpoczęcia, czas zatwierdzenia lub czas dostarczenia. |
|
EndTime
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
Godzina zakończenia okna. |
|
działanie
|
trackResponse.shipment.package.activity | array of object |
Element kontenera zawierający działanie skanowania skojarzone z elementem queryNumber. |
|
lokalizacja
|
trackResponse.shipment.package.activity.location | ||
|
typ
|
trackResponse.shipment.package.activity.status.type | string |
Typ działania. |
|
opis
|
trackResponse.shipment.package.activity.status.description | string |
Opis stanu. |
|
kod
|
trackResponse.shipment.package.activity.status.code | string |
Kod stanu. |
|
date
|
trackResponse.shipment.package.activity.date | string |
Data działania. |
|
time
|
trackResponse.shipment.package.activity.time | string |
Czas działania. |