UPS (Vorschau)
United Parcel Service (UPS) bietet Kunden und Unternehmen weltweit ein breites Portfolio an Transport-, E-Commerce- und Business-Dienstleistungen. Stellen Sie eine Verbindung mit UPS-APIs her, um Die Adresse zu überprüfen, Standorte zu durchsuchen, Sendungen zu erstellen, Sendungen zu verfolgen usw.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Service | Klasse | Regions |
|---|---|---|
| Logik-Apps | Standard | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Microsoft Dynamics |
| URL | https://aka.ms/iomsupport |
| E‑Mail | iomdri@microsoft.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Microsoft |
| Website | https://www.ups.com/us/en/services/technology-integration.page |
| Datenschutzrichtlinie | https://www.ups.com/us/en/help-center/legal-terms-conditions/privacy-notice.page |
| Kategorien | Produktivität |
United Parcel Service (UPS)-Connector wurde speziell für die Integration von Dynamics 365 Intelligent Order Management entwickelt.
Voraussetzungen
- Registrieren Sie sich für UPS.com Profil von https://www.ups.com/upsdeveloperkit?loc=en_US.
So erhalten Sie Anmeldeinformationen
- Access https://www.ups.com/upsdeveloperkit?loc=en_US.
- Melden Sie sich an, um eine Verbindung mit Ihrem Konto herzustellen.
- Verwenden Sie "Zugriffstaste anfordern", um den Zugriffsschlüssel zu generieren.
- UPS.Com Profilanmeldung Benutzername, Kennwort und der generierte Zugriffsschlüssel sind die erforderlichen Anmeldeinformationen.
Erste Schritte mit Ihrem Connector
Folgen Sie https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider , um UPS-Anbieter zu aktivieren.
Bekannte Probleme und Einschränkungen
Dieser Connector wurde speziell für die Integration des UPS-Anbieters von Dynamics 365 Intelligent Order Management entwickelt. Die Unterstützung für Anwendungsfälle außerhalb von Dynamics 365 Intelligent Order Management ist eingeschränkt.
Eine Verbindung wird erstellt
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| Umgebung: Sandkasten oder Produktion | Schnur | UPS Sandbox-Umgebung oder Produktionsumgebung | Richtig |
| Zugriffsschlüssel | securestring | Access Key, der über ups On-Boarding-Prozess erhalten wurde | Richtig |
| Nutzername | Schnur | Benutzername Ihres MyUPS-Kontos | Richtig |
| Passwort | securestring | Kennwort Ihres MyUPS-Kontos | Richtig |
| Transaktionsquelle | Schnur | Identifiziert die Clients/Quellanwendung, die aufgerufen wird | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Lieferung erstellen |
Create Shipment API bietet der Anwendung viele Möglichkeiten, die Lieferung von Paketen an ihr Ziel zu verwalten. |
| Locator |
Locator-API bietet UPS Full-Service- und Self-Service-Standorte, Betriebsstunden und Abholungszeiten. |
| Nachverfolgung |
Die Tracking-API unterstützt Paket-, Boden- und Luftfrachtsendungen. |
| Straßenebene der Adressüberprüfung |
Die Adressüberprüfungs-API kann verwendet werden, um Adressen anhand der Us-Postdienstdatenbank gültiger Adressen in den USA und Puerto Rico zu überprüfen. |
| Versand stornieren |
Die Cancel Shipment API wird verwendet, um die zuvor geplante Lieferung zu stornieren. |
Lieferung erstellen
Create Shipment API bietet der Anwendung viele Möglichkeiten, die Lieferung von Paketen an ihr Ziel zu verwalten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Buchungskennung
|
transid | True | string |
Ein bezeichner, der für die Anforderung eindeutig ist. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Code
|
ShipmentResponse.Response.ResponseStatus.Code | string |
Identifiziert den Erfolg oder Fehler der Transaktion. |
|
Beschreibung
|
ShipmentResponse.Response.ResponseStatus.Description | string |
Beschreibt den Antwortstatuscode. Gibt den Text des Erfolgs zurück. |
|
Warnung
|
ShipmentResponse.Response.Alert | ||
|
CustomerContext
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
Vom Kunden bereitgestellte Daten. Kann XML sein. Wenn diese Daten in der Anforderung vorhanden sind, wird sie an den Kunden zurückgesendet. |
|
TransactionIdentifier
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Ein bezeichner, der für die Anforderung eindeutig ist. |
|
Haftungsausschluss
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
Währungscode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
BaseServiceCharge-Währungscodetyp. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
Base Service Charge value amount. |
|
Währungscode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
Transportgebühren Währungscodetyp. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
Transport- und Zuschläge Wertbetrag. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
Währungscode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
Accessorial charges currency code type. Der in der Versandanfrage verwendete Währungscode wird zurückgegeben. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
Accessorial charges value amount. |
|
TaxCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
Währungscode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
Währungscodetyp gesamt. Der in der Versandanfrage verwendete Währungscode wird zurückgegeben. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
Gesamtbetrag der Gebühren. |
|
Währungscode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes Währungscodetyp. Der in der Versandanfrage verwendete Währungscode wird zurückgegeben. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes Geldwertbetrag. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
TaxCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
Währungscode
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
Währungscode insgesamt. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
Gesamtgebühren geldwert. |
|
Währungscode
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes Währungscodetyp. Der in der Versandanfrage verwendete Währungscode wird zurückgegeben. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes Geldwertbetrag. |
|
Währungscode
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
Bruttokostenwährungscode. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
Bruttogebühren geldwert. |
|
Währungscode
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
Rabattbetragswährungscode. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
Geldwert des Rabattbetrags. |
|
Währungscode
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
Nettokostenwährungscode. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
Nettogebühren geldwert. |
|
Dichte
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
Dichte wird zurückgegeben, wenn der Versandunternehmen für dichtebasierte Rate berechtigt ist. |
|
TotalCubicFeet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
Die Gesamten Kubikfuß werden zurückgegeben, wenn der Versandunternehmen für dichtebasierte Rate berechtigt ist. |
|
HandlingUnits
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
RatingMethod
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
RatingMethod soll angeben, ob die Sendung als Sendungsstufe oder Paketebene bewertet wurde. Diese Informationen werden nur zurückgegeben, wenn RatingMethodRequestedIndicator in der Anforderung vorhanden ist. Gültige Werte: 01 = Sendungsebene 02 = Paketebene. |
|
BillableWeightCalculationMethod
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
BillableWeightCalculationMethod besteht darin, anzugeben, ob die verwendete Berechnungsmethode für die Gewichtung in Rechnung gestellt wurde – die Paket- oder Versandebene. Diese Informationen werden nur zurückgegeben, wenn RatingMethodRequestedIndicator in der Anforderung vorhanden ist. |
|
Code
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
Code der Maßeinheiten für abrechnungsgewichte. Werte sind: KGS oder LBS. |
|
Beschreibung
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Description | string |
Beschreibung der Abrechnungsgewichtsmaßeinheiten. |
|
Gewicht
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
Abrechnungsgewicht. Höher des tatsächlichen Versandgewichts im Vergleich zum Gewicht der Sendung. |
|
ShipmentIdentificationNumber
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
Zurückgegebene UPS-Versandnummer.1Z Nummer des ersten Pakets in der Sendung. |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
MIDualReturnShipmentKey ist ein eindeutiger Schlüssel, der für die Verarbeitung von Mail Innovations Dual Return Shipment erforderlich ist. |
|
VersandDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
Codierte Versandparameter, die in der Annahmephase übergeben werden müssen. Gilt nur für ShipConfirmResponse. |
|
PackageResults
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
Code
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Code | string |
Code für den Typ des Grafikbilds für den Bericht mit hohem Wert. |
|
Beschreibung
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Description | string |
Beschreibung des Formatcodes. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Base64-codiertes HTML-, EPL2-, ZPL- oder SPL-Bild. Gilt nur für ShipmentResponse und ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Code | string |
Code, der den Typ des Formulars angibt. Gilt nur für ShipmentResponse und ShipAcceptResponse. Gültige Werte: 01 – Alle angeforderten internationalen Formulare. |
|
Beschreibung
|
ShipmentResponse.ShipmentResults.Form.Description | string |
Beschreibung, die den Formulartyp angibt. Mögliche Werte. Alle angeforderten internationalen Formulare. Gilt nur für ShipmentResponse und ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
Code, der das Format darstellt, in dem die Formulare generiert werden. Gilt nur für ShipmentResponse und ShipAcceptResponse. Gültiger Wert: PDF = nur PDF. |
|
Beschreibung
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
Beschreibung des Formularbildformatcodes. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Base64-codiertes Bild für internationale Formulare. Gilt nur für ShipmentResponse und ShipAcceptResponse. |
|
FormGroupId
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
Eindeutige ID für späteres Abrufen der gespeicherten Version der ausgefüllten internationalen Formulare. Wird immer zurückgegeben, wenn Code = 01. 01 stellt internationale Formen dar. Gilt nur für ShipmentResponse und ShipAcceptResponse. |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
Enthält Beschreibungstext, der die Gruppe der internationalen Formulare identifiziert. Dieses Element ist Teil von Anforderung und Antwort. Dieses Element wird in den Formularen nicht angezeigt. Gilt nur für ShipmentResponse und ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
Formatcode der generierten COD Turn In Page. Gültige Werte: HTML = HTML-Format. Nur das HTML-Format wird für COD Turn In Page unterstützt. Gilt nur für ShipmentResponse und ShipAcceptResponse. |
|
Beschreibung
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
Beschreibung des Formatcodes der generierten COD Turn In-Seite. Gilt nur für ShipmentResponse und ShipAcceptResponse. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Base64-codierte HTML-Browserbildrenderingsoftware. Gilt nur für ShipmentResponse und ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
Code, der das Format darstellt, in dem der Bericht mit hohem Wert generiert wird. Gültige Werte: PDF = pdf. |
|
Beschreibung
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Description | string |
Beschreibung des Bildformats. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Base64-Codiertes PDF-Bild. |
|
LabelURL
|
ShipmentResponse.ShipmentResults.LabelURL | string |
Die URL verweist auf eine Seite, auf der ggf. Etiketten-, Beleg- und andere Dokumente wie HighValueReport, CustomsInvoice- und ImportControl-Anweisungen angefordert werden können. LabelURL wird nur zurückgegeben, wenn der LabelLinksIndicator für folgende Sendungen angefordert wird: Print/Electronic ImportControl shipment, Print/Electronic, Return shipment, Forward shipment except for Mail Innovations Forward. |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
Die URL verweist auf eine Seite, auf der ggf. Etiketten-, Beleg- und andere Dokumente wie HighValueReport, CustomsInvoice- und ImportControl-Anweisungen angefordert werden können. LocalLanguageLabelURL wird nur zurückgegeben, wenn der LabelLinksIndicator für folgende Sendungen angefordert wird: Print/Electronic ImportControl shipment, Print/Electronic Return shipment, Forward shipment except mail Innovations Forward, Not returned if LabelLinksIndicator is requested with Locale element. |
|
ReceiptURL
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
Die URL verweist auf eine Seite, auf der ggf. Etiketten-, Beleg- und andere Dokumente wie HighValueReport, CustomsInvoice- und ImportControl-Anweisungen angefordert werden können. ReceiptURL wird nur zurückgegeben, wenn der LabelLinksIndicator für folgende Sendungen angefordert wird: Print/Electronic ImportControl shipment, Print/Electronic Return shipment. |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
Die URL verweist auf eine Seite, auf der ggf. Etiketten-, Beleg- und andere Dokumente wie HighValueReport, CustomsInvoice- und ImportControl-Anweisungen angefordert werden können. LocalLanguageReceiptURL wird nur zurückgegeben, wenn der LabelLinksIndicator für folgende Lieferungen angefordert wird: Print/Electronic ImportControl shipment, Print/Electronic Return shipment, Forward shipment except for Mail Innovations Forward, Not returned if LabelLinksIndicator is requested with Locale element. |
|
DGPaperImage
|
ShipmentResponse.ShipmentResults.DGPaperImage | string |
Dangrous Good Paper Image im PDF-Format. Ein mehrseitiges PDF-Dokument wird zurückgegeben, das alle erforderlichen Dangrous Goods Versandpapierkopien für alle Gefahrgutpakete enthält. Wird nur zurückgegeben, wenn DGSignatoryInfo vorhanden ist. |
|
MasterCartonID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
Master-Karton-ID. MasterCartonID wird zurückgegeben, wenn MasterCartonIndicator in Anforderung vorhanden ist. |
Locator
Locator-API bietet UPS Full-Service- und Self-Service-Standorte, Betriebsstunden und Abholungszeiten.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
CustomerContext
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
Vom Kunden bereitgestellte Daten. Kann XML sein. Wenn diese Daten in der Anforderung vorhanden sind, wird sie an den Kunden zurückgesendet. |
|
XpciVersion
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
Identifiziert die Version der Nachricht. |
|
Antwortstatuscode
|
LocatorResponse.Response.ResponseStatusCode | string |
Identifiziert den Erfolg oder Fehler des Austauschs. |
|
ResponseStatusDescription
|
LocatorResponse.Response.ResponseStatusDescription | string |
Beschreibt den Antwortstatuscode. |
|
ErrorSeverity
|
LocatorResponse.Response.Error.ErrorSeverity | string |
Beschreibt den Schweregrad des Fehlers. |
|
ErrorCode
|
LocatorResponse.Response.Error.ErrorCode | string |
Ein numerischer Wert, der den Fehler beschreibt. |
|
Fehlerbeschreibung
|
LocatorResponse.Response.Error.ErrorDescription | string |
Beschreibt den Fehlercode. |
|
MinimumRetrySeconds
|
LocatorResponse.Response.Error.MinimumRetrySeconds | string |
Die Anzahl der Sekunden, die gewartet werden sollen, bis der Wiederholungstest ausgeführt wird. |
|
ErrorLocationElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
Der XPath-Name des Elements im Fehler. Dies ist ein gültiger Xpath, der auf ein Element im Anforderungsdokument zeigt. |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
Der Name des Attributs im Fehler. Dies ist der Name des Attributs, das im Error Location-Element enthalten ist. |
|
ErrorDigest
|
LocatorResponse.Response.Error.ErrorDigest | string |
Der Inhalt des Elements im Fehler. |
|
Breitengrad
|
LocatorResponse.Geocode.Latitude | string |
Der Breitengrad der Ursprungsadresse, des Mittelpunkts des Austauschs, des Mittelpunkts der Postleitzahl oder des Mittelpunkts der Stadt. |
|
Längengrad
|
LocatorResponse.Geocode.Longitude | string |
Der Längengrad der Ursprungsadresse, der Mittelpunkt des Austauschs, des Mittelpunkts der Postleitzahl oder des Mittelpunkts der Stadt. |
|
GeocodeCandidate
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
Haftungsausschluss
|
LocatorResponse.SearchResults.Disclaimer | string |
Gewährleistungsausschluss. Falls der Benutzer boden- und Air-Servicetypen angefordert hat und die maximale UPS-Standortlistengröße nicht erfüllt wurde, wird die Liste der Standorte weiterhin mit Standorten fortgesetzt, die entweder Boden oder Luft innerhalb des Suchradius bereitstellen. |
|
DropLocation
|
LocatorResponse.SearchResults.DropLocation | ||
|
Nummer
|
LocatorResponse.SearchResults.MapNavigation.Number | string |
Die mittlere Nummer des Drop-Speicherorts, wenn es sich um den UPS-Speicher handelt. |
|
Höhe
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Height | string |
Der in der Anforderung angegebene Wert wird zurückgegeben, andernfalls wird die Standardbreite des erneuten Bilds auf 200 Pixel festgelegt. Andere gültige Werte liegen zwischen 100 und 400. |
|
Breite
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Width | string |
Der in der Anforderung angegebene Wert wird zurückgegeben, andernfalls wird die Standardbreite des erneuten Bilds auf 200 Pixel festgelegt. Andere gültige Werte liegen zwischen 100 und 400. |
|
Zoomfactor
|
LocatorResponse.SearchResults.MapNavigation.ZoomFactor | string |
Der Faktor, den das Bild aufweisen muss, um alle UPS-Standorte anzuzeigen. |
|
PanX
|
LocatorResponse.SearchResults.MapNavigation.PanX | string |
Die Ebene, auf die der Benutzer auf der X-Achse schwenken möchte. Nie zurückgegeben. Nach der ersten Antwort möchte der Benutzer das Bild möglicherweise weiter links oder rechts anzeigen. Dazu ist eine weitere Anforderung mit dem Wert 1, 0 oder 1 erforderlich. |
|
Pany
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
Die Ebene, auf der der Benutzer auf der Y-Achse schwenken möchte. Die anfängliche Anforderung, der Standardwert ist 0. Nach der ersten Antwort möchte der Benutzer das Bild möglicherweise weiter nach oben oder unten auf der Y-Achse anzeigen. Dazu ist eine weitere Anforderung mit dem Wert 1, 0 oder 1 erforderlich. |
|
MapID
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
Eine Liste mit fünf Standort-IDs wird innerhalb der MapID für die Kartengenerierung verschlüsselt. |
|
MapURL
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
Eine Verknüpfung mit der Karte mit den fünf UPS-Standorten und der in der MapID angegebenen Ursprungsposition. |
|
LocationID
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
Die Standort-ID eines bestimmten UPS-Standorts. |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
Die X-Koordinate der UPS-Position. |
|
YKoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.YCoordinate | string |
Die Y-Koordinate der UPS-Position. |
|
Segment
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Segment | string |
Schritt-für-Schritt-Wegbeschreibungen vom Ursprung zur angegebenen Position. |
|
Wert
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.Value | string |
Der berechnete Abstand zwischen dem Ursprung und der UPS-Position. |
|
Code
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Code | string |
Die Entfernungseinheit des Maßcodes. Die Maßeinheit, die in der Suchanforderung verwendet wird, wird zurückgegeben. Zurückgegebene Werte sind: MI-Miles. |
|
Beschreibung
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Description | string |
Kann die Beschreibung der maßeinheit zurückgeben, die in der Anforderung angegeben ist. Gültige Werte sind: Meilen und Kilometer. |
|
Uhrzeit
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Time | string |
Die geschätzte Gesamtdauer, die es dauert, um vom Ursprung zum Standort zu fahren. |
|
Wert
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.Value | string |
Der gerade Zeilenabstand vom Ursprung zum UPS-Standort. |
|
Code
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Code | string |
Die Entfernungseinheit des Maßcodes. Die Maßeinheit, die in der Suchanforderung verwendet wird, wird zurückgegeben. Zurückgegebene Werte sind: MI-Miles. |
|
Beschreibung
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
Kann die Beschreibung der maßeinheit zurückgeben, die in der Anforderung angegeben ist. Gültige Werte sind: Meilen und Kilometer. |
|
TotalTime
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
Die geschätzte Gesamtdauer, die es dauert, um vom Ursprung zum Standort zu fahren. Format: HHMM. |
|
AvailableLocationAttributes
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
ActiveAvailableAccessPointIndicator
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
Gibt an, ob das Land oder gebiet AccessPoints hat oder nicht. |
|
AllowAllConfidenceLevels
|
LocatorResponse.AllowAllConfidenceLevels | string |
Indikator, der das Konfidenzniveau bei der Suche zulässt. |
Nachverfolgung
Die Tracking-API unterstützt Paket-, Boden- und Luftfrachtsendungen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfragenummer
|
inquiryNumber | True | string |
Die Anfragenummer, die für den Zugriff auf UPS-Tracking-Informationen verwendet wird. |
|
Buchungskennung
|
transid | True | string |
Ein bezeichner, der für die Anforderung eindeutig ist. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Versand
|
trackResponse.shipment | array of object |
Element, das die Lieferdetails enthält, die den Anfragenummern zugeordnet sind. |
|
Paket
|
trackResponse.shipment.package | array of object |
Element, das die Paketdetails enthält. |
|
Sendungsverfolgungsnummer
|
trackResponse.shipment.package.trackingNumber | string |
Das kleine Paket, E-Mail-Innovationen, Fracht- oder Übernachtungsverfolgungsnummer. |
|
DeliveryDate
|
trackResponse.shipment.package.deliveryDate | ||
|
Typ
|
trackResponse.shipment.package.deliveryTime.type | string |
Gibt den Übermittlungstyp an. |
|
startTime
|
trackResponse.shipment.package.deliveryTime.startTime | string |
Die Startzeit, zugesicherte Zeit oder Lieferzeit. |
|
Endzeitpunkt
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
Die Endzeit des Fensters. |
|
Aktivität
|
trackResponse.shipment.package.activity | array of object |
Ein Containerelement, das die Scanaktivität enthält, die der "inquiryNumber" zugeordnet ist. |
|
location
|
trackResponse.shipment.package.activity.location | ||
|
Typ
|
trackResponse.shipment.package.activity.status.type | string |
Aktivitätstyp. |
|
Beschreibung
|
trackResponse.shipment.package.activity.status.description | string |
Statusbeschreibung. |
|
Programmcode
|
trackResponse.shipment.package.activity.status.code | string |
Statuscode. |
|
date
|
trackResponse.shipment.package.activity.date | string |
Das Datum der Aktivität. |
|
time
|
trackResponse.shipment.package.activity.time | string |
Die Zeit der Aktivität. |
Straßenebene der Adressüberprüfung
Die Adressüberprüfungs-API kann verwendet werden, um Adressen anhand der Us-Postdienstdatenbank gültiger Adressen in den USA und Puerto Rico zu überprüfen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anforderungsoption
|
requestoption | True | integer |
Die Anforderungsoption der Adressüberprüfungsanforderung. |
|
Indikator für regionale Anforderung
|
regionalrequestIndicator | string |
Der regionale Anforderungsindikator der Adressüberprüfungsanforderung. |
|
|
Maximale Größe der Kandidatenliste
|
maximumcandidatelistsize | integer |
Die maximale Größe der Kandidatenliste der Adressüberprüfungsanforderung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Code
|
XAVResponse.Response.ResponseStatus.Code | string |
Vom System zurückgegebener Warncode. |
|
Beschreibung
|
XAVResponse.Response.ResponseStatus.Description | string |
Vom System zurückgegebene Nachricht. |
|
ValidAddressIndicator
|
XAVResponse.ValidAddressIndicator | string |
Die Abfrage hat eine gültige Übereinstimmung gefunden. |
|
MehrdeutigeAddressIndicator
|
XAVResponse.AmbiguousAddressIndicator | string |
Gibt an, dass die Abfrage basierend auf den bereitgestellten Informationen keine Übereinstimmung finden konnte. |
|
NoCandidatesIndicator
|
XAVResponse.NoCandidatesIndicator | string |
Es wurde kein Kandidat gefunden. |
|
Code
|
XAVResponse.AddressClassification.Code | string |
Enthält den Klassifizierungscode der Eingabeadresse. |
|
Beschreibung
|
XAVResponse.AddressClassification.Description | string |
Enthält die Textbeschreibung des Adressklassifizierungscodes. |
|
Kandidat
|
XAVResponse.Candidate |
Versand stornieren
Die Cancel Shipment API wird verwendet, um die zuvor geplante Lieferung zu stornieren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Versandidentifikationsnummer
|
shipmentidentificationnumber | True | string |
Die Identifikationsnummer der Sendung. |
|
Nachverfolgungsnummer
|
trackingnumber | string |
Die Nachverfolgungsnummer des Pakets. |
|
|
Buchungskennung
|
transid | True | string |
Ein bezeichner, der für die Anforderung eindeutig ist. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Code
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
Identifiziert den Erfolg oder Fehler der Transaktion. |
|
Beschreibung
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
Beschreibt den Antwortstatuscode. Gibt den Text des Erfolgs zurück. |
|
CustomerContext
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
Vom Kunden bereitgestellte Daten. Kann XML sein. Wenn diese Daten in der Anforderung vorhanden sind, wird sie an den Kunden zurückgesendet. |
|
TransactionIdentifier
|
VoidShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
Ein bezeichner, der für die Anforderung eindeutig ist. |
|
Code
|
VoidShipmentResponse.SummaryResult.Status.Code | string |
Code für den Status des Zusammenfassungsergebnisses. |
|
Beschreibung
|
VoidShipmentResponse.SummaryResult.Status.Description | string |
Beschreibung des Status des Zusammenfassungsergebnisses. |
|
Code
|
VoidShipmentResponse.PackageLevelResult.Status.Code | string |
Code für den Status des Zusammenfassungsergebnisses. |
|
Beschreibung
|
VoidShipmentResponse.PackageLevelResult.Status.Description | string |
Beschreibung des Status des Zusammenfassungsergebnisses. |
|
TrackingNumber
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
Die Identifikationsnummer des Pakets. |