UPS (förhandsversion)
United Parcel Service (UPS) ger kunder och företag över hela världen en bred portfölj av transport-, e-handels- och affärstjänster. Anslut till UPS-API:er för att verifiera adress, sökplatser, skapa leverans, spåra försändelser osv.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Service | Class | Regioner |
|---|---|---|
| Logiska appar | Standard | Alla Logic Apps-regioner utom följande: - Azure Government regioner - Azure kinaregioner - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Namn | Microsoft Dynamics |
| URL | https://aka.ms/iomsupport |
| E-postmeddelande | iomdri@microsoft.com |
| Metadata för anslutningsprogram | |
|---|---|
| Publisher | Microsoft |
| Webbplats | https://www.ups.com/us/en/services/technology-integration.page |
| Sekretesspolicy | https://www.ups.com/us/en/help-center/legal-terms-conditions/privacy-notice.page |
| Kategorier | Produktivitet |
Anslutningstjänsten United Parcel Service (UPS) har utvecklats specifikt för att användas för Dynamics 365 Intelligent Order Managements providerintegrering.
Förutsättningar
- Registrera dig för UPS.com profil från https://www.ups.com/upsdeveloperkit?loc=en_US.
Hämta autentiseringsuppgifter
- Åtkomst https://www.ups.com/upsdeveloperkit?loc=en_US.
- Logga in för att ansluta till ditt konto.
- Använd "Begär en åtkomstnyckel" för att generera åtkomstnyckeln.
- UPS.Com inloggningsanvändarnamn, lösenord och den genererade åtkomstnyckeln är de autentiseringsuppgifter som krävs.
Komma igång med anslutningsappen
Följ https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider för att aktivera UPS-providern.
Kända problem och begränsningar
Den här anslutningsappen har utvecklats specifikt för att användas för INTEGRERING av UPS-providern för Dynamics 365 Intelligent Order Management. Stöd för användningsfall utanför Dynamics 365 Intelligent Order Management kommer att begränsas.
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| Standardinställning | Parametrar för att skapa anslutning. | Alla regioner | Går inte att dela |
Standard
Tillämpligt: Alla regioner
Parametrar för att skapa anslutning.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
| Namn | Type | Beskrivning | Obligatoriskt |
|---|---|---|---|
| Miljö: Sandbox-miljö eller produktion | snöre | UPS Sandbox-miljö eller produktionsmiljö | Sann |
| Åtkomstnyckel | securestring | Åtkomstnyckel hämtad via UPS-ombordstigningsprocess | Sann |
| Användarnamn | snöre | Användarnamn för ditt MyUPS-konto | Sann |
| Lösenord | securestring | Lösenord för ditt MyUPS-konto | Sann |
| Transaktionskälla | snöre | Identifierar de klienter/källprogram som anropar | Sann |
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| Avbryt leverans |
Cancel Shipment API används för att avbryta den tidigare schemalagda leveransen. |
| Gatunivå för adressverifiering |
API:et för gatunivå för adressverifiering kan användas för att kontrollera adresser mot united states postal service-databasen med giltiga adresser i USA och Puerto Rico. |
| Locator |
Locator-API:et tillhandahåller UPS-platser med full service och självbetjäning, drifttimmar och upphämtningstider. |
| Skapa leverans |
Skapa leverans-API:et ger programmet många sätt att hantera leveransen av paket till målet. |
| Spårning |
Spårnings-API stöder paket-, markfrakt- och flygfraktsändningar. |
Avbryt leverans
Cancel Shipment API används för att avbryta den tidigare schemalagda leveransen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Leveransidentifieringsnummer
|
shipmentidentificationnumber | True | string |
Leveransens ID-nummer. |
|
Spårningsnummer
|
trackingnumber | string |
Paketets spårningsnummer. |
|
|
Transaktions-ID
|
transid | True | string |
En identifierare som är unik för begäran. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kod
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
Identifierar lyckade eller misslyckade transaktioner. |
|
Beskrivning
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
Beskriver svarsstatuskod. Returnerar text av Lyckades. |
|
CustomerContext
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
Kunden tillhandahöll data. Kan vara XML. Om dessa data finns i begäran skickas de tillbaka till kunden. |
|
TransactionIdentifier
|
VoidShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
En identifierare som är unik för begäran. |
|
Kod
|
VoidShipmentResponse.SummaryResult.Status.Code | string |
Kod för status för sammanfattningsresultatet. |
|
Beskrivning
|
VoidShipmentResponse.SummaryResult.Status.Description | string |
Beskrivning av status för sammanfattningsresultatet. |
|
Kod
|
VoidShipmentResponse.PackageLevelResult.Status.Code | string |
Kod för status för sammanfattningsresultatet. |
|
Beskrivning
|
VoidShipmentResponse.PackageLevelResult.Status.Description | string |
Beskrivning av status för sammanfattningsresultatet. |
|
TrackingNumber
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
Paketets ID-nummer. |
Gatunivå för adressverifiering
API:et för gatunivå för adressverifiering kan användas för att kontrollera adresser mot united states postal service-databasen med giltiga adresser i USA och Puerto Rico.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Alternativ för begäran
|
requestoption | True | integer |
Begärandealternativet för begäran om adressverifieringsbegäran. |
|
Indikator för regional begäran
|
regionalrequestIndicator | string |
Den regionala begärandeindikatorn för begäran om adressverifiering. |
|
|
Maximal storlek på kandidatlista
|
maximumcandidatelistsize | integer |
Den maximala storleken på listan över kandidater för begäran om adressverifiering. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kod
|
XAVResponse.Response.ResponseStatus.Code | string |
Varningskod som returneras av systemet. |
|
Beskrivning
|
XAVResponse.Response.ResponseStatus.Description | string |
Meddelande som returneras från systemet. |
|
ValidAddressIndicator
|
XAVResponse.ValidAddressIndicator | string |
Frågan hittade en giltig matchning. |
|
AmbiguousAddressIndicator
|
XAVResponse.AmbiguousAddressIndicator | string |
Anger att frågan inte kunde hitta någon matchning baserat på den angivna informationen. |
|
NoCandidatesIndicator
|
XAVResponse.NoCandidatesIndicator | string |
Ingen kandidat hittades. |
|
Kod
|
XAVResponse.AddressClassification.Code | string |
Innehåller klassificeringskoden för indataadressen. |
|
Beskrivning
|
XAVResponse.AddressClassification.Description | string |
Innehåller textbeskrivningen för adressklassificeringskoden. |
|
Kandidat
|
XAVResponse.Candidate |
Locator
Locator-API:et tillhandahåller UPS-platser med full service och självbetjäning, drifttimmar och upphämtningstider.
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
CustomerContext
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
Kunden tillhandahöll data. Kan vara XML. Om dessa data finns i begäran skickas de tillbaka till kunden. |
|
XpciVersion
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
Identifierar versionen av meddelandet. |
|
SvarStatusKod
|
LocatorResponse.Response.ResponseStatusCode | string |
Identifierar lyckade eller misslyckade utbyten. |
|
ResponseStatusDescription
|
LocatorResponse.Response.ResponseStatusDescription | string |
Beskriver svarsstatuskoden. |
|
ErrorSeverity
|
LocatorResponse.Response.Error.ErrorSeverity | string |
Beskriver allvarlighetsgraden för felet. |
|
Felkod
|
LocatorResponse.Response.Error.ErrorCode | string |
Ett numeriskt värde som beskriver felet. |
|
Felbeskrivning
|
LocatorResponse.Response.Error.ErrorDescription | string |
Beskriver felkoden. |
|
MinimumRetrySeconds
|
LocatorResponse.Response.Error.MinimumRetrySeconds | string |
Antal sekunder att vänta tills du försöker igen. |
|
ErrorLocationElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
Xpath-namnet på elementet i fel. Det här är en giltig Xpath som pekar på ett element i begärandedokumentet. |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
Namnet på attributet i fel. Det här är namnet på attributet som ingår i elementet Felplats. |
|
ErrorDigest
|
LocatorResponse.Response.Error.ErrorDigest | string |
Innehållet i elementet i fel. |
|
Latitud
|
LocatorResponse.Geocode.Latitude | string |
Latitud för ursprungsadressen, mittpunkten för utbytet, mittpunkten för postnumret eller stadens mittpunkt. |
|
Longitud
|
LocatorResponse.Geocode.Longitude | string |
Longitud för ursprungsadressen, mittpunkten för utbytet, mittpunkten för postnumret eller stadens mittpunkt. |
|
GeocodeCandidate
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
Friskrivning
|
LocatorResponse.SearchResults.Disclaimer | string |
Ansvarsfriskrivning. Om användaren begärde ground- och air-tjänsttyper och den maximala ups-platslistans storlek inte har uppfyllts fortsätter listan över platser med platser som tillhandahåller antingen mark eller luft inom sökradien. |
|
DropLocation
|
LocatorResponse.SearchResults.DropLocation | ||
|
Siffra
|
LocatorResponse.SearchResults.MapNavigation.Number | string |
Mittnumret för släppplatsen om det är UPS-butiken. |
|
Höjd
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Height | string |
Värdet som anges i begäran returneras, annars anges standardbredden för bilden på 200 bildpunkter. Andra giltiga värden är mellan 100 och 400. |
|
Bredd
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Width | string |
Värdet som anges i begäran returneras, annars anges standardbredden för bilden på 200 bildpunkter. Andra giltiga värden är mellan 100 och 400. |
|
ZoomFactor
|
LocatorResponse.SearchResults.MapNavigation.ZoomFactor | string |
Den faktor som bilden måste vara för att visa alla UPS-platser. |
|
PanX
|
LocatorResponse.SearchResults.MapNavigation.PanX | string |
Den nivå som användaren vill panorera på X-axeln. Aldrig återvänt. Efter det första svaret kanske användaren vill visa bilden längre till vänster eller till höger. För att göra det krävs en annan begäran med värdet 1, 0 eller 1. |
|
Pany
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
Nivån som användaren vill panorera till på Y-axeln. Standardvärdet för den första begäran är 0. Efter det första svaret kanske användaren vill visa bilden längre upp eller ned på y-axeln. För att göra det krävs en annan begäran med värdet 1, 0 eller 1. |
|
Mapid
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
En lista med 5 plats-ID:t krypteras i MapID för kartgenerering. |
|
MapURL
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
En länk till kartan med de fem UPS-platserna och ursprungsplatsen som anges i MapID. |
|
LocationID
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
Plats-ID för en viss UPS-plats. |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
X-koordinaten för UPS-platsen. |
|
YCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.YCoordinate | string |
Y-koordinaten för UPS-platsen. |
|
Segment
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Segment | string |
Stegvisa anvisningar från Ursprung till den angivna platsen. |
|
Värde
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.Value | string |
Det beräknade avståndet från ursprunget till UPS-platsen. |
|
Kod
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Code | string |
Måttkodens avståndsenhet. Måttenheten som används i sökbegäran returneras. Värden som returneras är: MI-Miles. |
|
Beskrivning
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Description | string |
Kan returnera beskrivningen av den måttenhet som anges i begäran. Giltiga värden är: Miles och Kilometer. |
|
Time
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Time | string |
Den totala uppskattade tidsperioden det skulle ta att köra från ursprunget till platsen. |
|
Värde
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.Value | string |
Det raka linjeavståndet från ursprunget till UPS-platsen. |
|
Kod
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Code | string |
Måttkodens avståndsenhet. Måttenheten som används i sökbegäran returneras. Värden som returneras är: MI-Miles. |
|
Beskrivning
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
Kan returnera beskrivningen av den måttenhet som anges i begäran. Giltiga värden är: Miles och Kilometer. |
|
Totaltid
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
Den totala uppskattade tidsperioden det skulle ta att köra från ursprunget till platsen. Format: HHMM. |
|
AvailableLocationAttributes
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
ActiveAvailableAccessPointIndicator
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
Anger om landet eller territoriet har AccessPoints eller inte. |
|
AllowAllConfidenceLevels
|
LocatorResponse.AllowAllConfidenceLevels | string |
Indikator för att tillåta konfidensnivå i sökningen. |
Skapa leverans
Skapa leverans-API:et ger programmet många sätt att hantera leveransen av paket till målet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Transaktions-ID
|
transid | True | string |
En identifierare som är unik för begäran. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kod
|
ShipmentResponse.Response.ResponseStatus.Code | string |
Identifierar lyckade eller misslyckade transaktioner. |
|
Beskrivning
|
ShipmentResponse.Response.ResponseStatus.Description | string |
Beskriver svarsstatuskod. Returnerar text av Lyckades. |
|
Avisering
|
ShipmentResponse.Response.Alert | ||
|
CustomerContext
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
Kunden tillhandahöll data. Kan vara XML. Om dessa data finns i begäran skickas de tillbaka till kunden. |
|
TransactionIdentifier
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
En identifierare som är unik för begäran. |
|
Friskrivning
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
Valutakod
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
BaseServiceCharge valutakodtyp. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
Värdebelopp för bastjänstavgift. |
|
Valutakod
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
Transportavgifter valutakodtyp. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
Värdebelopp för transport och tilläggsavgifter. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
Valutakod
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
Accessorial avgifter valutakodtyp. Valutakoden som används i leveransbegäran returneras. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
Värdebelopp för accessorialavgifter. |
|
TaxCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
Valutakod
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
Valutakodtyp för totalt antal avgifter. Valutakoden som används i leveransbegäran returneras. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
Värdebelopp för totalt antal avgifter. |
|
Valutakod
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes valutakodtyp. Valutakoden som används i leveransbegäran returneras. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes monetära värdebelopp. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
TaxCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
Valutakod
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
Valutakod för totalt antal avgifter. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
Penningvärde för totala avgifter. |
|
Valutakod
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes valutakodtyp. Valutakoden som används i leveransbegäran returneras. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes monetära värdebelopp. |
|
Valutakod
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
Valutakod för bruttoavgifter. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
Bruttoavgifter, monetärt värde. |
|
Valutakod
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
Valutakod för rabattbelopp. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
Beloppsvärde för rabattbelopp. |
|
Valutakod
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
Net Charge-valutakod. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
Nettoavgifternas monetära värde. |
|
Täthet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
Densitet returneras om avsändaren är berättigad till densitetsbaserad hastighet. |
|
TotalCubicFeet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
Totalt antal kubikfot returneras om avsändaren är berättigad till densitetsbaserad hastighet. |
|
HandlingUnits
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
RatingMethod
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
RatingMethod är att ange om leveransen klassificerades som leveransnivå eller paketnivå. Den här informationen returneras endast om RatingMethodRequestedIndicator finns i begäran. Giltiga värden: 01 = Leveransnivå 02 = Paketnivå. |
|
BillableWeightCalculationMethod
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
BillableWeightCalculationMethod är att ange om den beräkningsmetod för fakturerbar vikt som användes var - paketnivån eller leveransnivån. Den här informationen returneras endast om RatingMethodRequestedIndicator finns i begäran. |
|
Kod
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
Kod för måttenheterna för faktureringsvikt. Värden är: KGS eller LBS. |
|
Beskrivning
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Description | string |
Beskrivning av måttenheterna för faktureringsvikt. |
|
Vikt
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
Faktureringsvikt. Högre av den faktiska leveransvikten jämfört med transportens dimensionsvikt. |
|
ShipmentIdentificationNumber
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
Returnerade UPS-leverans-ID nummer.1Z Antal för det första paketet i leveransen. |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
MIDualReturnShipmentKey är en unik nyckel som krävs för att bearbeta Mail Innovations Dual Return Shipment. |
|
ShipmentDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
Kodade leveransparametrar måste skickas i acceptfasen. Gäller endast för ShipConfirmResponse. |
|
PackageResults
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
Kod
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Code | string |
Kod för typen av grafisk bild för rapporten med högt värde. |
|
Beskrivning
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Description | string |
Beskrivning av formatkoden. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Bas 64-kodad html-, EPL2-, ZPL- eller SPL-avbildning. Gäller endast för ShipmentResponse och ShipAcceptResponse. |
|
Kod
|
ShipmentResponse.ShipmentResults.Form.Code | string |
Kod som anger typ av formulär. Gäller endast för ShipmentResponse och ShipAcceptResponse. Giltiga värden: 01 – Alla begärda internationella formulär. |
|
Beskrivning
|
ShipmentResponse.ShipmentResults.Form.Description | string |
Beskrivning som anger typ av formulär. Möjliga värden. Alla begärda internationella formulär. Gäller endast för ShipmentResponse och ShipAcceptResponse. |
|
Kod
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
Kod som representerar formatet som formulären genereras i. Gäller endast för ShipmentResponse och ShipAcceptResponse. Giltigt värde: PDF = endast pdf. |
|
Beskrivning
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
Beskrivning av formatkoden för formulärbild. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Bas 64-kodad avbildning av internationella formulär. Gäller endast för ShipmentResponse och ShipAcceptResponse. |
|
FormGroupId
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
Unikt ID för senare hämtning av sparad version av de ifyllda internationella formulären. Returneras alltid när kod = 01. 01 representerar internationella former. Gäller endast för ShipmentResponse och ShipAcceptResponse. |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
Innehåller beskrivningstext som identifierar gruppen med internationella formulär. Det här elementet är en del av både begäran och svar. Det här elementet visas inte i formulären. Gäller endast för ShipmentResponse och ShipAcceptResponse. |
|
Kod
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
Formatera kod för den genererade COD-in-sidan. Giltiga värden: HTML = HTML-format. Endast HTML-format stöds för COD Turn In Page. Gäller endast för ShipmentResponse och ShipAcceptResponse. |
|
Beskrivning
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
Beskrivning av formatkoden för den genererade cod-in-sidan. Gäller endast för ShipmentResponse och ShipAcceptResponse. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Grundläggande 64-kodad html-webbläsaravbildningsrenderingsprogram. Gäller endast för ShipmentResponse och ShipAcceptResponse. |
|
Kod
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
Kod som representerar formatet där rapporten med högt värde genereras. Giltiga värden: PDF = pdf. |
|
Beskrivning
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Description | string |
Beskrivning av bildformatet. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Grundläggande 64-kodad PDF-avbildning. |
|
LabelURL
|
ShipmentResponse.ShipmentResults.LabelURL | string |
URL:en pekar på en sida där instruktioner för etikett, kvitto och andra dokument, om tillämpligt, till exempel HighValueReport, CustomsInvoice och ImportControl kan begäras. LabelURL returneras endast om LabelLinksIndicator begärs för följande försändelser: Print/Electronic ImportControl-leverans, Print/Electronic, Return shipment, Forward shipment except for Mail Innovations Forward. |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
URL:en pekar på en sida där instruktioner för etikett, kvitto och andra dokument, om tillämpligt, till exempel HighValueReport, CustomsInvoice och ImportControl kan begäras. LocalLanguageLabelURL returneras endast om LabelLinksIndicator begärs för följande försändelser: Print/Electronic ImportControl-leverans, Print/Electronic Return shipment, Forward shipment except for Mail Innovations Forward, Not returned if LabelLinksIndicator is requested with Locale element. |
|
ReceiptURL
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
URL:en pekar på en sida där instruktioner för etikett, kvitto och andra dokument, om tillämpligt, till exempel HighValueReport, CustomsInvoice och ImportControl kan begäras. ReceiptURL returneras endast om LabelLinksIndicator begärs för följande försändelser: Print/Electronic ImportControl-leverans, Print/Electronic Return-leverans. |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
URL:en pekar på en sida där instruktioner för etikett, kvitto och andra dokument, om tillämpligt, till exempel HighValueReport, CustomsInvoice och ImportControl kan begäras. LocalLanguageReceiptURL returneras endast om LabelLinksIndicator begärs för följande försändelser: Print/Electronic ImportControl-leverans, Print/Electronic Return shipment, Forward shipment except for Mail Innovations Forward, Not returned if LabelLinksIndicator is requested with Locale element( LocalLanguageReceiptURL is returned, 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 i pdf-format. Ett PDF-dokument med flera sidor returneras som innehåller alla nödvändiga kopior av Dangrous Goods-fraktpapper för alla paket med farligt gods. Returneras endast när DGSignatoryInfo finns. |
|
MasterCartonID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
Huvudkartong-ID. MasterCartonID returneras om MasterCartonIndicator finns i begäran. |
Spårning
Spårnings-API stöder paket-, markfrakt- och flygfraktsändningar.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Undersökningsnummer
|
inquiryNumber | True | string |
Det undersökningsnummer som används för att komma åt UPS-spårningsinformation. |
|
Transaktions-ID
|
transid | True | string |
En identifierare som är unik för begäran. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Leverans
|
trackResponse.shipment | array of object |
Element som innehåller leveransinformationen som är associerad med undersökningsnumren. |
|
paket
|
trackResponse.shipment.package | array of object |
Element som innehåller paketinformationen. |
|
trackingNumber (spårningsnummer)
|
trackResponse.shipment.package.trackingNumber | string |
Det lilla paketet, e-postinnovationerna, frakten eller spårningsnumret över natten. |
|
deliveryDate
|
trackResponse.shipment.package.deliveryDate | ||
|
type
|
trackResponse.shipment.package.deliveryTime.type | string |
Anger typ av leverans. |
|
startTime
|
trackResponse.shipment.package.deliveryTime.startTime | string |
Starttid, tidsåtgång eller leveranstid. |
|
EndTime
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
Fönstrets sluttid. |
|
aktivitet
|
trackResponse.shipment.package.activity | array of object |
Ett containerelement som innehåller genomsökningsaktiviteten som är associerad med inquiryNumber. |
|
location
|
trackResponse.shipment.package.activity.location | ||
|
type
|
trackResponse.shipment.package.activity.status.type | string |
Aktivitetstyp. |
|
beskrivning
|
trackResponse.shipment.package.activity.status.description | string |
Statusbeskrivning. |
|
kod
|
trackResponse.shipment.package.activity.status.code | string |
Statuskod. |
|
date
|
trackResponse.shipment.package.activity.date | string |
Datumet för aktiviteten. |
|
time
|
trackResponse.shipment.package.activity.time | string |
Tidpunkten för aktiviteten. |