LabelRecoveryRequest --
LabelRecoveryRequest.LabelDelivery --
LabelRecoveryRequest.LabelDelivery.LabelLinkIndicator -- Indicates the Label Recovery and Receipt Recovery URL links are to be returned in the XML Response. Valid for following shipment -Print/Electronic Return LabelPrint/Electronic Import Control LabelForward shipment except for Mail Innovations Forward
LabelRecoveryRequest.LabelDelivery.ResendEMailIndicator -- Not Used. If this tag is present, resend the Label Delivery notification email.
LabelRecoveryRequest.LabelSpecification --
LabelRecoveryRequest.LabelSpecification.HTTPUserAgent -- Browser HTTPUserAgent String. This is the preferred way of identifying GIF image type to be generated. Required if / LabelSpecification/LabelImageFormat/Code = Gif. Default to Mozilla/4.5 if this field is missing or has invalid value.
LabelRecoveryRequest.LabelSpecification.LabelImageFormat --
LabelRecoveryRequest.LabelSpecification.LabelImageFormat.Code -- File type that the label is to be generated in. Valid values are: - GIF -- label is in HTML format.- PDF -- label is in PDF format.- ZPL -- Thermal label in ZPL format.- EPL -- Thermal label in EPL2 format.- SPL -- Thermal label in SPL format. Default is GIF
LabelRecoveryRequest.LabelSpecification.LabelImageFormat.Description -- Description of the label image format code.
LabelRecoveryRequest.LabelSpecification.LabelStockSize --
LabelRecoveryRequest.LabelSpecification.LabelStockSize.Height -- Height of the Label. Only valid values are 6 or 8.Note: Label Image will only scale up to 4 X 6, even when requesting 4 X 8.
LabelRecoveryRequest.LabelSpecification.LabelStockSize.Width -- Width of the Label. Valid value is 4.Note: Label Image will only scale up to 4 X 6, even when requesting 4 X 8.
LabelRecoveryRequest.Locale -- Represents 5 character ISO Locale that allows the user to request Reference Number Code on Label, Label instructions, Receipt instructions (if available for given tracking number) and High Value Report (if available for given tracking number) in desired language. Locale is specified by the combination of language code and country or territory code - 2 character language code and 2 character country code seperated by an underscore ('_') character. Example - de_DE. Please refer to Appendix for supported values for Locale. Either Translate container or Locale element can be present in a given request. Both can't be requested together in same request.
LabelRecoveryRequest.MailInnovationsTrackingNumber -- Mail Innovations Tracking Number. Required if Tracking Number or ReferenceNumber/Value is not populated. If only MailInnovationsTrackingNumber is provided, the request will be treated as Single Mail Innovations Return Shipment. Label Recovery will return label for Mail Innovations Return Tracking Number.If both, TrackingNumber and MailInnovationsTrackingNumber are provided, the request will be treated as Dual Mail Innovations Return Shipment. Label Recovery will return two labels one each for - Small Package Tracking Number and Mail Innovations Return Tracking Number.
LabelRecoveryRequest.ReferenceValues --
LabelRecoveryRequest.ReferenceValues.ReferenceNumber --
LabelRecoveryRequest.ReferenceValues.ReferenceNumber.Value -- Required if TrackingNumber or Mail Innovations Tracking Number is not populated. Customer supplied reference number. Supports up to 2 customer supplied combinations of Reference code- value combinations.
LabelRecoveryRequest.ReferenceValues.ShipperNumber -- Required if ReferenceNumber/Value is populated. Shipper's six digit account number. Must be six alphanumeric characters. Must be associated with the Internet account used to login.
LabelRecoveryRequest.Request --
LabelRecoveryRequest.Request.RequestOption -- Request option is no longer used.
LabelRecoveryRequest.Request.SubVersion -- When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility.To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description.Format: YYMM = Year and month of the release.Example: 1701 = 2017 January Supported values: 1701, 1707, 1903
LabelRecoveryRequest.Request.TransactionReference --
LabelRecoveryRequest.Request.TransactionReference.CustomerContext -- The CustomerContext Information which will be echoed during response
LabelRecoveryRequest.TrackingNumber -- Small Package Tracking Number. Required if Mail Innovations Tracking Number or ReferenceNumber/Value and ShipperNumber is not provided. If only TrackingNumber is provided, the request will be treated as Small Package Shipment. Label Recovery will return label for Small Package Tracking Number.If both, TrackingNumber and MailInnovationsTrackingNumber are provided, the request will be treated as Dual Mail Innovations Return Shipment. Label Recovery will return two labels one each for - Small Package Tracking Number and Mail Innovations Return Tracking Number.
LabelRecoveryRequest.Translate --
LabelRecoveryRequest.Translate.Code -- Used to specify what will be translated. Valid code: 01 = label direction instructions and receipt
LabelRecoveryRequest.Translate.DialectCode -- Valid dialect codes are: - CA - Canada- GB - Great Britain- US - United States- 97 – Not Applicable
LabelRecoveryRequest.Translate.LanguageCode -- The Language code. The language codes are three letter language codes. Supported languages are: - eng - English - spa - Spanish - ita - Italian- fra - French - deu - German - por -Portuguese - nld – Dutch- dan - Danish - fin - Finnish - swe – Swedish - nor – Norwegian
LabelRecoveryRequest.UPSPremiumCareForm --
LabelRecoveryRequest.UPSPremiumCareForm.PageSize -- Size of UPS Premium Care Form. Valid values: 01 = A4 Size02 = Letter Size
LabelRecoveryRequest.UPSPremiumCareForm.PrintType -- Format of UPS Premium Care Form. Valid values: 01 = PNG02 = PDF
Shipment
ShipmentRequest --
ShipmentRequest.LabelSpecification --
ShipmentRequest.LabelSpecification.CharacterSet -- Language character set expected on label.Valid values:dan = Danish (Latin-1)nld = Dutch (Latin-1)fin = Finnish (Latin-1)fra = French (Latin-1)deu = German (Latin-1)itl = Italian (Latin-1)nor = Norwegian (Latin-1)pol = Polish (Latin-2)por = Poruguese (Latin-1)spa = Spanish (Latin-1) swe = Swedish (Latin-1) ces = Czech (Latin-2)hun = Hungarian (Latin-2)slk = Slovak (Latin-2)rus = Russian (Cyrillic)tur = Turkish (Latin-5)ron = Romanian (Latin-2)bul = Bulgarian (Latin-2)est = Estonian (Latin-2)ell = Greek (Latin-2)lav = Latvian (Latin-2)lit = Lithuanian (Latin-2)eng = English (Latin-1) Default is English (Latin-1).
ShipmentRequest.LabelSpecification.HTTPUserAgent -- Browser HTTPUserAgent String. This is the preferred way of identifying GIF image type to be generated. Required if /ShipmentRequest/LabelSpecificationLabelSpecification/LabelImageFormat/Code = Gif. Default to Mozilla/4.5 if this field is missing or has invalid value.
ShipmentRequest.LabelSpecification.Instruction --
ShipmentRequest.LabelSpecification.Instruction.[].Code -- For Exchange Forward Shipment, by default Label will have Exchange Routing instruction Text as EXCHANGE-LIKE ITEM ONLY. If code value is: 01- EXCHANGE-LIKE ITEM ONLY, 02- EXCHANGE-DRIVER INSTRUCTIONS INSIDE.
ShipmentRequest.LabelSpecification.Instruction.[].Description -- Description of the label Instruction code.
ShipmentRequest.LabelSpecification.LabelImageFormat --
ShipmentRequest.LabelSpecification.LabelImageFormat.Code -- Label print method code determines the format in which Labels are to be generated. For EPL2 formatted Labels use EPL, for SPL formatted Labels use SPL, for ZPL formatted Labels use ZPL and for image formats use GIF. For shipments without return service the valid value is GIF, ZPL, EPL and SPL. For shipments with PRL return service, the valid values are EPL, ZPL, SPL and GIF. For UPS Premier Silver shipment only ZPL is supported.
ShipmentRequest.LabelSpecification.LabelImageFormat.Description -- Description of the label image format code.
ShipmentRequest.LabelSpecification.LabelStockSize --
ShipmentRequest.LabelSpecification.LabelStockSize.Height -- Height of the label image. For IN, use whole inches. For EPL2, ZPL and SPL Labels. Only valid values are 6 or 8. Note: Label Image will only scale up to 4 X 6, even when requesting 4 X 8.
ShipmentRequest.LabelSpecification.LabelStockSize.Width -- Width of the label image. For IN, use whole inches. For EPL2, ZPL and SPL Labels. Valid value is 4. Note: Label Image will only scale up to 4 X 6, even when requesting 4 X 8.
ShipmentRequest.ReceiptSpecification --
ShipmentRequest.ReceiptSpecification.ImageFormat --
ShipmentRequest.ReceiptSpecification.ImageFormat.Code -- Print code that determines the receipt format. Valid Codes are: EPL, SPL, ZPL and HTML.
ShipmentRequest.ReceiptSpecification.ImageFormat.Description -- Description of the receipt format code.
ShipmentRequest.Request --
ShipmentRequest.Request.RequestOption -- Optional Processing. Note: Full address validation is not performed. Therefore, it is the responsibility of the Shipping Tool User to ensure the address entered is correct to avoid an address correction fee. Valid values:nonvalidate = No street level address validation would be performed, but Postal Code/State combination validation would still be performed.validate = No street level address validation would be performed, but City/State/Postal Code/ combination validation would still be performed.
ShipmentRequest.Request.SubVersion -- When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility.To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description.Example: Itemized Charges are returned only when the Subversion element is present and greater than or equal to 1601. Format: YYMM = Year and month of the release.Example: 1607 = 2016 July Supported values: 1601, 1607, 1701, 1707, 1801, 1807, 2108, 2205
ShipmentRequest.Request.TransactionReference --
ShipmentRequest.Request.TransactionReference.CustomerContext -- The CustomerContext Information which will be echoed during response.
ShipmentRequest.Shipment --
ShipmentRequest.Shipment.AlternateDeliveryAddress --
ShipmentRequest.Shipment.AlternateDeliveryAddress.Address --
ShipmentRequest.Shipment.AlternateDeliveryAddress.Address.AddressLine -- Address Line of the Retail Location.
ShipmentRequest.Shipment.AlternateDeliveryAddress.Address.City -- Retail Location City.
ShipmentRequest.Shipment.AlternateDeliveryAddress.Address.CountryCode -- Retail Location country or territory code.
ShipmentRequest.Shipment.AlternateDeliveryAddress.Address.PostalCode -- If the Alternate Delivery Address country or territory is US or Puerto Rico, 5 or 9 digits are required. The character - may be used to separate the first five digits and the last four digits. If the Alternate Delivery Address country or territory is CA, then the postal code is required and must be 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit. Otherwise optional. For all other countries or territories the postal code is optional and must be no more than 9 alphanumeric characters long.
ShipmentRequest.Shipment.AlternateDeliveryAddress.Address.StateProvinceCode -- Retail Location state or province code. Required for US or Canada. If destination is US or CA, then the value must be a valid US State/Canadian Province code. If the country or territory is Ireland, the StateProvinceCode will contain the county.
ShipmentRequest.Shipment.AlternateDeliveryAddress.AttentionName -- Attention Name.
ShipmentRequest.Shipment.AlternateDeliveryAddress.Name -- Retail Location Name.
ShipmentRequest.Shipment.AlternateDeliveryAddress.UPSAccessPointID -- UPS Access Point ID.
ShipmentRequest.Shipment.CostCenter -- Customer assigned identifier for report and billing summarization displays to the right of the Cost Center title. Required for Mail Innovations Return shipments. It is shown on the bottom of the shipping label as reference 2.Cost Center length is alphanumeric with a max length of 30 for Mail Innovations forward shipments.Cost Center length is numeric with a max length of 4 for Mail Innovations Return shipments.
ShipmentRequest.Shipment.CostCenterBarcodeIndicator -- Presence/Absence indicator. Presence of this indicator means that the customer is requesting for the CostCenter field to be barcoded at the bottom of the label.
ShipmentRequest.Shipment.DGSignatoryInfo --
ShipmentRequest.Shipment.DGSignatoryInfo.Date -- Date of signing the declaration form. Valid format is YYYYMMDD.
ShipmentRequest.Shipment.DGSignatoryInfo.Name -- Name of the person signing the declaration. Note: The name of person or department he/she is employed with, are both acceptable.
ShipmentRequest.Shipment.DGSignatoryInfo.Place -- The city of the Signatory.
ShipmentRequest.Shipment.DGSignatoryInfo.ShipperDeclaration -- Valid values:01 = Shipment level02 = Package level Valid only for the Shipper Declaration paper. If missing or invalid DGPaperImage will be returned at package level.
ShipmentRequest.Shipment.DGSignatoryInfo.Title -- Title of the person signing the declaration.Note: The title of the person or department he/she is employed with, are both acceptable.
ShipmentRequest.Shipment.DGSignatoryInfo.UploadOnlyIndicator -- Dangerous Goods Paper Upload Only Indicator. DG Paper will not be returned in response if UploadOnlyIndicator present.
ShipmentRequest.Shipment.Description -- The Description of Goods for the shipment. Applies to international and domestic shipments. Provide a detailed description of items being shipped for documents and non-documents. Examples: "annual reports" and "9 mm steel screws". Required if all of the listed conditions are true: ShipFrom and ShipTo countries or territories are not the same; The packaging type is not UPS Letter; The ShipFrom and or ShipTo countries or territories are not in the European Union or the ShipFrom and ShipTo countries or territories are both in the European Union and the shipments service type is not UPS Standard.
ShipmentRequest.Shipment.DocumentsOnlyIndicator -- Indicates a shipment contains written, typed, or printed communication of no commercial value. If DocumentsOnly is not specified then it implies that the shipment contains non documents or documents of commercial value. Default is a shipment contains non- documents or documents of commercial value. This is an empty tag, any value inside is ignored. Valid only for shipments with different origin and destination countries or territories. The origin country or territory is not US, and the destination country or territory is not CA, PR or MX.
ShipmentRequest.Shipment.FRSPaymentInformation --
ShipmentRequest.Shipment.FRSPaymentInformation.AccountNumber -- The UPS account number. If the Ground Freight Pricing indicator and FreightShipmentInformation/DensityEligibleIndicator is present in the request, this account number must be validated to check if it is Ground Freight Pricing Density Based Rating enabled.
ShipmentRequest.Shipment.FRSPaymentInformation.Address --
ShipmentRequest.Shipment.FRSPaymentInformation.Address.CountryCode -- The country or territory code for the Ground Freight Pricing payment information address.
ShipmentRequest.Shipment.FRSPaymentInformation.Address.PostalCode -- The postal code for the Ground Freight Pricing payment information address.
ShipmentRequest.Shipment.FRSPaymentInformation.Type --
ShipmentRequest.Shipment.FRSPaymentInformation.Type.Code -- Valid codes:- 01 = Prepaid- 02 = FreightCollect - 03 = ThirdParty
ShipmentRequest.Shipment.FRSPaymentInformation.Type.Description -- Specifies the description for Ground Freight Pricing payment type.
ShipmentRequest.Shipment.FreightShipmentInformation --
ShipmentRequest.Shipment.FreightShipmentInformation.DensityEligibleIndicator -- The presence of the tag indicates that the rate request is density based.For Density Based Rating (DBR), the customer must have DBR Contract Service.
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo --
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeight --
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeight.UnitOfMeasurement --
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeight.UnitOfMeasurement.Code -- Code associated with Unit of Measurement for the Adjusted height. Valid value: IN Unit of measurement code for Adjusted height is validated only when Handling unit type is SKD = Skid or PLT = Pallet.
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeight.UnitOfMeasurement.Description -- Description for UnitOfMeasurement for the adjusted height.
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeight.Value -- Adjusted height value.
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeightIndicator -- The presence of the AdjustedHeightIndicator indicates that allow the height reduction adjustment for density based rate request.
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits --
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions --
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.Height -- The height of the line item used to determine dimensional weight.
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.Length -- The length of the line item used to determine dimensional weight.
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.UnitOfMeasurement --
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.UnitOfMeasurement.Code -- Code for UnitOfMeasurement for the line item dimension. Valid value is IN
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.UnitOfMeasurement.Description -- Description for UnitOfMeasurement for the line item dimension.
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.Width -- The width of the line item used to determine dimensional weight.
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Quantity -- Handling Unit Quantity for Density based rating.
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Type --
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Type.Code -- Handling Unit Code for Density based rating. Valid values:- SKD = Skid- CBY = Carboy- PLT = Pallet- TOT = Totes- LOO = Loose- OTH = Other
ShipmentRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Type.Description -- A description of the code for the Handling Unit type.
ShipmentRequest.Shipment.GoodsNotInFreeCirculationIndicator -- Goods Not In Free Circulation indicator. This is an empty tag, any value inside is ignored. This indicator is invalid for a package type of UPS Letter and DocumentsOnly.
ShipmentRequest.Shipment.InvoiceLineTotal --
ShipmentRequest.Shipment.InvoiceLineTotal.CurrencyCode -- Invoice Line Total currency type.
ShipmentRequest.Shipment.InvoiceLineTotal.MonetaryValue -- Invoice Line Total amount for the entire shipment. Valid values are from 1 to 99999999
ShipmentRequest.Shipment.IrregularIndicator -- Mail classification defined by the USPS. Valid values: 1 = Balloon2 = Oversize3 = Not Applicable
ShipmentRequest.Shipment.Locale -- Represents 5 character ISO Locale that allows the user to request Reference Number Code on Label, Label instructions and Receipt instructions (if applicable) in desired language. Locale is specified by the combination of language code and country or territory code - 2 character language code and 2 character country or territory code seperated by an underscore ('_') character. If Locale element is requested along with LabelLinksIndicator, the URL to retrieve Label and Receipts (if applicable) will be returned in the requested Locale. Please note only LabelURL and ReceiptURL (if applicable) will be returned. LocalLanguageLabelURL and LocalLanguageReceiptURL will not be returned if Locale element is present in request.Queen's English (en_GB) is the default
ShipmentRequest.Shipment.MIDualReturnShipmentIndicator -- MIDualReturnShipmentIndicator is an indicator to identify a Package Shipment is part of UPS Mail Innovations Dual Label Shipment. Its presence means Package Shipment is part of UPS Mail Innovations Dual Label shipment. If the indicator is present in Package Shipment request, shipment would be considered as part of a Dual Mail Innovations Returns. This indicator is not valid with UPS Mail Innovations Returns Service code.
ShipmentRequest.Shipment.MIDualReturnShipmentKey -- MIDualReturnShipmentKey is unique key required to process Mail Innovations Dual Return Shipment. The unique identifier (key) would be returned in response of first phase of Mail Innovations Dual Return Shipments. This unique identifier (key) would be part of request for second phase of Mail Innovations Dual Return Shipments.Format: For Package return shipments, the package tracking number is concatenated with the system time (YYYY-MM-DDHH.MM.SS.NNN), followed by service code. For MI Return shipments, the Mail Manifest ID (MMI) is concatenated with the system time. The unique identifier (key) is required to link the package and the Mail Innovations portion of Dual Return shipment. If unique identifier (key) is empty in the request for UPS Mail Innovations Return Service, the request will be treated as the first phase of the Mail Innovations Dual Returns Request. If the MIDualReturnShipmentIndicator is present with empty or null MIDualReturnShipmentKey in UPS Package Return Shipment, the request will be treated as the first phase of Dual MI Return Label Shipment. This field would be ignored if MIDualReturnShipmentIndicator is not present in UPS Package Return Shipment request.
ShipmentRequest.Shipment.MILabelCN22Indicator -- Indicates single label with both MI label and CN22 form. International CN22 form is required.
ShipmentRequest.Shipment.MasterCartonID -- Master Carton ID. If Economy Service (17 or 72) : Economy Shipment will be associated with given Master Carton ID. If Non-Economy Service: Master Carton Shipment will be created for given Master Carton ID.
ShipmentRequest.Shipment.MasterCartonIndicator -- Master Carton Indicator. Presence of the indicator means Master Carton ID will be created and returned to client. This is an empty tag, any value inside is ignored. MasterCartonIndicator is only valid with Econmoy Shipment (Service Code 17 or 72). Will be ignored if master carton id present.
ShipmentRequest.Shipment.MovementReferenceNumber -- Movement Reference Number (MRN) information. Must contain alphanumeric characters only. Must be a length of 18 characters. The 3rd and 4th Characters must be the Shipper country or territory ISO Code.
ShipmentRequest.Shipment.NumOfPiecesInShipment -- Total number of pieces in all pallets in a UPS Worldwide Express Freight Shipment. It is required for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment. Valid values are 1 to 99999.
ShipmentRequest.Shipment.Package --
ShipmentRequest.Shipment.Package.[].AdditionalHandlingIndicator -- Additional Handling Required. The presence indicates additional handling is required, the absence indicates no additional handling is required. Additional Handling indicator indicates it's a non-corrugated package.
ShipmentRequest.Shipment.Package.[].Commodity --
ShipmentRequest.Shipment.Package.[].Commodity.FreightClass -- Freight Classification. Freight class partially determines the freight rate for the article. Required for Ground Freight Pricing Shipments only.
ShipmentRequest.Shipment.Package.[].Commodity.NMFC --
ShipmentRequest.Shipment.Package.[].Commodity.NMFC.PrimeCode -- Specifies the Commodity's NMFC prime code. Required if NMFC Container is present.
ShipmentRequest.Shipment.Package.[].Commodity.NMFC.SubCode -- Specifies the Commodity's NMFC sub code. Needs to be provided when the SubCode associated with the PrimeCode is other than 00. UPS defaults the sub value to 00 if not provided. If provided the Sub Code should be associated with the PrimeCode of the NMFC.
ShipmentRequest.Shipment.Package.[].Description -- Merchandise description of package. Required for shipment with return service.
ShipmentRequest.Shipment.Package.[].DimWeight --
ShipmentRequest.Shipment.Package.[].DimWeight.UnitOfMeasurement --
ShipmentRequest.Shipment.Package.[].DimWeight.UnitOfMeasurement.Code -- Code representing the unit of measure associated with the package weight. Valid values:- LBS = Pounds (default)- KGS = Kilograms
ShipmentRequest.Shipment.Package.[].DimWeight.UnitOfMeasurement.Description -- Text description of the code representing the unit of measure associated with the package weight. Length and value are not validated.
ShipmentRequest.Shipment.Package.[].DimWeight.Weight -- Actual package weight. Weight accepted for letters/envelopes.
ShipmentRequest.Shipment.Package.[].Dimensions --
ShipmentRequest.Shipment.Package.[].Dimensions.DimWeight.Code -- Package dimensions measurement code. Valid codes: IN = Inches CM = Centimeters 00 = Metric Units Of Measurement 01 = English Units of Measurement The unit of measurement must be valid for the Shipper country or territory.
ShipmentRequest.Shipment.Package.[].Dimensions.DimWeight.Description -- Description of the package dimensions measurement units.
ShipmentRequest.Shipment.Package.[].Dimensions.Height -- Package height.
ShipmentRequest.Shipment.Package.[].Dimensions.Length -- Package length. Length must be the longest dimension of the container. Valid values are 0 to 108 IN and 0 to 270 CM.
ShipmentRequest.Shipment.Package.[].Dimensions.UnitOfMeasurement --
ShipmentRequest.Shipment.Package.[].Dimensions.Width -- Package width.
ShipmentRequest.Shipment.Package.[].HazMatPackageInformation --
ShipmentRequest.Shipment.Package.[].HazMatPackageInformation.AllPackedInOneIndicator -- Presence/Absence Indicator. Any value is ignored. Presence indicates if multiple, different hazmat/chemicals are contained within one box in a package When number of Hazmat containers in a package is more than one, either AllPackedInOneIndicator or OverPackedIndicator is needed
ShipmentRequest.Shipment.Package.[].HazMatPackageInformation.OuterPackagingType -- This field is used for the Outer Hazmat packaging type. Ex. FIBERBOARD BOX, WOOD(EN) BOX, PLASTIC JERRICAN, METAL BOX, STEEL DRUM, OTHER, PLASTIC BOX, PLASTIC DRUM, STYROFOAM BOX, CYLINDERS, ENVIROTAINER, PLYWOOD BOX, ALUMINUM DRUM, ALUMINUM CYLINDERS, PLASTIC PAIL, PLYWOOD DRUM, FIBER DRUM, STEEL JERRICAN, ALUMINUM JERRICAN, STEEL BOX, CARTON, ALUMINUM BOX
ShipmentRequest.Shipment.Package.[].HazMatPackageInformation.OverPackedIndicator -- Presence/Absence Indicator. Any value is ignored. Presence indicates that one or more hazmat/chemicals are in separate boxes in a package. When number of Hazmat containers in a package is more than one, either AllPackedInOneIndicator or OverPackedIndicator is needed
ShipmentRequest.Shipment.Package.[].HazMatPackageInformation.QValue -- When a HazMat shipment specifies AllPackedInOneIndicator and the regulation set for that shipment is IATA, Ship API must require the shipment to specify a Q-Value with exactly one of the following values: 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0
ShipmentRequest.Shipment.Package.[].LargePackageIndicator -- Presence of the indicator mentions that the package is Large Package.This is an empty tag, any value inside is ignored.
ShipmentRequest.Shipment.Package.[].MinimumBillableWeightIndicator -- Presence/Absence Indicator. Any value is ignored. If present, indicates that the package is qualified for minimum billable weight. Applicable for UPS Worldwide Economy DDU service.
ShipmentRequest.Shipment.Package.[].NumOfPieces -- Number of Pieces. Applicable for Air Freight only
ShipmentRequest.Shipment.Package.[].OversizeIndicator -- Presence/Absence Indicator. Any value is ignored. If present, indicates that the package is over size. Applicable for UPS Worldwide Economy DDU service.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.AccessPointCOD --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.AccessPointCOD.CurrencyCode -- Access Point COD Currency Code.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.AccessPointCOD.MonetaryValue -- Access Point COD Monetary Value.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.COD --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.COD.CODAmount --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.COD.CODAmount.CurrencyCode -- COD amount currency code type.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.COD.CODAmount.MonetaryValue -- COD Amount. Valid values: 0.01 USD to 50000.00 USD
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.COD.CODFundsCode -- For valid values refer to: Rating and Shipping COD Supported Countries or Territories in the Appendix.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.ClinicalTrialsID -- Unique identifier for clinical trials
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DeclaredValue --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DeclaredValue.CurrencyCode -- Declared value amount currency type. Defaults to the non-Euro currency used in the shippers country or territory. Code must represent a currency that is a valid for Shipper country or territory.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DeclaredValue.MonetaryValue -- Declared value amount.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DeclaredValue.Type --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DeclaredValue.Type.Code -- Declared value type. Valid values: - 01=EVS- 02=DVS Defaults to 01 i.e. EVS if declared value type is not provided. The user cannot specify different type of declared value for the shipment. User can either have shipper declared value (DVS) or declared value (EVS) but not both at package level. Note: The Shipper Declared Value is applicable for forward shipments when the billing option is freight collect or third party.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DeclaredValue.Type.Description -- Declared value Description.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DeliveryConfirmation --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DeliveryConfirmation.DCISNumber -- Delivery Confirmation Control number associated with the delivery confirmation for the package. Valid for forward shipments only.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DeliveryConfirmation.DCISType -- Type of delivery confirmation. Valid values: - 1 - Unsupported- 2 - Delivery Confirmation Signature Required- 3 - Delivery Confirmation Adult Signature Required
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DryIce --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DryIce.DryIceWeight --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DryIce.DryIceWeight.UnitOfMeasurement --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DryIce.DryIceWeight.UnitOfMeasurement.Code -- DryIce weight unit of measurement code. Valid values:- 00 = KG (Metric Unit of Measurements) or KGS - 01 = LB (English Unit of Measurements) or LBS The following values are valid : 00, 01, KG, KGS, LBS.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DryIce.DryIceWeight.UnitOfMeasurement.Description -- Description for unit of measurement for Dry Ice Weight.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DryIce.DryIceWeight.Weight -- Dry Ice Weight. Cannot be more than package weight. Should be more than 0.0. Valid characters are 0-9 and "." (Decimal point). Limit to 1 digit after the decimal. The maximum length of the field is 5 including "." and can hold up to 1 decimal place.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DryIce.MedicalUseIndicator -- Presence/Absence Indicator. Any value inside is ignored. Relevant only in CFR regulation set. If present it is used to designate the dry Ice is for any medical use and rates are adjusted for DryIce weight more than 2.5 Kgs or 5.7 Lbs.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.DryIce.RegulationSet -- Regulation set for dryIce Shipment. Valid values: CFR = HazMat regulated by US Dept. of Transportation within the U.S. or ground shipments to Canada, IATA= Worldwide Air movement. The following values are valid: IATA, CFR.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].AdditionalDescription -- Additional remarks or special provision information. Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Additional information that may be required by regulation about a hazardous material, such as, "Limited Quantity", DOT-SP numbers, EX numbers.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].ChemicalRecordIdentifier -- Identifies the Chemical Record. Required if SubVersion is greater than or equal to 1701.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].ClassDivisionNumber -- This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'EQ', 'LQ' or 'FR'
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].CommodityRegulatedLevelCode -- Indicates the type of commodity - Fully Regulated (FR), Limited Quantity (LQ), Excepted Quantity (EQ) or Lightly Regulated (LR). Valid values are LR, FR, LQ and EQ.Required for subversion 1701 or greater. LR and EQ are validated if subversion is 1701 or greater. FR, LQ will be validated if subversion is 1807 or greater
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].EmergencyContact -- The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhoneNumber. The information is required if there is a value in the EmergencyPhoneNumber field above and the shipment is with a US50 or PR origin and/or destination and the RegulationSet is IATA.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].EmergencyPhone -- 24 Hour Emergency Phone Number of the shipper. Valid values for this field are (0) through (9) with trailing blanks. For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries or territories the layout is country or territory code, area code, number. The following are restricted in the phone number period ".", dash "-", plus sign "+" and conventional parentheses "(" and ")", "EXT" or "OPT"
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].HazardLabelRequired -- Defines the type of label that is required on the package for the commodity. Not applicable if CommodityRegulatedLevelCode = LR or EQ.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].IDNumber -- This is the ID number (UN/NA/ID) for the specified commodity. Required if CommodityRegulatedLevelCode = LR, LQ or FR and if the field applies to the material by regulation. UN/NA/ID Identification Number assigned to the specified regulated good. (Include the UN/NA/ID as part of the entry).
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].LocalProperShippingName -- Proper shipping name in local langauge.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].LocalTechnicalName -- Technical name in local language.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].PackagingGroupType -- This is the packing group category associated to the specified commodity. Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Must be shown in Roman Numerals. Valid values:IIIIIIblank
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].PackagingInstructionCode -- The packing instructions related to the chemical record. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].PackagingType -- The type of package used to contain the regulated good. (Ex: Fiberboard Box). Required if CommodityRegulatedLevelCode = LQ or FR. Ex. FIBERBOARD BOX, WOOD(EN) BOX, PLASTIC JERRICAN, METAL BOX, STEEL DRUM, OTHER, PLASTIC BOX, PLASTIC DRUM, STYROFOAM BOX, CYLINDERS, ENVIROTAINER, PLYWOOD BOX, ALUMINUM DRUM, ALUMINUM CYLINDERS, PLASTIC PAIL, PLYWOOD DRUM, FIBER DRUM, STEEL JERRICAN, ALUMINUM JERRICAN, STEEL BOX, CARTON, ALUMINUM BOX
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].PackagingTypeQuantity -- The number of pieces of the specific commodity. Required if CommodityRegulatedLevelCode = LQ or FR. Valid values are 1 to 999.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].ProperShippingName -- The Proper Shipping Name assigned by ADR, CFR or IATA. Required if CommodityRegulatedLevelCode = LR, LQ or FR.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].Quantity -- Required if CommodityRegulatedLevelCode = EQ, LQ or FR. The numerical value of the mass capacity of the regulated good. Should be more than 0.0. Valid characters are 0-9 and "." (Decimal point). Limit to 1 digit after the decimal. The maximum length of the field is 5 including "." (Decimal point) and can hold up to 1 decimal place.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].RecordIdentifier1 -- Reserved for future use.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].RecordIdentifier2 -- Reserved for future use.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].RecordIdentifier3 -- Reserved for future use.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].ReferenceNumber -- Optional reference number. It will be displayed only on label.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].RegulationSet -- The Regulatory set associated with every regulated shipment. It must be same across the shipment. Valid values: ADR = Europe to Europe Ground Movement CFR = HazMat regulated by US Dept. of Transportation within the U.S. or ground shipments to Canada IATA= Worldwide Air movement TDG= Canada to Canada ground movement or Canada to U.S. standard movement. Valid values are ADR, CFR, IATA and TDG.For multiple Chemical Records per package or multiple packages containing different RegulationSet, RegulationSet of first Chemical Record would be considered for validating and rating the entire shipment.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].ReportableQuantity -- Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. If reportable quantity is met, 'RQ' should be entered.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].SubRiskClass -- Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma).
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].TechnicalName -- The technical name (when required) for the specified commodity. Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].TransportCategory -- Transport Category. Valid values are 0 to 4.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].TransportationMode -- Not applicable for ADR regulation set. Required for any other regulation set. Declares that a package was prepared according to ground passenger aircraft or cargo aircraft only. Valid values: Highway=Highway Ground=Ground PAX=Passenger Aircraft Passenger Aircraft=Passenger Aircraft CAO=Cargo Aircraft Only Cargo Aircraft Only=Cargo Aircraft Only Valid entries include: Highway, Ground, PAX, Passenger Aircraft, CAO and Cargo Aircraft Only.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].TunnelRestrictionCode -- Defines what is restricted to pass through a tunnel.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].UOM -- Required if CommodityRegulatedLevelCode = LQ, EQ or FR. The unit of measure used for the mass capacity of the regulated good. For Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].aDRItemNumber -- The type of regulated good for an ADR package where ADR is for Europe to Europe ground movement.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.HazMat.[].aDRPackingGroupLetter -- Required if the field applies to the material by regulation. Field input is Arabic numerals, output is Roman numerals. Will be shown in Roman Numerals. Valid values: - "1" = "I", - "2" = "II", - "3" = "III",- and blank.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.Notification --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.Notification.EMail --
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.Notification.EMail.EMailAddress -- The destination email address of the receiver returns notification email.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.Notification.EMail.FromEMailAddress -- The email address listed in the Reply To field of the message header, includes name and e-mail address of sender. The "From" field of the message header contains pkginfo@ups.com. Only allowed at the first package.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.Notification.EMail.FromName -- The name the receiver return notification will appear to be from. Defaults to the Shipper Name. Only allowed at the first package.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.Notification.EMail.Memo -- User defined text that will be included in the email. Only allowed at the first package.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.Notification.EMail.Subject -- The eMails subject. Defaults to the UPS Receiver Return Notification plus the shipment ID. Only allowed at the first package.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.Notification.EMail.SubjectCode -- Specifies a reference code and reference number to display in the subject of the Receiver Return Notification.When the subject code is provided, the subject will contain the following: UPS Receiver Return Notification.The reference code (the reference code will be mapped to the corresponding ANSI value) Plus the reference number.The valid subject codes are:- 01 - Shipment Reference Number 1, - 02 - Shipment Reference Number 2, - 03 - package Reference Number 1, - 04 - package Reference Number 2,- 05 - package Reference Number 3,- 06 - package Reference Number 4,- 07 - package Reference Number 5,- 08 - Subject Text (Return Notification only). If the subject code tag is not provided and the subject text is provided, the subject of the notification will be the subject text.If the subject text is provided, and subject code tag exists, then the subject code value must be 08. If the subject code is 08, the subject text must exist. If a subject code is provided that refers to a nonexistent reference number, the subject will default to the tracking number. Only allowed at the first package.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.Notification.EMail.UndeliverableEMailAddress -- The e-mail address where an undeliverable email message is sent if the Receiver Return Notification email is undeliverable. Defaults to FromEMailAddress. Only allowed at the first package.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.Notification.NotificationCode -- Notification Code. Valid values:3 - Receiver Return Notification6 - QV Email Notification7 - QV Exception Notification8 - QV Delivery Notification For Mail Innovations forward shipments, QV Email Notifications are allowed for First Class, Priority Mail, and Expedited Mail Innovation services.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.PackageIdentifier -- Identifies the package containing Dangerous Goods. Required for Hazmat shipment if SubVersion is greater than or equal to 1701.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.ProactiveIndicator -- Presence/Absence Indicator. Any value is ignored. If present, the package is rated for UPS Proactive Response and proactive package tracking. Contractual accessorial for health care companies to allow package monitoring throughout the UPS system. Shippers account needs to have valid contract for UPS Proactive Reponse.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.RefrigerationIndicator -- Presence/Absence Indicator. Any value is ignored. If present, indicates that the package contains an item that needs refrigeration. Shippers account needs to have a valid contract for Refrigeration.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.ShipperReleaseIndicator -- The presence indicates that the package may be released by driver without a signature from the consignee. Empty Tag. Only available for US50/PR to US50/PR packages without return service.
ShipmentRequest.Shipment.Package.[].PackageServiceOptions.UPSPremiumCareIndicator -- An UPSPremiumCareIndicator indicates special handling is required for shipment having controlled substances. Empty Tag means indicator is present. The UPSPremiumCareIndicator cannot be requested for package with Delivery Confirmation - Adult Signature Required and Delivery Confirmation- Signature Required. UPSPremiumCareIndicator is valid for following Return services:- Returns Exchange (available with a contract)- Print Return Label- Print and Mail- Electronic Return Label - Return Service Three AttemptThe UPSPremiumCareIndicator can be requested with following UPS services: - UPS Express® Early- UPS Express- UPS Express Saver - UPS Standard- Valid only for Canada to Canada movements.
ShipmentRequest.Shipment.Package.[].PackageWeight --
ShipmentRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement --
ShipmentRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement.Code -- Package weight unit of measurement code. Valid values: - LBS = Pounds- KGS = Kilograms- OZS = OuncesUnit of Measurement "OZS" is the only valid UOM for some of the Mail Innovations Forward and Worldwide Economy DDU Shipments. Please refer to Appendix for more details regarding the valid combination of Mail Innovation Forward Shipment services, Package Type and Unit of Measurement.
ShipmentRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement.Description -- Description of the unit of measurement for package weight.
ShipmentRequest.Shipment.Package.[].PackageWeight.Weight -- Packages weight. Weight accepted for letters/envelopes. Only average package weight is required for Ground Freight Pricing Shipment.
ShipmentRequest.Shipment.Package.[].Packaging --
ShipmentRequest.Shipment.Package.[].Packaging.Code -- Package types. Values are: 01 = UPS Letter 02 = Customer Supplied Package 03 = Tube 04 = PAK 21 = UPS Express Box 24 = UPS 25KG Box 25 = UPS 10KG Box 30 = Pallet 2a = Small Express Box 2b = Medium Express Box 2c = Large Express Box 56 = Flats 57 = Parcels 58 = BPM 59 = First Class 60 = Priority 61 = Machineables 62 = Irregulars 63 = Parcel Post 64 = BPM Parcel 65 = Media Mail 66 = BPM Flat 67 = Standard Flat. Note: Only packaging type code 02 is applicable to Ground Freight Pricing. Package type 24, or 25 is only allowed for shipment without return service. Packaging type must be valid for all the following: ShipTo country or territory, ShipFrom country or territory, a shipment going from ShipTo country or territory to ShipFrom country or territory, all Accessorials at both the shipment and package level, and the shipment service type. UPS will not accept raw wood pallets and please refer the UPS packaging guidelines for pallets on UPS.com.
ShipmentRequest.Shipment.Package.[].Packaging.Description -- Description of packaging type. Examples are letter, customer supplied, express box.
ShipmentRequest.Shipment.Package.[].PalletDescription -- Description of articles & special marks. Applicable for Air Freight only
ShipmentRequest.Shipment.Package.[].ReferenceNumber --
ShipmentRequest.Shipment.Package.[].ReferenceNumber.[].BarCodeIndicator -- If the indicator is present then the reference numbers value will be bar coded on the label.This is an empty tag, any value inside is ignored. Only one shipment-level or package-level reference number can be bar coded per shipment. In order to barcode a reference number, its value must be no longer than 14 alphanumeric characters or 24 numeric characters and cannot contain spaces.
ShipmentRequest.Shipment.Package.[].ReferenceNumber.[].Code -- Reference number type code, for the entire shipment. The code specifies the Reference name. Refer to the Reference Number Code table. Valid if the origin/destination pair is US/US or PR/PR and character should be alpha-numeric.
ShipmentRequest.Shipment.Package.[].ReferenceNumber.[].Value -- Customer supplied reference number. Valid if the origin/destination pair is US/US or PR/PR.
ShipmentRequest.Shipment.Package.[].SimpleRate --
ShipmentRequest.Shipment.Package.[].SimpleRate.Code -- SimpleRate code. Valid Values- XS = Extra Small- S = Small- M = Medium- L = Large- XL = Extra Large
ShipmentRequest.Shipment.Package.[].SimpleRate.Description -- Simple Rate description of the code above. Currently ignored if provided in the Request. Length is not validated.
ShipmentRequest.Shipment.Package.[].UPSPremier --
ShipmentRequest.Shipment.Package.[].UPSPremier.Category -- UPS Premier Category. Valid values are 01,02,03 UPS Premier Silver -01UPS Premier Gold - 02UPS Premier Platinum - 03
ShipmentRequest.Shipment.Package.[].UPSPremier.HandlingInstructions --
ShipmentRequest.Shipment.Package.[].UPSPremier.HandlingInstructions.Instruction -- Handling Instruction for UPS Premier package. Please refer Apendix UPS Premier Handling Instructions.
ShipmentRequest.Shipment.Package.[].UPSPremier.SensorID -- SensorID is RFID for UPS Premier Silver. SensorID is MeshID for UPS Premier Gold or UPS Premier Platinum Package.
ShipmentRequest.Shipment.Package.[].UnitPrice -- Unit price of the commodity. Applicable for Air Freight only Limit to 2 digit after the decimal. The maximum length of the field is 12 including '.' and can hold up to 2 decimal place. (e.g. 999999999.99)
ShipmentRequest.Shipment.PackageID -- Customer-assigned unique piece identifier that returns visibility events. Required only for Mail Innovations forward shipments. Alpha numeric values only. It is shown on the bottom of the shipping label as reference 1.
ShipmentRequest.Shipment.PackageIDBarcodeIndicator -- Presence/Absence indicator. Presence of this indicator means that the customer is requesting for the PackageID field to be barcoded at the bottom of the label.
ShipmentRequest.Shipment.PaymentInformation --
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge --
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillReceiver --
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillReceiver.AccountNumber -- The UPS account number. The account must be a valid UPS account number that is active. For US, PR and CA accounts, the account must be a daily pickup account, an occasional account, a customer B.I.N account, or a dropper shipper account. All other accounts must be either a daily pickup account, an occasional account, a drop shipper account, or a non-shipping account.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillReceiver.Address --
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillReceiver.Address.PostalCode -- The postal code for the UPS accounts pickup address. The pickup postal code was entered in the UPS system when the account was set-up. The postal code must be the same as the UPS Bill Receiver account number pickup address postal code. Required for United States and Canadian UPS accounts and/or if the UPS account pickup address has a postal code. If the UPS accounts pickup country or territory is US or Puerto Rico, the postal code is 5 or 9 digits. The character - may be used to separate the first five digits and the last four digits. If the UPS accounts pickup country or territory is CA, the postal code is 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper --
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.AccountNumber -- UPS account number. Must be the same UPS account number as the one provided in Shipper/ShipperNumber. Either this element or one of the sibling elements CreditCard or AlternatePaymentMethod must be provided, but all of them may not be provided.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.AlternatePaymentMethod -- Alternate Payment Method.Valid value: 01= PayPalOnly valid for forward shipments. It is not valid for Return or Import Control shipments. This element or one of the sibling elements CreditCard or AccountNumber must be provided, but all of them may not be provided. PayPal 01: Is only valid for forward shipments. It is not valid for Return or Import Control shipments. This element or one of the sibling elements CreditCard or AccountNumber must be provided, but all of them may not be provided.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.CreditCard --
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.CreditCard.Address --
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.CreditCard.Address.AddressLine -- Address Line 1 of the credit card billing address. Usually Street address information.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.CreditCard.Address.City -- City of the credit card billing address.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.CreditCard.Address.CountryCode -- Credit card billing address country or territory code. Must be a valid UPS Billing country or territory code.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.CreditCard.Address.PostalCode -- Credit card billing addressee postal code.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.CreditCard.Address.StateProvinceCode -- State or province code of the credit card billing address.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.CreditCard.ExpirationDate -- Format is MMYYYY where MM is the 2 digit month and YYYY is the 4 digit year. Valid month values are 01-12 and valid year values are Present Year - (Present Year + 10 years)
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.CreditCard.Number -- Credit Card number.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.CreditCard.SecurityCode -- Three or four digits that can be found either on top of credit card number or on the back of credit card. Number of digits varies for different type of credit card. Valid values are 3 or 4 digits. It is required to provide the security code if credit card information is provided and when the ShipFrom countries or territories are other than the below mentioned countries or territories. Argentina, Bahamas, Costa Rica, Dominican Republic, Guatemala, Panama, Puerto Rico and Russia.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillShipper.CreditCard.Type -- Valid values:- 01 = American Express- 03 = Discover- 04 = MasterCard- 05 = Optima- 06 = VISA- 07 = Bravo- 08 = Diners Club- 13 = Dankort- 14 = Hipercard- 15 = JCB- 17 = Postepay- 18 = UnionPay/ExpressPay- 19 = Visa Electron- 20 = VPAY- 21 = Carte Bleue
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillThirdParty --
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillThirdParty.AccountNumber -- The UPS account number of the third party shipper. The account must be a valid UPS account number that is active. For US, PR and CA accounts, the account must be either a daily pickup account, an occasional account, or a customer B.I.N account, or a drop shipper account. All other accounts must be either a daily pickup account, an occasional account, a drop shipper account, or a non-shipping account.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillThirdParty.Address --
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillThirdParty.Address.CountryCode -- The country or territory code for the UPS accounts pickup address.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillThirdParty.Address.PostalCode -- The postal code for the UPS accounts pickup address. The pickup postal code is the one that was entered in the UPS system when the account was set-up. The postal code must be the same as the UPS Bill Third Party account number pickup address postal code. Required for United States and Canadian UPS accounts and/or if the UPS account pickup address has a postal code. If the UPS accounts pickup country or territory is US or Puerto Rico, the postal code is 5 or 9 digits. The character - may be used to separate the first five digits and the last four digits. If the UPS accounts pickup country or territory is CA, the postal code is 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillThirdParty.CertifiedElectronicMail -- Posta Elettronica Certificata (PEC) which is the recipient code for the customers certified electronic mail value.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].BillThirdParty.InterchangeSystemCode -- Sistema Di Interscambio(SDI) which is the recipient code for the customer's interchange value or Interchange System Code
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].ConsigneeBilledIndicator -- Consignee Billing payment option indicator. The presence indicates consignee billing option is selected. The absence indicates one of the other payment options is selected. This is an empty tag, any value inside is ignored. This element or its sibling element, BillShipper, BillReceiver or BillThirdParty, must be present but no more than one can be present. This billing option is valid for a shipment charge type of Transportation only. Only applies to US/PR and PR/US shipment origins and destination.This payment method allows you to bill the charges for a specified shipment to a consignee who has agreed to pay the charges. All shipping charges are billed to the consignees UPS account number including the following accessorials: Additional Handling, Delivery Area Surcharges, Delivery Change Requests, Early AM Premium, Early AM Out of Territory, Fuel Surcharge, Hazardous Material Surcharges, Large Package Surcharge, Over Max Limits, and Saturday Delivery.Declared Value, Delivery Confirmation, On Call Pickup, Remote Area Surcharge, Saturday Pickup of Delivery fees are not passed to the consignee. These charges are billed to the shippers UPS account number.
ShipmentRequest.Shipment.PaymentInformation.ShipmentCharge.[].Type -- Valid values: 01 = Transportation02 = Duties and Taxes 03 = Broker of Choice A shipment charge type of 01 = Transportation is required. A shipment charge type of 02 = Duties and Taxes is not required; however, this charge type is invalid for Qualified Domestic Shipments. A Qualified Domestic Shipment is any shipment in which one of the following applies: 1) The origin and destination country or territory is the same.2) US to PR shipment.3) PR to US shipment.4) The origin and destination country or territory are both European Union countries or territories and the GoodsNotInFreeCirculation indicator is not present.5) The origin and destination IATA code is the same. 03 = Broker of Choice
ShipmentRequest.Shipment.PaymentInformation.SplitDutyVATIndicator -- Split Duty VAT Indicator. The presence indicates the payer specified for Transportation Charges will pay transportation charges and any duties that apply to the shipment. The payer specified for Duties and Taxes will pay the VAT (Value-Added Tax) only. This is an empty tag, any value inside is ignored. The payment method for Transportation charges must be UPS account. The UPS account must be a daily pickup account or an occasional account.
ShipmentRequest.Shipment.PromotionalDiscountInformation --
ShipmentRequest.Shipment.PromotionalDiscountInformation.PromoAliasCode -- Promotion Alias code Required if PromotionalDiscountInformation container is present.
ShipmentRequest.Shipment.PromotionalDiscountInformation.PromoCode -- Promotion Code. A discount that is applied to the user. Required if PromotionalDiscountInformation container is present.
ShipmentRequest.Shipment.RatingMethodRequestedIndicator -- Presence/Absence Indicator. Any value inside is ignored. RatingMethodRequestedIndicator is an indicator.If present, Billable Weight Calculation method information and Rating Method information would be returned in response.
ShipmentRequest.Shipment.ReferenceNumber --
ShipmentRequest.Shipment.ReferenceNumber.[].BarCodeIndicator -- If the indicator is present then the reference number's value will be bar coded on the label. This is an empty tag, any value inside is ignored. Only one shipment-level or package-level reference number can be bar coded per shipment. In order to barcode a reference number, its value must be no longer than 14 alphanumeric characters or 24 numeric characters and cannot contain spaces.
ShipmentRequest.Shipment.ReferenceNumber.[].Code -- Shipment Reference number type code. The code specifies the Reference name. Refer to the Reference Number Code table. Valid if the origin/destination pair is not US/US or PR/PR and character should be alpha-numeric.
ShipmentRequest.Shipment.ReferenceNumber.[].Value -- Customer supplied reference number. Valid if the origin/destination pair is not US/US or PR/PR
ShipmentRequest.Shipment.ReturnService --
ShipmentRequest.Shipment.ReturnService.Code -- Return Service types: - 2 = UPS Print and Mail (PNM)- 3 = UPS Return Service 1-Attempt (RS1)- 5 = UPS Return Service 3-Attempt (RS3)- 8 = UPS Electronic Return Label (ERL)- 9 = UPS Print Return Label (PRL)- 10 = UPS Exchange Print Return Label- 11 = UPS Pack & Collect Service 1-Attempt Box 1- 12 = UPS Pack & Collect Service 1-Attempt Box 2- 13 = UPS Pack & Collect Service 1-Attempt Box 3- 14 = UPS Pack & Collect Service 1-Attempt Box 4- 15 = UPS Pack & Collect Service 1-Attempt Box 5- 16 = UPS Pack & Collect Service 3-Attempt Box 1- 17 = UPS Pack & Collect Service 3-Attempt Box 2- 18 = UPS Pack & Collect Service 3-Attempt Box 3- 19 = UPS Pack & Collect Service 3-Attempt Box 4- 20 = UPS Pack & Collect Service 3-Attempt Box 5
ShipmentRequest.Shipment.ReturnService.Description -- Return Service description.
ShipmentRequest.Shipment.Service --
ShipmentRequest.Shipment.Service.Code -- Valid values: - 01 = Next Day Air- 02 = 2nd Day Air- 03 = Ground- 07 = Express- 08 = Expedited- 11 = UPS Standard- 12 = 3 Day Select- 13 = Next Day Air Saver- 14 = UPS Next Day Air® Early - 17 = UPS Worldwide Economy DDU- 54 = Express Plus- 59 = 2nd Day Air A.M. - 65 = UPS Saver- M2 = First Class Mail- M3 = Priority Mail- M4 = Expedited MaiI Innovations- M5 = Priority Mail Innovations- M6 = Economy Mail Innovations - M7 = MaiI Innovations (MI) Returns- 70 = UPS Access Point™ Economy- 71 = UPS Worldwide Express Freight Midday - 72 = UPS Worldwide Economy DDP- 74 = UPS Express®12:00 - 75 = UPS Heavy Goods- 82 = UPS Today Standard- 83 = UPS Today Dedicated Courier- 84 = UPS Today Intercity- 85 = UPS Today Express- 86 = UPS Today Express Saver- 96 = UPS Worldwide Express Freight.Note: Only service code 03 is used for Ground Freight Pricing shipments The following Services are not available to return shipment: 13, 59, 82, 83, 84, 85, 86
ShipmentRequest.Shipment.Service.Description -- Description of the service code. Examples are Next Day Air, Worldwide Express, and Ground.
ShipmentRequest.Shipment.ShipFrom --
ShipmentRequest.Shipment.ShipFrom.Address --
ShipmentRequest.Shipment.ShipFrom.Address.AddressLine -- The Ship from street address including name and number (when applicable). 35 characters are accepted, but for return Shipment only 30 characters will be printed on the label.
ShipmentRequest.Shipment.ShipFrom.Address.City -- The Ship from city. 30 characters are accepted, but for return Shipment only 15 characters will be printed on the label. Required if ShipFrom is supplied
ShipmentRequest.Shipment.ShipFrom.Address.CountryCode -- Origin locations country or territory code. Required if ShipFrom tag is supplied. For Return Shipment the country or territory code must meet the following conditions: - At least two of the following country or territory codes are the same: ShipTo, ShipFrom, and Shipper. - None of the following country or territory codes are the same and are a member of the EU: ShipTo, ShipFrom, and Shipper. - If any of the two following country or territory codes: ShipTo/ShipFrom/ Shipper are members in EU otherwise check if the shipper has Third country or territory Contract.
ShipmentRequest.Shipment.ShipFrom.Address.PostalCode -- The ship from locations postal code. 9 characters are accepted. Required if ShipFrom is supplied and the ShipFrom country or territory is the US and Puerto Rico. For US and Puerto Rico, it must be valid 5 or 9 digit postal code. The character "-" may be used to separate the first five digits and the last four digits. If the ShipFrom country or territory is CA, then the postal code must be 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit. For all other countries or territories the postal code is optional and must be no more than 9 alphanumeric characters long.
ShipmentRequest.Shipment.ShipFrom.Address.StateProvinceCode -- Origin location's state or province code. Required if ShipFrom is supplied, and ShipFrom country or territory is US. If ShipFrom country or territory is US or CA, then the value must be a valid US State/ Canadian Province code. If the country or territory is Ireland, the StateProvinceCode will contain the county or territory.
ShipmentRequest.Shipment.ShipFrom.AttentionName -- The ship from Attention name. 35 characters are accepted, but for return Shipment only 30 characters will be printed on the label. Required if ShipFrom tag is in the XML and Invoice or CO International forms is requested. If not present, will default to the Shipper Attention Name.
ShipmentRequest.Shipment.ShipFrom.CompanyDisplayableName -- Not applicable for ShipFrom.
ShipmentRequest.Shipment.ShipFrom.FaxNumber -- The Ship from fax number. If Ship from country or territory is US 10 digits allowed, otherwise 1-15 digits allowed.
ShipmentRequest.Shipment.ShipFrom.Name -- The ship from location's name or company name. 35 characters are accepted, but for return Shipment only 30 characters will be printed on the label. Required if ShipFrom tag is in the XML.
ShipmentRequest.Shipment.ShipFrom.Phone --
ShipmentRequest.Shipment.ShipFrom.Phone.Extension -- The Ship from phone extension.
ShipmentRequest.Shipment.ShipFrom.Phone.Number -- The Ship from phone Number.
ShipmentRequest.Shipment.ShipFrom.TaxIDType --
ShipmentRequest.Shipment.ShipFrom.TaxIDType.Code -- Company's tax Identification type. Valid values: EIN, DNS, and FGN. Applies to EEI form only.
ShipmentRequest.Shipment.ShipFrom.TaxIDType.Description -- Description of TaxID submitted. Applies to EEI form only.
ShipmentRequest.Shipment.ShipFrom.TaxIdentificationNumber -- Company's Tax Identification Number at the pick up location. Conditionally required if EEI form (International forms) is requested. Applies to EEI Form only.
ShipmentRequest.Shipment.ShipFrom.VendorInfo --
ShipmentRequest.Shipment.ShipFrom.VendorInfo.ConsigneeType -- Consignee Type. 01 = Business 02 = Consumer NA = Not Applicable
ShipmentRequest.Shipment.ShipFrom.VendorInfo.VendorCollectIDNumber -- Shipper's VAT Tax collection registration number to be entered by Shipper at time of shipment creation. Presence of this number as part of the shipment information implies the shipper has collected/paid the required VAT tax (outside of UPS/UPS systems). Vendor Colect ID Number will be printed on commercial invoice if present. Sample Values: 'IMDEU1234567' (IOSS #), 'VOEC1234567' (VOEC #), 'GB1234567' (HMRC #) Required if the shipment is subject to Vendor Collect ID collection
ShipmentRequest.Shipment.ShipFrom.VendorInfo.VendorCollectIDTypeCode -- Code that identifies the type of Vendor Collect ID Number. Valid Values- 0356 = IOSS- 0357 = VOEC- 0358 = HMRCVendor Collect ID Number type code will be printed on commercial invoice if present.
ShipmentRequest.Shipment.ShipTo --
ShipmentRequest.Shipment.ShipTo.Address --
ShipmentRequest.Shipment.ShipTo.Address.AddressLine -- Address Line of the consignee. Only first two Address Lines will be printed on the label.
ShipmentRequest.Shipment.ShipTo.Address.City -- Consignee's city. 30 characters are accepted, but only 15 characters will be printed on the label.
ShipmentRequest.Shipment.ShipTo.Address.CountryCode -- Consignee's country or territory code. Must be a valid UPS Billing country or territory code.For Return Shipment the country or territory code must meet the following conditions: - At least two of the following country or territory codes are the same: ShipTo, ShipFrom, and Shipper.- None of the following country or territory codes are the same and are a member of the EU: ShipTo, ShipFrom, and Shipper. - If any of the two following country or territory codes: ShipTo/ ShipFrom/ Shipper are members in EU otherwise check if the shipper has Third country or territory Contract.
ShipmentRequest.Shipment.ShipTo.Address.PostalCode -- Consignee's postal code. If the ShipTo country or territory is US or Puerto Rico, 5 or 9 digits are required. If the ShipTo country or territory is CA, then the postal code is required and must be 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit. Otherwise optional. For all other countries or territories the postal code is optional and must be no more than 9 alphanumeric characters long.
ShipmentRequest.Shipment.ShipTo.Address.ResidentialAddressIndicator -- This field is a flag to indicate if the receiver is a residential location. True if ResidentialAddressIndicator tag exists. This is an empty tag, any value inside is ignored.
ShipmentRequest.Shipment.ShipTo.Address.StateProvinceCode -- Consignee's state or province code. Required for US or Canada. If destination is US or CA, then the value must be a valid US State/ Canadian Province code. If the country or territory is Ireland, the StateProvinceCode will contain the county.
ShipmentRequest.Shipment.ShipTo.AttentionName -- Contact name at the consignee's location. Required for: UPS Next Day Air® Early service, and when ShipTo country or territory is different than ShipFrom country or territory. Required if Invoice International form is requested.
ShipmentRequest.Shipment.ShipTo.CompanyDisplayableName -- Not applicable for ShipTo
ShipmentRequest.Shipment.ShipTo.EMailAddress -- Consignee's email address.
ShipmentRequest.Shipment.ShipTo.FaxNumber -- Consignee's fax number. If ShipTo country or territory is US 10 digits allowed, otherwise 1-15 digits allowed.
ShipmentRequest.Shipment.ShipTo.LocationID -- Location ID is a unique identifier referring to a specific shipping/receiving location. Location ID must be alphanumeric characters. All letters must be capitalized.
ShipmentRequest.Shipment.ShipTo.Name -- Consignee's company name. All other accounts must be either a daily pickup account or an occasional account.
ShipmentRequest.Shipment.ShipTo.Phone --
ShipmentRequest.Shipment.ShipTo.Phone.Extension -- Consignee's phone extension.
ShipmentRequest.Shipment.ShipTo.Phone.Number -- Consignee's phone Number. Required for: UPS Next Day Air® Early service, and when Ship To country or territory is different than the ShipFrom country or territory. If ShipTo country or territory is US, PR, CA, and VI, the layout is: area code, 7 digit PhoneNumber or area code, 7 digit PhoneNumber, 4 digit extension number; number.For other countries or territories, the layout is: country or territory code, area code, 7 digit number.
ShipmentRequest.Shipment.ShipTo.TaxIdentificationNumber -- Consignee's tax identification number.
ShipmentRequest.Shipment.ShipmentDate -- User can send up to 7 days in the future with current date as day zero. Format: YYYYMMDD
ShipmentRequest.Shipment.ShipmentIndicationType --
ShipmentRequest.Shipment.ShipmentIndicationType.[].Code -- Valid values: - '01' - Hold for Pickup at UPS Access Point aka Direct to Retail (D2R)- '02' - UPS Access Point™ Delivery aka Retail to Retail (R2R) If '01' code is present indicates shipment will be send to Retail location where it is held to consignee to claim.
ShipmentRequest.Shipment.ShipmentIndicationType.[].Description -- Description for the code.
ShipmentRequest.Shipment.ShipmentRatingOptions --
ShipmentRequest.Shipment.ShipmentRatingOptions.FRSShipmentIndicator -- Ground Freight Pricing Rates option indicator. If the Ground Freight Pricing Shipment indicator is enabled and Shipper number is authorized then Ground Freight Pricing rates should be returned in the response. The Shipper account number must be qualified to receive Ground Freight Pricing Density Based Shipment rates. Only the Shipper account number taken from /ShipmentRequest/Shipment/FRSPaymentInformation/AccountNumber is used when checking qualification for Ground Freight Pricing Density Based rates.
ShipmentRequest.Shipment.ShipmentRatingOptions.NegotiatedRatesIndicator -- Negotiated Rates option indicator. If the indicator is present and the Shipper is authorized then Negotiated Rates should be returned in the response. Negotiated Rates are of two types Account Based Rates (ABR) and Web Discount Rates. Negotiated Rates are only returned for qualified Shipper Account Numbers. Eligibility is determined using the combination of UserId and the Shipper's Shipper Account Number. If the user is qualified, both Published rates and Negotiated rates are returned to the user. If the UserId and Shipper Account Number are not qualified for Negotiated rates, a warning message is returned that indicates ineligibility and only the Published rates are returned in the response. As per discount eligibility of user, negotiated rates in the response may contain ABR or Web discount rates.
ShipmentRequest.Shipment.ShipmentRatingOptions.RateChartIndicator -- RateChartIndicator, if present in request, response will contain RateChart element.
ShipmentRequest.Shipment.ShipmentRatingOptions.TPFCNegotiatedRatesIndicator -- This indicator applies for a third party (3P) / Freight collect (FC) shipment only. For 3P/FC shipment if the shipper wishes to request for the negotiated rates of the third party then this indicator should be included in the request. If authorized the 3P/FC negotiated rates will be applied to the shipment and rates will be returned in response.
ShipmentRequest.Shipment.ShipmentRatingOptions.UserLevelDiscountIndicator -- If this indicator is present user level discount will be applied to rates if applicable Conditions checked:This indicator should be presentShipper number should not be presentUser should be eligible for user level discount
ShipmentRequest.Shipment.ShipmentServiceOptions --
ShipmentRequest.Shipment.ShipmentServiceOptions.AccessPointCOD --
ShipmentRequest.Shipment.ShipmentServiceOptions.AccessPointCOD.CurrencyCode -- Access Point COD Currency Code.
ShipmentRequest.Shipment.ShipmentServiceOptions.AccessPointCOD.MonetaryValue -- Access Point COD Monetary Value.
ShipmentRequest.Shipment.ShipmentServiceOptions.COD --
ShipmentRequest.Shipment.ShipmentServiceOptions.COD.CODAmount --
ShipmentRequest.Shipment.ShipmentServiceOptions.COD.CODAmount.CurrencyCode -- COD amount currency code type.
ShipmentRequest.Shipment.ShipmentServiceOptions.COD.CODAmount.MonetaryValue -- COD Amount monetary value.
ShipmentRequest.Shipment.ShipmentServiceOptions.COD.CODFundsCode -- For valid values refer to: Rating and Shipping COD Supported Countries or Territories in the Appendix.
ShipmentRequest.Shipment.ShipmentServiceOptions.CommercialInvoiceRemovalIndicator -- CommercialInvoiceRemovalIndicator allows a shipper to dictate UPS to remove the Commercial Invoice from the user's shipment before the shipment is delivered to the ultimate consignee.
ShipmentRequest.Shipment.ShipmentServiceOptions.DeliverToAddresseeOnlyIndicator -- Presence/Absence Indicator. Any value inside is ignored. DeliverToAddresseeOnlyIndicator is shipper specified restriction that requires the addressee to be the one who takes final delivery of the "Hold For PickUp at UPS Access Point" package. Presence of indicator means shipper restriction will apply to the shipment. Only valid for Shipment Indication type "01 - Hold For PickUp at UPS Access Point".
ShipmentRequest.Shipment.ShipmentServiceOptions.DeliveryConfirmation --
ShipmentRequest.Shipment.ShipmentServiceOptions.DeliveryConfirmation.DCISNumber -- DCIS Number.
ShipmentRequest.Shipment.ShipmentServiceOptions.DeliveryConfirmation.DCISType -- Type of delivery confirmation. Valid values: 1 - Delivery Confirmation Signature Required2 - Delivery Confirmation Adult Signature Required. Valid for forward shipments only.
ShipmentRequest.Shipment.ShipmentServiceOptions.DirectDeliveryOnlyIndicator -- Presence/Absence Indicator. Any value inside is ignored. Direct Delivery Only (DDO) accessorial in a request would ensure that delivery is made only to the ship to address on the shipping label. This accessorial is not valid with Shipment Indication Type "01 - Hold For Pickup At UPS Access Point" and "02 - UPS Access Point™ Delivery".
ShipmentRequest.Shipment.ShipmentServiceOptions.DropoffAtUPSFacilityIndicator -- Drop off At UPS Facility indicator. The empty tag means indicator is present. This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment.
ShipmentRequest.Shipment.ShipmentServiceOptions.EPRAReleaseCode -- Package Release code allows the consignee or claimant to pick-up a package at a UPS Access Point™. The shipper must provide the Package Release Code to the consignee so that they can provide the code to the UPS Access Point personnel as another item for authentication before the package is released to them. Package Release Code is only valid with ShipmentIndicationType 01 - Hold for Pickup at UPS Access Point™. The release code must be between length 4 and 6 and only contain numbers.
ShipmentRequest.Shipment.ShipmentServiceOptions.ExchangeForwardIndicator -- Exchange forward indicator presence at shipment level is required to create exchange forward Shipments. In the label routing Instruction text will be defaulted to "EXCHANGE-LIKE ITEM ONLY".
ShipmentRequest.Shipment.ShipmentServiceOptions.HoldForPickupIndicator -- Hold For Pickup indicator. The empty tag means indicator is present. This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment.
ShipmentRequest.Shipment.ShipmentServiceOptions.ImportControlIndicator -- Indicates that the Shipment is an ImportControl shipment.
ShipmentRequest.Shipment.ShipmentServiceOptions.InsideDelivery -- Inside delivery accessory. Valid values:01 - White Glove02 - Room of Choice03 - InstallationDefault is Room of Choice. Shippers account needs to have a valid contract for Heavy Goods Service.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.AdditionalDocumentIndicator -- Presence of the indicator means user will supply additional document, such as EEI, NAFTA_CO or CO. This indicator should be set when the shipper intends to utilize UPS paperless invoice functionality AND the shipper has SELF-PREPARED other International Forms (EEI, CO, NAFTACO) to accompany the shipment. It is evaluated only when: 1. Account is paperless enabled. 2. Movement requires an invoice.3. Destination country or territory accepts paperless invoice. 4. Invoice data is supplied by the client and the data passes validation.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.BlanketPeriod --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.BlanketPeriod.BeginDate -- Begin date of the blanket period. It is the date upon which the Certificate becomes applicable to the good covered by the blanket Certificate (it may be prior to the date of signing this Certificate). Applies to NAFTA CO form only. Required for NAFTA CO. Format is yyyyMMdd. This is not valid for a paperless shipment.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.BlanketPeriod.EndDate -- End Date of the blanket period. It is the date upon which the blanket period expires. Applies to NAFTA CO form only. Required for NAFTA CO. Format is yyyyMMdd. This is not valid for a paperless shipment.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content.[].CN22ContentCountryOfOrigin -- Country or Territory of Origin from where the CN22 contents originated.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content.[].CN22ContentCurrencyCode -- Currently only USD is supported. Required if the CN22 form container is present.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content.[].CN22ContentDescription -- Detailed description of the content.If the combined MI package and CN22 label is requested, only the first 30 characters will appear on the combined label. Required if the CN22 form container is present.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content.[].CN22ContentQuantity -- Total number of items associated with this content. Required if the CN22 form container is present.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content.[].CN22ContentTariffNumber -- The tariff number associated with the CN22 contents.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content.[].CN22ContentTotalValue -- Total value of the items associated with this content. Required if the CN22 form container is present.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content.[].CN22ContentWeight --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content.[].CN22ContentWeight.UnitOfMeasurement --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content.[].CN22ContentWeight.UnitOfMeasurement.Code -- Required if weight is provided, valid values are lbs. and ozs. Required if weight is provided.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content.[].CN22ContentWeight.UnitOfMeasurement.Description -- Short description for UnitOfMeasurement.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Content.[].CN22ContentWeight.Weight -- Total weight of the content. Pounds and Ounces are allowed up to 2 decimals. Required if the CN22 form container is present.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22OtherDescription -- Required if CN22Type is OTHER. Required if the CN22 form container is present.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.CN22Type -- Valid values: 1 = GIFT2 = DOCUMENTS3 = COMMERCIAL SAMPLE4 = OTHER Required if the CN22 form container is present.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.FoldHereText -- String will replace default "Fold Here" text displayed on the label.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.LabelPrintType -- Valid Values are pdf, png, gif, zpl, star, epl2 and spl. Required if the CN22 form container is present.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.LabelSize -- Provide the valid values: 6 = 4X61 = 8.5X11 Required if the CN22 form container is present.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CN22Form.PrintsPerPage -- Number of label per page. Currently 1 per page is supported. Required if the CN22 form container is present.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CarrierID -- The four-character Standard Carrier Alpha Code (SCAC) for vessel, rail, and truck shipments. For air shipment, enter the two or three character International Air Transport Association (IATA) code. Applies to EEI forms only. No Validations.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Comments -- Any extra information about the current shipment. Applies to Invoice and Partial Invoice forms only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.ForwardAgent --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.ForwardAgent.Address --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.ForwardAgent.Address.AddressLine -- Address line of the Forwarding agent. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.ForwardAgent.Address.City -- City of the Forwarding agent. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.ForwardAgent.Address.CountryCode -- Country or Territory code of the Forwarding agent. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.ForwardAgent.Address.PostalCode -- Postal code of the Forwarding agent. Applicable for EEI form only. Required for certain countries or territories. The length of the postal code depends on the country or territory code
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.ForwardAgent.Address.StateProvinceCode -- State of the Forwarding agent. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.ForwardAgent.Address.Town -- Town of the Forwarding Agent. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.ForwardAgent.CompanyName -- Company Name or the Individual name of the Forwarding agent. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.ForwardAgent.TaxIdentificationNumber -- Tax ID of the Forwarding agent.Valid Values: (Below values are applicable for EEIFilingOption Code =3)94-308351500 13-168669100 Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.IntermediateConsignee --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.IntermediateConsignee.Address --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.IntermediateConsignee.Address.AddressLine -- Address line of the Intermediate Consignee. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.IntermediateConsignee.Address.City -- City of the Intermediate Consignee. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.IntermediateConsignee.Address.CountryCode -- Country or Territory code of the Intermediate Consignee. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.IntermediateConsignee.Address.PostalCode -- Postal code of the Intermediate Consignee. Applicable for EEI form only. Required for certain countries or territories. The length of the postal code depends on the country or territory code.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.IntermediateConsignee.Address.StateProvinceCode -- State of the Intermediate Consignee. Applicable for EEI form only. Required for certain countries or territories.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.IntermediateConsignee.Address.Town -- Town of the Intermediate consignee. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.IntermediateConsignee.CompanyName -- Company Name or the Individual name of the Intermediate consignee. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.Address --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.Address.AddressLine -- Address line of the Producer.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.Address.City -- City of the Producer. Applies to NAFTA CO. Conditionally required for: NAFTA CO, when Producer option is not specified.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.Address.CountryCode -- Country or Territory code of the Producer. Applies to NAFTA CO.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.Address.PostalCode -- Postal code of the Producer. Applies to NAFTA CO. Required for certain countries or territories. The length of the postal code depends on the country or territory code.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.Address.StateProvinceCode -- State of the Producer. Applies to NAFTA CO. Required for certain countries or territories.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.Address.Town -- Town of the Producer.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.AttentionName -- Contact name at the Producer location. Applies to NAFTA CO.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.CompanyName -- Company Name or the Individual name of the Producer. Applies to NAFTA CO. Only applicable when producer option is empty or not present. Conditionally required for: NAFTA CO, when Producer option is not specified.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.EMailAddress -- Producer email address. Applies to NAFTA CO.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.Option -- The text associated with the code will be printed in the producer section instead of producer contact information. Use attached List if more than one producer's good is included on the Certificate, attach a list of additional producers, including the legal name, address (including country or territory), and legal tax identification number, cross-referenced to the goods described in the Description of Goods field. Applies to NAFTA CO. Valid values: 01 - AVAILABLE TO CUSTOMS UPON REQUEST02 - SAME AS EXPORTER03 - ATTACHED LIST04 - UNKNOWN
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.Phone --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.Phone.Extension -- The locations phone extension of the Producer. Applies to NAFTA CO.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.Phone.Number -- The locations phone number of the Producer. Applies to NAFTA CO.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.Producer.TaxIdentificationNumber -- Tax ID of the Producer. Applies to NAFTA CO. Only applicable when producer option is empty or not present
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.AccountNumber -- SoldTo AccountNumber
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Address --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Address.AddressLine -- SoldTo location's street address. Applies to NAFTA CO.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Address.City -- SoldTo location's city.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Address.CountryCode -- SoldTo location's country or territory code.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Address.PostalCode -- SoldTo location's postal code.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Address.StateProvinceCode -- SoldTo location's state or province code. Required for certain countries or territories.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Address.Town -- SoldTo location's town code.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.AttentionName -- Sold to contact name.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.EMailAddress -- SoldTo email address.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Name -- Company Name.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Option -- The text associated with the code will be printed in the sold to section of the NAFTA CO form. The values indicate the following: 01 – Unknown. Applies to NAFTA CO form. Possible Values are 01 and 02.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Phone --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Phone.Extension -- Sold To contacts phone extension.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.Phone.Number -- Sold To contacts phone number.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.SoldTo.TaxIdentificationNumber -- SoldTo Tax Identification Number.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee.Address --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee.Address.AddressLine -- Address line of the Ultimate consignee. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee.Address.City -- City of the Ultimate consignee. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee.Address.CountryCode -- Country or Territory code of the Ultimate consignee. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee.Address.PostalCode -- Postal code of the Ultimate consignee. Applicable for EEI form only. Required for certain countries or territories. The length of the postal code depends on the country or territory code.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee.Address.StateProvinceCode -- State of the Ultimate consignee. Applicable for EEI form only. Required for certain countries or territories. The length of the postal code depends on the country or territory code
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee.Address.Town -- Town of the Ultimate consignee. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee.CompanyName -- Company Name or the Individual name of the Ultimate consignee. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee.UltimateConsigneeType --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee.UltimateConsigneeType.Code -- Ultimate Consignee Type Code. Applicable for EEI form only.Valid values: D = Direct Consumer G = Government EntityR = ResellerO = Other/Unknown
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Contacts.UltimateConsignee.UltimateConsigneeType.Description -- Ultimate Consignee Type Description. Applicable for EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.ContainerizedIndicator -- If present indicates that the goods are containerized. This applies to vessel shipments only. Applies to EEI forms only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.CurrencyCode -- Currency code for all the monetary values of the Invoice form. Applies to Invoice and Partial Invoice forms only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.DeclarationStatement -- This is the legal explanation, used by Customs, for the delivering of this shipment. It must be identical to the set of declarations actually used by Customs. Examples of declarations that might be entered in this field are: I hereby certify that the goods covered by this shipment qualify as originating goods for purposes of preferential tariff treatment under the NAFTA. I hereby certify that the information on this invoice is true and correct and the contents and value of this shipment is as stated above. EEA statement: The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of EEA preferential origin. Applies to Invoice and Partial Invoice forms only. On the invoice for return shipment, the verbiage is as follows (user input is ignored): The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of EEA preferential origin
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Discount --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Discount.MonetaryValue -- The discount to be subtracted from the sum of the total value on the invoice. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places. This value should be greater than or equal to zero or less than or equal to the value of all goods listed on the invoice.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.Code -- Required for EEI Form. Applicable for EEI form.Valid values: 1 - Shipper filed,2 - AES Direct, 3 - UPS filed.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.Description -- Optional Description of Filing Code. Applicable for EEI form.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.EMailAddress -- Email Address where the notification is sent. Valid for UPS filed (option 3), Shipper filed (option 1- A , 1-C) Applicable for EEI form.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.ShipperFiled --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.ShipperFiled.Code -- Indicates the EEI Shipper sub option. Applicable for EEI form and is required. Valid value is: A- requires the ITN; B- requires the Exemption Legend; C- requires the post departure filing citation.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.ShipperFiled.Description -- Description of ShipperFiled Code. Applicable for EEI form.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.ShipperFiled.EEIShipmentReferenceNumber -- Shipment Reference Number for use during interaction with AES. Valid for EEI form for Shipper Filed option 'C' and AES Direct Filed.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.ShipperFiled.ExemptionLegend -- Input for Shipper Filed option B. 30.2(d)(2), 30.26(a), 30.36, 30.37(a), 30.37(b), 30.37(c), 30.37(d), 30.37(e), 30.37(f), 30.37(h), 30.37(i), 30.30(j), 30.37(k), 30.37(i), 30.37(j), 30.37(k), 30.37(l), 30.37(m), 30.37(n), 30.37(o), 30.37(p), 30.37(q), 30.37(r), 30.37(s), 30.37(t), 30.37(u), 30.37(x), 30.37(y)(1), 30.37(y)(2), 30.37(y)(3), 30.37(y)(4), 30.37(y)(5), 30.37(y)(6), 30.39, 30.40(a), 30.40(b), 30.40(c), 30.40(d), 30.8(b) Valid and Required for Shipper Filed option B. EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.ShipperFiled.PreDepartureITNNumber -- Input for Shipper Filed option A and AES Direct. The format is available from AESDirect website. Valid and Required for Shipper Filed option A. EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.UPSFiled --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.UPSFiled.POA --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.UPSFiled.POA.Code -- Indicates the EEI UPS Filed POA filing option. Applicable for EEI form. Valid values are 1- One Time POA; 2- Blanket POA.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EEIFilingOption.UPSFiled.POA.Description -- Description for POA Code. Applicable for EEI form.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.EntryNumber -- The Import Entry Number when the export transaction is used as proof of export for import transactions (examples: In Bond, Temporary Import Bond or Drawbacks). Applies to EEI forms only. Conditionally Required for EEI forms when In bond code value is other than 70 (Not In Bond)
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.ExportDate -- The date the goods will be exiting the country or territory. Applies to CO and EEI forms only. Required for CO and EEI forms. Format is yyyyMMdd.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.ExportingCarrier -- The name of the carrier that is exporting the shipment. The vessels flag number should also be entered, if the carrier is a vessel.If value is empty, it will be set to default value as 'UPS' for EEI forms. Applies to CO and EEI forms only. Required for CO forms.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.FormGroupIdName -- Contains description text which identifies the group of International forms. This element does not appear on the forms.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.FormType -- Indicates the name of the International Form requested.Valid values: - 01 - Invoice- 03 - CO- 04 - NAFTA CO- 05 - Partial Invoice- 06 - Packinglist- 07 - Customer Generated Forms- 08 – Air Freight Packing List- 09 - CN22 Form- 10 – UPS Premium Care Form- 11 - EEIFor shipment with return service, 05 or 10 are the only valid values.Note: 01 and 05 are mutually exclusive and 05 are only valid for return shipments only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.FreightCharges --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.FreightCharges.MonetaryValue -- Cost to transport the shipment. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.HazardousMaterialsIndicator -- This is an empty tag. Presence of the indicator for EEI form means shipment contains hazardous material.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.InBondCode -- The two-character In Bond Code. Applies to EEI forms only. Required for EEI forms. Valid values for EEI are: 70: Not in bond; 67: IE from a FTZ; 68: T&E from a FTZ.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.InsuranceCharges --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.InsuranceCharges.MonetaryValue -- The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.InvoiceDate -- Date when the Invoice is created. Ideally this is the same as the ship date. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Required for Invoice form for forward shipments. For shipment with return service, the user input will be ignored, and the field will be blank on the invoice. Format is yyyyMMdd.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.InvoiceNumber -- Commercial Invoice number assigned by the exporter. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.LoadingPier -- Pier where goods are loaded. For vessel shipments only. Applies to EEI forms only. No validation is performed.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.ModeOfTransport -- Mode of transport by which the goods are exported. Valid values: Air, AirContainerized, Auto, FixedTransportInstallations, Mail, PassengerHandcarried, Pedestrian, Rail, Rail, Containerized, RoadOther, SeaBarge, SeaContainerized, SeaNoncontainerized, Truck, TruckContainerized. Applies to EEI forms only. Required for EEI. Only allowed values can be entered. Only 10 Characters can appear on the form. Anything greater than 10 characters will be truncated on the form.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.OtherCharges --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.OtherCharges.Description -- Description of what the other charges are for. Applies to Invoice and Partial Invoice forms only. Required for Complete Invoice and Optional for Partial Invoice forms.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.OtherCharges.MonetaryValue -- The Monetary value of Other Charges. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.OverridePaperlessIndicator -- The application will automatically provide a copy of the invoice or NAFTA/CO with each response regardless of whether the user has enabled Paperless account. The user now has the option to print or ignore the copy provided.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.PartiesToTransaction -- Information about parties to transaction. Use Related, if the parties to the transaction are related. A related party is an export from a U.S. businessperson or business to a foreign business or from a U.S. business to a foreign person or business where the person has at least 10 percent of the voting shares of the business during the fiscal year. If unincorporated, then an equivalent interest in the business. Applies to EEI forms only. Valid values: - R - Related- N - Non-related.Parties to transaction is required if EEIFilingOption Code is 3 and if valid UPSFiled POA Code present in request. Default will be set to N - Non-related if invalid code present with length of one.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.PointOfOrigin -- Contains one of the following: The two-digit U.S. Postal Service abbreviation for the state from which the goods were shipped to the port of export. The state that is the source for the good with the highest value. The state of consolidation. The Foreign Trade Zone number of the zone from where the exports are leaving. If the goods were shipped from Puerto Rico, enter PR. Applies to EEI forms only. Required for EEI.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.PointOfOriginType -- Valid values are : S (for state postal code abbreviation) , F : FTZ Identifier Applies EEI forms only. Required for EEI form.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.PortOfExport -- Should be one of the following-Overland: The U.S. Customs port where the carrier crosses the U.S. border, Vessel and Air: The U.S. Customs port where the goods are loaded on the carrier to be exported from the U.S., Postal: The U.S. Postal Office from where the goods are mailed. Applies to EEI forms only. No validation is performed.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.PortOfUnloading -- The country or territory and the port where the goods will be unloaded from the exporting carrier. For vessel and air shipments only. Applies to EEI forms only. No validation is performed.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].CommodityCode -- 6-to-15-alphanumeric commodity code. Customs uses this code to determine what duties should be assessed on the commodity. Applies to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional for Partial Invoice. Should be at least 6 alphanumeric. For NAFTA CO: For each good described in Description of Goods field, identify the H.S. tariff classification to six digits. If the good is subject to a specific rule of origin in Annex 401 that requires eight digits, identify to eight digits, using the H.S. tariff classification of the country or territory into whose territory the good is imported.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].Description -- Description of the product. Applies to all International Forms. Optional for Partial Invoice. Must be present at least once and can occur for a maximum of 3 times.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.DDTCInformation --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.DDTCInformation.ACMNumber -- Approved Community Member Number (ACM). It is required to be provided along with ITARExemptionNumber for some License code (SGB and SAU). The ACM# for the United Kingdom (License code SGB) must begin with UK followed by 9 numbers. The ACM# for Australia (License Code SAU) must begin with DTT followed by 8 numbers. Applies to EEI form only. It is required for EEIFilingOption code 1A and 3.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.DDTCInformation.EligiblePartyIndicator -- Presence/Absent indicator. Certification by the U.S. exporter that the exporter is an eligible party to participate in the defense trade.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.DDTCInformation.ITARExemptionNumber -- The specific citation (exemption number) under the International Traffic in Arms Regulations (ITAR) from the Code of Federal Register (see 22 CFR 120-130) that exempts the shipment from the requirements for a license or other written authorization from the Directorate of Trade Controls (DDTC). Refer to EEI License Codes in the Appendix for valid values. Applies to EEI Form only. This field is applicable for EEIFiling option 1A and 3.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.DDTCInformation.Quantity -- Export Quantity. Applies to EEI form only. It is required for EEIFilingOption code 3. Only positive integer value is valid.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.DDTCInformation.RegistrationNumber -- It is a unique registration code assigned to the registrant. The DDTC registration code consist of a letter prefix, M (assigned to a manufacturer and/or exporter) or K (assigned to a broker), followed by four or five digits (e.g. K-1234 or M12345). It is required for EEIFilingOption code 3.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.DDTCInformation.SignificantMilitaryEquipmentIndicator -- Presence/ Absence Indicator. Applies to EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.DDTCInformation.USMLCategoryCode -- Digit numeric code (e.g. 01-18, 20 or 21). Indicates the U.S. Munitions List (USML) category article, service or related technical data as it applies to the article reported. Applies to EEI form only. It is required for EEIFilingOption code 3.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.DDTCInformation.UnitOfMeasurement --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.DDTCInformation.UnitOfMeasurement.Code -- Required for EEI form. Unit of measurement code. The two or three (3) alpha unit of measurement for the article being shipped. For example: BAG/BG - bags Applies to EEI form only. It is required for EEIFilingOption code 1A and 3.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.DDTCInformation.UnitOfMeasurement.Description -- Description for Unit of Measurement. Applies to EEI form only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.ExportInformation -- Required for EEI form id it is a SDL product. Valid values: LC, LV, SS,MS, GS, DP, HR, UG, IC, SC, DD, HH, SR, TE,TL, IS, CR, GP, RJ, TP, IP, IR, DB, CH, RS, OS Applies to EEI form only. Required if EEIFilingOption code 3 specified for EEI form.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.License --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.License.Code -- The standard license code published by US government. Refer to EEI License Codes in the Appendix for valid values. Applies to EEI form only. It is required for EEIFilingOption code 3. It is optionally required for all other filing types; however, it is used to categorize each product as SDL or non-SDL. It is also used to identify which piece of information is applicable.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.License.ECCNNumber -- Product ECCN Number issued by BIS (Bureau of Industry and Security). If the license number is a commerce license, ECCN must be provided. The format is #A### or EAR99 Applies to EEI forms only. It is required for EEIFilingOption code 3. ECCN is required one of the following License Exception Codes is entered: CIV, CTP, ENC, GBS, KMI, LVS, TSR
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.License.LicenseLineValue -- The export monetary amount allowed per license. Required for a licensable product when the EEI form is selected.Format: Whole numbers only. Applies to EEI form only. Required if EEIFilingOption code 1A (only for SDL shipments) or 3.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].EEIInformation.License.Number -- Represents any one of the following values: export license number, exception code, CFR citation, KPC Number, ACM Number. Applies to EEI form only.Refer to EEI License Types and Exemptions in the Appendix for valid values and formats.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ExcludeFromForm --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ExcludeFromForm.FormType -- Indicates the name of the International form requested to NOT have product information. Possible Values are 04 – NAFTA CO. Please note that if this is used and you DO NOT have the corresponding form type requested this will be IGNORED.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ExportType -- Code indicating Domestic: Exports that have been produced, manufactured, or grown in the United States or Puerto Rico. This includes imported merchandise which has been enhanced in value or changed from the form in which imported by further manufacture or processing in the United States or Puerto Rico. Foreign: Merchandise that has entered the United States and is being exported again in the same condition as when imported. Applies to EEI forms only. Required for EEI form. Valid values: D: Domestic; F: Foreign.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].JointProductionIndicator -- If present, JNT will be used as the origin of country or territory code on the NAFTA form and the Product/Origincountry or territoryCode tag will be ignored. Applies to NAFTA CO only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].MarksAndNumbers -- Any special marks, codes, and numbers that may appear on package. Applies to CO Only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].NetCostCode -- For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to NAFTA CO only. Required for NAFTA CO. Valid values: - NC- ND- NO
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].NetCostDateRange --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].NetCostDateRange.BeginDate -- If the RVC is calculated over a period of time, it should be identified by the begin date (yyyyMMdd) of that period. (Reference: Articles 402.1, 402.5). Applies to NAFTA CO only. Format is yyyyMMdd.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].NetCostDateRange.EndDate -- If the RVC is calculated over a period of time, it should be identified by the End date (yyyyMMdd) of that period. (Reference: Articles 402.1, 402.5). Applies to NAFTA CO only. Format is yyyyMMdd.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].NumberOfPackagesPerCommodity -- The total number of packages, cartons, or containers for the commodity. Applicable for CO and is required. Should be numeric. Valid characters are 0 -9.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].OriginCountryCode -- The country or territory in which the good was manufactured, produced or grown. For detailed information on country or territory of origin, certificate of origin, rules of origin, and any related matters, please refer to the U.S. Customs and Border Protection Web site at www.customs.gov or contact your country or territory's Customs authority.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].PackingListInfo --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].PackingListInfo.PackageAssociated --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].PackingListInfo.PackageAssociated.[].PackageNumber -- Package number the product should be allocated to ont he packing list. Required for packaging list and Air Freight Packing list.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].PackingListInfo.PackageAssociated.[].ProductAmount -- Amount of Product associated with a package. Required for packaging list and Air Freight Packing list.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].PackingListInfo.PackageAssociated.[].ProductNote -- Product Note.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].PartNumber -- The part number or reference number for the product contained in the invoice line, as indicated on the customs invoice. Applies to Invoice and Partial Invoice. Required for Invoice forms and optional for Partial Invoice.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].PreferenceCriteria -- Indicates the criterion (A through F) for each good described in the Description of Goods field if applicable. The rules of origin are contained in Chapter Four and Annex 401. Additional rules are described in Annex 703.2 (certain agricultural goods), Annex 300-B, Appendix 6 (certain textile goods) and Annex 308.1 (certain automatic data processing goods and their parts). Applies to NAFTA CO only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ProducerInfo -- Indicate the following: Yes - If shipper is the producer of the good. If not, state 02, 03, and 04 depending on whether this certificate was based upon: No [1] - Knowledge of whether the good qualifies as an originating good. No [2] - Reliance on the producers written representation (other than a Certificate of Origin) that the good qualifies as an originating good. No [3] - A completed and signed Certificate for the good voluntarily provided to the exporter by the producer. Applicable for NAFTA CO and is required. Valid values: Yes, No [1], No [2], and No [3].
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ProductWeight --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ProductWeight.UnitOfMeasurement --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ProductWeight.UnitOfMeasurement.Code -- Code for unit of Measurement of weight. Applies to CO and EEI forms only. Valid values: - KGS- LBS
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ProductWeight.UnitOfMeasurement.Description -- Description of the Unit of Measure.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ProductWeight.Weight -- Weight of Product. Applies to CO and EEI forms only. Valid characters are 0-9 and '.' (Decimal point). Limit to 1 digit after the decimal. The maximum length of the field is 5 including '.' and can hold up to 1 decimal place.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].SEDTotalValue -- This amount will always be USD. Applies to EEI forms only. Required for EEI form. Valid characters are 0-9 and \'.\' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including \'.\' and can hold up to 2 decimal places. Note: This value is calculated based on the Product/Unit/Value and /Product/Unit/Number (Number of Units * Price per Unit). If the total value is incorrect it will be replaced by the actual calculated total value.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ScheduleB --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ScheduleB.Number -- A unique 10-digit commodity classification code for the item being exported. (To classify a commodity access the following Web page: http://www.census.gov/foreign-trade/schedules/b/#search). Applies to EEI forms only. Has to be 10 characters.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ScheduleB.Quantity -- The count of how many Schedule B units of the current good are in the shipment (EEI only). For example, if the Schedule B unit of measure is dozens and eight dozen, is being shipped, indicate 8 in this field. Applies to EEI forms only. Conditionally required for EEI forms if ScheduleB UnitOfMeasurement is not X. Should be Numeric. Valid characters are 0 -9.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ScheduleB.UnitOfMeasurement --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ScheduleB.UnitOfMeasurement.[].Code -- The unit of measure indicated on the Export License. Enter an X if there is no unit of measure in the Schedule B Unit field. Applies to EEI forms only. Required for the EEI form. Refer to ScheduleB Unit of Measure Codes in the Appendix for valid values.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].ScheduleB.UnitOfMeasurement.[].Description -- Description of the Unit of Measure.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].Unit --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].Unit.Number -- Total quantity of each commodity to be shipped, measured in the units specified in the Unit of Measure field. Required for Invoice forms and optional for Partial Invoice. Must be numeric. Valid characters are 0-9.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].Unit.UnitOfMeasurement --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].Unit.UnitOfMeasurement.Code -- Code for the Unit of measurement of the commodity units. Required for Invoice forms and optional for Partial Invoice. Refer to Product Unit of Measure Codes in the Appendix for valid values.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].Unit.UnitOfMeasurement.Description -- The Unit of Measure if OTH (Other) is entered as the UnitOfMeasurement code. Applies to Invoice and Partial Invoice forms. Conditionally Required for the Invoice and Partial Invoice form if OTH is entered as the units UnitOfMeasurement Code.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].Unit.Value -- Monetary amount used to specify the worth or price of the commodity. Amount should be greater than zero. Applies to Invoice and Partial Invoice form. Required for Invoice forms and optional for Partial Invoice. Amount should be greater than zero. Valid characters are 0-9 and. (Decimal point). Limit to 6 digits after the decimal. The maximum length of the field is 19 including '.' and can hold up to 6 decimal places.(#####.######, ######.#####, #######.####, ########.###, #########.##,##########.#,############). The value of this product and the other products should be such that the invoice line total which is the sum of ( number*values) of all products should not exceed 9999999999999999.99
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.Product.[].VehicleID -- Includes the following information for used self-propelled vehicles as defined in Customs regulations 19 CFR 192.1: The unique Vehicle Identification Number (VIN) in the proper format. Or The Product Identification Number (PIN) for those used self-propelled vehicles for which there are no VINs. Or the Vehicle Title Number. Applies to EEI forms only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.PurchaseOrderNumber -- The customer's order reference number. Applies to Invoice and Partial Invoice forms only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.ReasonForExport -- A reason to export the current international shipment.Valid values: SALE, GIFT, SAMPLE, RETURN, REPAIR, INTERCOMPANYDATA, Any other reason. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and Optional for Partial Invoice. No validation.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.RoutedExportTransactionIndicator -- If Present, indicates that it is a routed export transaction. A routed export transaction is one, where the foreign principal party in interest authorizes a U.S. forwarding (or other) agent to export the merchandise outside the U.S. Applies to EEI forms only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.ShipperMemo -- Text for the shipper to add additional information. Forward shipment only.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.TermsOfShipment -- Indicates the rights to the seller from the buyer. Also, it refers to Terms of Sale. Applies to Invoice and Partial Invoice forms only. Valid values: CFR: Cost and Freight CIF: Cost Insurance and Freight CIP: Carriage and Insurance Paid CPT: Carriage Paid To DAF: Delivered at Frontier DDP: Delivery Duty Paid DDU: Delivery Duty Unpaid DEQ: Delivered Ex Quay DES: Delivered Ex Ship EXW: Ex Works FAS: Free Alongside Ship FCA: Free Carrier FOB: Free On Board
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.UPSPremiumCareForm --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.UPSPremiumCareForm.LanguageForUPSPremiumCare --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.UPSPremiumCareForm.LanguageForUPSPremiumCare.Language -- Languages for UPS Premium Care Form. Two languages are required for UPS Premium Care Form. Valid values: eng = US Englishfra = Canadian French
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.UPSPremiumCareForm.NumOfCopies -- Number of Copies of UPS Premium Care Form. Valid value is 02.
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.UPSPremiumCareForm.PageSize -- Size of UPS Premium Care Form. Valid values: 01 = A4 Size02 = Letter Size
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.UPSPremiumCareForm.PrintType -- Format of UPS Premium Care Form. Valid values: 01 = PNG02 = PDF
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.UPSPremiumCareForm.ShipmentDate -- Shipment Date associated with UPS Premium Care Shipment. Valid Format: yyyyMMdd
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.UserCreatedForm --
ShipmentRequest.Shipment.ShipmentServiceOptions.InternationalForms.UserCreatedForm.DocumentID -- DocumentID represents a document uploaded to Forms History.
ShipmentRequest.Shipment.ShipmentServiceOptions.ItemDisposal -- Presence/Absence indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the customer would like items disposed. Shippers account needs to have a valid contract for Heavy Goods Service.
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelDelivery --
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelDelivery.EMail --
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelDelivery.EMail.EMailAddress -- The destination eMail address for the Label Delivery.
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelDelivery.EMail.FromEMailAddress -- The e-mail address specifies the Reply To E-mail address. The "From" field of the message header contains pkginfo@ups.com.
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelDelivery.EMail.FromName -- The "FrontName" is the name from which notification will appear. Defaults to the "Shipper Name".
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelDelivery.EMail.Memo -- User defined text that will be included in the email.
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelDelivery.EMail.Subject -- The eMails subject. Defaults to the Label Delivery Notification plus the shipment ID. Defaults to text provided by UPS.
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelDelivery.EMail.SubjectCode -- Specifies a reference code and reference number to display in the subject of the Label Delivery notification. When the subject code is provided, the subject will contain the following: UPS Label Delivery, the reference code (the reference code will be mapped to the corresponding ANSI value) and the reference number.The valid subject codes are:- 01 - Shipment Reference Number 1, - 02 - Shipment Reference Number 2, - 03 - package Reference Number 1, - 04 - package Reference Number 2,- 05 - package Reference Number 3,- 06 - package Reference Number 4,- 07 - package Reference Number 5,- 08 - Subject Text (Return Notification only). If the subject code tag is not provided and the subject text is provided, the subject of the notification will be the subject text. If the subject text is provided, and the subject code tag exists, then the subject code value must be 08. If Subject code is 08, subject text must exist. If a subject code is provided that refers to a nonexistent reference number, the subject will default to the shipment identification number.
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelDelivery.EMail.UndeliverableEMailAddress -- The address where an undeliverable email message is sent if the Label Delivery email is undeliverable. Defaults to FromEMailAddress.
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelDelivery.LabelLinksIndicator -- Indicates the Label and Receipt URLs are to be returned in the XML response.
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelMethod --
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelMethod.Code -- Valid LabelMethod types are:01 = ImportControl Print and Mail02 = ImportControl One-Attempt03 = ImportControl Three-Attempt04 = ImportControl Electronic Label05 = ImportControl Print Label
ShipmentRequest.Shipment.ShipmentServiceOptions.LabelMethod.Description -- LabelMethod description.
ShipmentRequest.Shipment.ShipmentServiceOptions.LiftGateForDeliveryIndicator -- Lift Gate For Delivery indicator. The empty tag means indicator is present. Lift Gate for Delivery is not allowed with Hold For Pickup for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment. When both Hold for Pickup and Drop Off At UPS Facility are selected, neither of the Lift Gate accessorial (Pick Up or Delivery) are allowed for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment. This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment.
ShipmentRequest.Shipment.ShipmentServiceOptions.LiftGateForPickUpIndicator -- Lift Gate For Pick Up indicator. The empty tag means indicator is present. Lift Gate for Pickup is not allowed with Drop Off At UPS Facility for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment. When both Hold for Pickup and Drop Off At Facility are selected, neither of the Lift Gate accessorial (Pick Up or Delivery) are allowed for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment. This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment.
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification --
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].EMail --
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].EMail.EMailAddress -- Email address where the notification is sent. Up to five email addresses are allowed for each type of Quantum View TM shipment notification. Up to two email address for return notification.
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].EMail.FromEMailAddress -- The e-mail address specifies the Reply To E-mail address. The "From" field of the message header contains pkginfo@ups.com. Valid for Return Notification only.
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].EMail.FromName -- The name the email will appear to be from. Defaults to the Shipper Name. The FromName must occur only once for each shipment with Quantum View Shipment Notifications.
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].EMail.Memo -- User defined text that will be included in the eMail. The Memo must occur only once for each shipment with Quantum View Shipment Notifications.
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].EMail.UndeliverableEMailAddress -- The address where an undeliverable eMail message is sent if the eMail with the notification is undeliverable. There can be only one UndeliverableEMailAddress for each shipment with Quantum View Shipment Notifications.
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].Locale --
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].Locale.Dialect -- Refer to Language/Dialect Combinations in the Appendix for valid pairs.
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].Locale.Language -- Refer to Language/Dialect Combinations in the Appendix for valid pairs.
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].NotificationCode -- The type of notification requested.Note: - QVN Exception notification and return notification are not applicable to GFP. - QV In-transit and Return Notifications are only valid for ImportControl and Return shipment. - QV In-transit Notification is allowed for return shipments only.- QV Ship Notification is allowed for forward moving shipments only. Valid values: - 5 - QV In-transit Notification - 6 - QV Ship Notification - 7 - QV Exception Notification - 8 - QV Delivery Notification - 2 - Return Notification or Label Creation Notification - 012 - Alternate Delivery Location Notification- 013 - UAP Shipper Notification.
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].TextMessage --
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].TextMessage.PhoneNumber -- Phone number for receiving Text Alternate Delivery Location notification and UAP Shipper notification.
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].VoiceMessage --
ShipmentRequest.Shipment.ShipmentServiceOptions.Notification.[].VoiceMessage.PhoneNumber -- Phone number for receiving Voice Alternate Delivery Location notification and UAP Shipper notification.
ShipmentRequest.Shipment.ShipmentServiceOptions.PreAlertNotification --
ShipmentRequest.Shipment.ShipmentServiceOptions.PreAlertNotification.[].EMailMessage --
ShipmentRequest.Shipment.ShipmentServiceOptions.PreAlertNotification.[].EMailMessage.EMailAddress -- EMailAddress where PreAlertNotification is sent.
ShipmentRequest.Shipment.ShipmentServiceOptions.PreAlertNotification.[].EMailMessage.UndeliverableEMailAddress -- This is used for notification when EMailAddress for PreAlertNotification is undeliverable.
ShipmentRequest.Shipment.ShipmentServiceOptions.PreAlertNotification.[].Locale --
ShipmentRequest.Shipment.ShipmentServiceOptions.PreAlertNotification.[].Locale.Dialect -- Refer to Language/Dialect Combinations in the Appendix for valid pairs.
ShipmentRequest.Shipment.ShipmentServiceOptions.PreAlertNotification.[].Locale.Language -- Refer to Language/Dialect Combinations in the Appendix for valid pairs.
ShipmentRequest.Shipment.ShipmentServiceOptions.PreAlertNotification.[].TextMessage --
ShipmentRequest.Shipment.ShipmentServiceOptions.PreAlertNotification.[].TextMessage.PhoneNumber -- Phone number for receiving Voice PreAlertNotification. Valid values are 0 – 9.If the country or territory of the message recipient is US, PR, CA, and VI, the layout is:1, area code, 7 digit phone number or 1, area code, 7 digit phone number, 4 digit extension number. For other countries or territories, the layout is country or territory code, area code, 7 digit number.
ShipmentRequest.Shipment.ShipmentServiceOptions.PreAlertNotification.[].VoiceMessage --
ShipmentRequest.Shipment.ShipmentServiceOptions.PreAlertNotification.[].VoiceMessage.PhoneNumber -- Phone number for receiving Voice PreAlertNotification. Valid values are 0 – 9.If the country or territory of the message recipient is US, PR, CA, and VI, the layout is:1, area code, 7 digit phone number or 1, area code, 7 digit phone number, 4 digit extension number. For other countries or territories, the layout is country or territory code, area code, 7 digit number.
ShipmentRequest.Shipment.ShipmentServiceOptions.RestrictedArticles --
ShipmentRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.AlcoholicBeveragesIndicator -- Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Alcoholic Beverages Shippers account needs to have a valid contract for Alcohol.
ShipmentRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.DiagnosticSpecimensIndicator -- This field is a flag to indicate if the package has Biological substances. True if present; false otherwise. Shippers account needs to have a valid contract for Biological Substances. Lane check will happen based on postal code/ city.
ShipmentRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.PerishablesIndicator -- Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Perishable items. Shippers account needs to have a valid contract for Perishables.
ShipmentRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.PlantsIndicator -- Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Plants Shippers account needs to have a valid contract for Plants.
ShipmentRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.SeedsIndicator -- Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Seeds. Shippers account needs to have a valid contract for Seeds.
ShipmentRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.SpecialExceptionsIndicator -- Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Special Exception items. Shippers account needs to have a valid contract for Special Exceptions.
ShipmentRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.TobaccoIndicator -- Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Tobacco Shippers account needs to have a valid contract for Tobacco.
ShipmentRequest.Shipment.ShipmentServiceOptions.ReturnOfDocumentIndicator -- The flag indicates the ReturnOfDocument accessorial has been requested. Valid for Poland to Poland forward shipment only.
ShipmentRequest.Shipment.ShipmentServiceOptions.SDLShipmentIndicator -- The presence of the tag SDLShipmentIndicator indicates Shipment is SDL. SDLShipmentIndicator presence means EEI form/ EEI Filing option required.
ShipmentRequest.Shipment.ShipmentServiceOptions.SaturdayDeliveryIndicator -- Saturday delivery indicator. The presence indicates Saturday delivery is requested and the absence indicates Saturday delivery is not requested. This is an empty tag, any value inside is ignored.
ShipmentRequest.Shipment.ShipmentServiceOptions.SaturdayPickupIndicator -- Saturday pickup indicator. The presence indicates Saturday pickup is requested and the absence indicates Saturday pickup is not requested. This is an empty tag, any value inside is ignored.
ShipmentRequest.Shipment.ShipmentServiceOptions.UPScarbonneutralIndicator -- UPS carbon neutral indicator presence at shipment level is required to create carbon neutral Shipments.
ShipmentRequest.Shipment.ShipmentValueThresholdCode -- Shipment Value Threshold Code. 01 = Shipment value is below or equals to threshold value02 = Shipment value is above threshold value. NA = Not Applicable
ShipmentRequest.Shipment.Shipper --
ShipmentRequest.Shipment.Shipper.Address --
ShipmentRequest.Shipment.Shipper.Address.AddressLine -- The Shipper street address including name and number (when applicable). Up to three occurrences are allowed; only the first is printed on the label.35 characters are accepted, but for the first occurrence, only 30 characters will be printed on the label for return shipments.
ShipmentRequest.Shipment.Shipper.Address.City -- Shipper's City. For forward Shipment 30 characters are accepted, but only 15 characters will be printed on the label.
ShipmentRequest.Shipment.Shipper.Address.CountryCode -- Shipper's country or territory code. Refer to country or territory Codes in the Appendix for valid values.Drop Shipper accounts are valid for return service shipments only if the account is Trade Direct (TD) enabled.
ShipmentRequest.Shipment.Shipper.Address.PostalCode -- Shipper's postal code.
ShipmentRequest.Shipment.Shipper.Address.StateProvinceCode -- Shipper's state or province code. For forward Shipment 5 characters are accepted, but only 2 characters will be printed on the label. For US, PR and CA accounts, the account must be either a daily pickup account, an occasional account, or a customer B.I.N account.
ShipmentRequest.Shipment.Shipper.AttentionName -- Shippers Attention Name. For forward Shipment 35 characters are accepted, but only 30 characters will be printed on the label. Required if destination is international. Required if Invoice and CO International forms are requested and the ShipFrom address is not present.
ShipmentRequest.Shipment.Shipper.CompanyDisplayableName -- Shipper's CompanyDisplayableName.The CompanyDisplayableName will be displayed in tracking results and notification messages in place of the name associated with the shipper account. The original shipper account name will be displayed for all Return Services and Import Control Shipments. This is available for Shipper accounts enabled by UPS and applies to Forward Shipments.
ShipmentRequest.Shipment.Shipper.EMailAddress -- Shipper's email address. Must be associated with the UserId specified in the AccessRequest XML.
ShipmentRequest.Shipment.Shipper.FaxNumber -- Shipper's Fax Number.
ShipmentRequest.Shipment.Shipper.Name -- Shippers company name. For forward Shipment 35 characters are accepted, but only 30 characters will be printed on the label.
ShipmentRequest.Shipment.Shipper.Phone --
ShipmentRequest.Shipment.Shipper.Phone.Extension -- Shipper's phone extension.
ShipmentRequest.Shipment.Shipper.Phone.Number -- Shipper's phone Number. Valid values are 0 - 9. If Shipper country or territory is US, PR, CA, and VI, the layout is: area code, 7 digit PhoneNumber or area code, 7 digit PhoneNumber, 4 digit extension number.For other countries or territories, the layout is: country or territory code, area code, 7 digit number. A phone number is required if destination is international.
ShipmentRequest.Shipment.Shipper.ShipperNumber -- Shipper's six digit alphanumeric account number.Must be associated with the UserId specified in the AccessRequest XML. The account must be a valid UPS account number that is active. For US, PR and CA accounts, the account must be either a daily pickup account, an occasional account, or a customer B.I.N account. Drop Shipper accounts are valid for return service shipments only if the account is Trade Direct (TD) enabled. All other accounts must be either a daily pickup account or an occasional account.
ShipmentRequest.Shipment.Shipper.TaxIdentificationNumber -- Shipper's Tax Identification Number. Conditionally required if EEI form (International forms) is requested and ship From is not mentioned.
ShipmentRequest.Shipment.SubClassification -- A component encoded on the barcode of the Mail Innovations label. Valid values: IR = IrregularMA = MachineableSubClass is only required if the customer's contract have them subclass the package not UPS.
ShipmentRequest.Shipment.TaxInformationIndicator -- Presence/Absence Indicator. Any value inside is ignored. TaxInformationIndicator is an indicator. If present, any taxes that may be applicable to a shipment would be returned in response. If this indicator is requested with NegotiatedRatesIndicator, Tax related information, if applicable, would be returned only for Negotiated Rates and not for Published Rates. The Tax related information includes any type of Taxes, corresponding Monetary Values, Total Charges with Taxes and disclaimers (if applicable) would be returned in response.
ShipmentRequest.Shipment.USPSEndorsement -- USPS Endorsement.Valid values: 1 = Return Service Requested 2 = Forwarding Service Requested 3 = Address Service Requested 4 = Change Service Requested and 5 = No Service Selected. Note: For International Mail Innovations shipments use No Service Selected. International Mail Innovations shipments are applicable for Priority Mail Innovations and Mail Innovations Economy Mail Innovations services only. Required for Mail Innovations forward shipments.
Address Validation
XAVRequest --
XAVRequest.AddressKeyFormat --
XAVRequest.AddressKeyFormat.[].AddressLine -- Address line (street number, street name and street type) used for street level information. Additional secondary information (apartment, suite, floor, etc.). Applicable to US and PR only. Ignored if user selects the RegionalRequestIndicator.
XAVRequest.AddressKeyFormat.[].AttentionName -- Name of the building. Ignored if user selects the RegionalRequestIndicator.
XAVRequest.AddressKeyFormat.[].ConsigneeName -- Name of business, company or person. Ignored if user selects the RegionalRequestIndicator.
XAVRequest.AddressKeyFormat.[].CountryCode -- Country or Territory Code. For a list of valid values, refer to the Address Validation API Supported Countries or Territories table in the Appendix.
XAVRequest.AddressKeyFormat.[].PoliticalDivision1 -- State or Province/Territory name.
XAVRequest.AddressKeyFormat.[].PoliticalDivision2 -- City or Town name.
XAVRequest.AddressKeyFormat.[].PostcodeExtendedLow -- 4 digit Postal Code extension. For US use only.
XAVRequest.AddressKeyFormat.[].PostcodePrimaryLow -- Postal Code.
XAVRequest.AddressKeyFormat.[].Region -- If this node is present the following tags will be ignored: - Political Division 2- Political Division 1- PostcodePrimaryLow- PostcodeExtendedLowValid only for US or PR origins only. Using this tag for non US/PR origins may cause address format errors.
XAVRequest.AddressKeyFormat.[].Urbanization -- Puerto Rico Political Division 3. Only Valid for Puerto Rico.
XAVRequest.MaximumCandidateListSize -- The maximum number of Candidates to return for this request.- Valid values: 0 - 50- Default: 15
XAVRequest.RegionalRequestIndicator -- If this indicator is present then either the region element or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow and the PostcodeExtendedLow fields will be recognized for validation in addition to the urbanization element. If this tag is present, US and PR street level address validation will not occur. The default is to provide street level address validation. Not valid with the address classification request option.
XAVRequest.Request --
XAVRequest.Request.RequestOption -- Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back.Valid values: - 1 - Address Validation- 2 - Address Classification- 3 - Address Validation and Address Classification. For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix.
XAVRequest.Request.SubVersion -- Not Used.
XAVRequest.Request.TransactionReference --
XAVRequest.Request.TransactionReference.CustomerContext -- The CustomerContext Information which will be echoed during response.
Dangerous Goods
path="/dangerousgoods/{version}/acceptanceauditprecheck" top-component=DANGEROUSGOODSUTILITYAPCRequestWrapper
AcceptanceAuditPreCheckRequest --
AcceptanceAuditPreCheckRequest.OriginRecordTransactionTimestamp -- The time that the request was made from the originating system. UTC time down to milliseconds. Example: 2016-07-14T12:01:33.999
AcceptanceAuditPreCheckRequest.Request --
AcceptanceAuditPreCheckRequest.Request.RequestOption -- Enables the user to specify optional processing. Currently, there is no optional process in Dangerous Goods Utility WS.
AcceptanceAuditPreCheckRequest.Request.SubVersion -- Not Used.
AcceptanceAuditPreCheckRequest.Request.TransactionReference --
AcceptanceAuditPreCheckRequest.Request.TransactionReference.CustomerContext -- The CustomerContext information which will be echoed during response.
AcceptanceAuditPreCheckRequest.Shipment --
AcceptanceAuditPreCheckRequest.Shipment.Package --
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord --
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].AdditionalDescription -- Additional remarks or special provision information. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Additional information that may be required by regulation about a hazardous material, such as, “Limited Quantity”, DOT-SP numbers, EX numbers.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].AllPackedInOneIndicator -- Indicates the hazmat shipment/package is all packed in one.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].ChemicalRecordIdentifier -- Identifies the Chemcial Record.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].ClassDivisionNumber -- This is the hazard class associated to the specified commodity.Required if CommodityRegulatedLevelCode is 'LQ' or 'FR'
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].CommodityRegulatedLevelCode -- Indicates the type of commodity. Valid values: LR, FR, LQ, EQFR = Fully RegulatedLQ = Limited QuantityEQ = Excepted QuantityLR = Lightly Regulated
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].HazardLabelRequired -- Defines the type of label that is required on the package for the commodity. Not applicable if CommodityRegulatedLevelCode = LR or EQ.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].IDNumber -- This is the ID number (UN/NA/ID) for the specified commodity. Required if CommodityRegulatedLevelCode = LR, LQ or FR and if the field applies to the material by regulation. UN/NA/ID Identification Number assigned to the specified regulated good. (Include the UN/NA/ID as part of the entry).
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].PackagingGroupType -- This is the packing group category associated to the specified commodity. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Must be shown in Roman Numerals. Valid values are: IIIIII blank
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].PackagingInstructionCode -- The packing instructions related to the chemical record. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].PackagingType -- The package type code identifying the type of packaging used for the commodity. (Ex: Fiberboard Box). Required if CommodityRegulatedLevelCode = LQ or FR.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].PackagingTypeQuantity -- The number of pieces of the specific commodity. Required if CommodityRegulatedLevelCode = LQ or FR. Valid values: 1 to 999
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].ProperShippingName -- The Proper Shipping Name assigned by ADR, CFR or IATA. Required if CommodityRegulatedLevelCode = LR, LQ or FR.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].Quantity -- Required if CommodityRegulatedLevelCode = LQ or FR. The numerical value of the mass capacity of the regulated good.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].ReportableQuantity -- Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. If reportable quantity is met, RQ should be entered.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].SubRiskClass -- Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma).
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].TechnicalName -- The technical name (when required) for the specified commodity. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].TransportCategory -- Transport Category. Valid values: 0 to 4
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].TunnelRestrictionCode -- Defines what is restricted to pass through a tunnel.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].ChemicalRecord.[].UOM -- Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good. Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].EmergencyContact -- The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhone.The information is required if there is a value in the EmergencyPhone field above and the shipment is with a US50 or PR origin and/or destination and the RegulationSet is IATA.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].EmergencyPhone -- 24 Hour Emergency Phone Number of the shipper. Valid values for this field are (0) through (9) with trailing blanks. For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries or territories the layout is country or territory code, area code, number. The Emergency Phone Number can only include the following allowable characters “period “.”, dash “-“, plus sign “+” and conventional parentheses “(“ and “)”, “EXT or OPT”Required when (TDG regulation set and CommodityRegulatedLevelCode = FR)
AcceptanceAuditPreCheckRequest.Shipment.Package.[].OverPackedIndicator -- Presence/Absence Indicator. Any value is ignored. Presence indicates that shipment is over pack.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].PackageIdentifier -- Identifies the package containing Dangerous Goods.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].PackageWeight --
AcceptanceAuditPreCheckRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement --
AcceptanceAuditPreCheckRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement.Code -- Package weight unit of measurement code. Valid values:LBS = PoundsKGS = Kilograms
AcceptanceAuditPreCheckRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement.Description -- Description of the unit of measurement for package weight.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].PackageWeight.Weight -- Packages weight.
AcceptanceAuditPreCheckRequest.Shipment.Package.[].QValue -- This is required when a HazMat shipment specifies AllPackedInOneIndicator and the regulation set for that shipment is IATA. Valid values: 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0
AcceptanceAuditPreCheckRequest.Shipment.Package.[].TransportationMode -- The method of transport by which a shipment is approved to move and the regulations associated with that method. Only required when the CommodityRegulatedLevelCode is FR or LQ. Valid entries include: GND, CAO, and PAX.
AcceptanceAuditPreCheckRequest.Shipment.RegulationSet -- The Regulatory set associated with every regulated shipment. It must be same across the shipment. Not required when the CommodityRegulatedLevelCode is EQ. Valid values: ADR, 49CFR, IATA.ADR = Europe to Europe Ground Movement49CFR = HazMat regulated by US Dept. of Transportation within the U.S. or ground shipments to Canada IATA= Worldwide Air movement.
AcceptanceAuditPreCheckRequest.Shipment.Service --
AcceptanceAuditPreCheckRequest.Shipment.Service.Code -- UPS service type code.
AcceptanceAuditPreCheckRequest.Shipment.Service.Description -- UPS service type description.
AcceptanceAuditPreCheckRequest.Shipment.ShipFromAddress --
AcceptanceAuditPreCheckRequest.Shipment.ShipFromAddress.AddressLine -- The Ship From street address including name and number (when applicable).
AcceptanceAuditPreCheckRequest.Shipment.ShipFromAddress.City -- The Ship From city.
AcceptanceAuditPreCheckRequest.Shipment.ShipFromAddress.CountryCode -- The Ship From locations country or territory code.
AcceptanceAuditPreCheckRequest.Shipment.ShipFromAddress.PostalCode -- The Ship From locations postal code. 9 characters are accepted.
AcceptanceAuditPreCheckRequest.Shipment.ShipFromAddress.StateProvinceCode -- The Ship From locations state or province code.
AcceptanceAuditPreCheckRequest.Shipment.ShipToAddress --
AcceptanceAuditPreCheckRequest.Shipment.ShipToAddress.AddressLine -- The Ship To street address including name and number (when applicable).
AcceptanceAuditPreCheckRequest.Shipment.ShipToAddress.City -- The Ship To city.
AcceptanceAuditPreCheckRequest.Shipment.ShipToAddress.CountryCode -- The Ship To locations country or territory code.
AcceptanceAuditPreCheckRequest.Shipment.ShipToAddress.PostalCode -- The Ship To locations postal code. 9 characters are accepted.
AcceptanceAuditPreCheckRequest.Shipment.ShipToAddress.StateProvinceCode -- The Ship To locations state or province code.
AcceptanceAuditPreCheckRequest.Shipment.ShipperNumber -- Shipper's six digit account number. Your UPS Account Number must have correct Dangerous goods contract to successfully use this Webservice.
path="/dangerousgoods/{version}/chemicalreferencedata" top-component=DANGEROUSGOODSUTILITYRequestWrapper
ChemicalReferenceDataRequest --
ChemicalReferenceDataRequest.IDNumber -- This is the ID number (UN/NA/ID) for the specified commodity. UN/NA/ID Identification Number assigned to the specified regulated good. (Include the UN/NA/ID as part of the entry). At least one of the information - IDNumber or ProperShippingName should be provided to retrieve Chemical Reference Data.
ChemicalReferenceDataRequest.ProperShippingName -- The Proper Shipping Name assigned by ADR, CFR or IATA. At least one of the information - IDNumber or ProperShippingName should be provided to retrieve Chemical Reference Data.
ChemicalReferenceDataRequest.Request --
ChemicalReferenceDataRequest.Request.RequestOption --
ChemicalReferenceDataRequest.Request.SubVersion -- When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility.To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description.Format: YYMM = Year and month of the release.Example: 1801 = 2018 January Supported values: 1801
ChemicalReferenceDataRequest.Request.TransactionReference --
ChemicalReferenceDataRequest.Request.TransactionReference.CustomerContext -- The CustomerContext information which will be echoed during response.
ChemicalReferenceDataRequest.ShipperNumber -- Shipper's six digit account number. Your UPS Account Number must have correct Dangerous goods contract to successfully use this Webservice.
Landed Cost
LandedCostRequest.allowPartialLandedCostResult -- An optional flag to indicate that partial landed cost calculations are acceptable to be used by upstream systems.When set to *false*, the system will return an error when at least one commodity in the shipment is invalid (all or none), and no results will be sent back for that request. When set to *true*, the system will return partial calculations when applicable.Valid values: true = Partial Landed Cost result will return. false = All or No result will return (default).
LandedCostRequest.alversion -- Version number of the instance that processed this request. This must match the major number of the corresponding ICD version.
LandedCostRequest.currencyCode -- Specifies the currency of transaction or purchase.
LandedCostRequest.shipment --
LandedCostRequest.shipment.exportCountryCode -- Specifies the export/ship-from/origin country of the shipment. Please check country List in the Appendix section.**Note:** Export country code must be different from the import country code.
LandedCostRequest.shipment.id -- Specifies the Shipment ID in the Landed Cost quote. It is an arbitrary string provided by the user of the API and will be returned with the Landed Cost Quote to indicate which shipment the tariffs apply to. There are similar IDs associated with the Product and Order objects.
LandedCostRequest.shipment.importCountryCode -- Specifies the Import/Ship-To/Destination/Final country of the shipment. Please check country list in the Appendix.
LandedCostRequest.shipment.importProvince -- Province/State is supported only for a few countries such as Mexico, Canada, etc. Please check Province list in the Appendix
LandedCostRequest.shipment.incoterms -- Supported Incoterm Values:1. CFR - Cost & Freight 2. CIF - Cost, Insurance & Freight 3. CIP - Carriage and Insurance Paid-To 4. CPT - Carriage Paid-To 5. DAP - Delivered At Place 6. DAT - Delivered At Terminal 7. DDP - Delivered Duty Paid 8. DPU - Delivered at Place Unloaded 9. EXW - Ex Works 10. FAS - Free Alongside Ship 11. FCA - Free Carrier 12. FOB - Free On Board (Default)
LandedCostRequest.shipment.shipDate -- Defaults to current date if not provided. Date format: YYYY-MM-DD.
LandedCostRequest.shipment.shipmentItems -- Array of shipment item objects (commodities), that are in a shipment.
LandedCostRequest.shipment.shipmentItems.[].UOM -- Specifies unit of measure. Check UOM List in the Appendices section.
LandedCostRequest.shipment.shipmentItems.[].commodityCurrencyCode -- Specifies the Currency Code used for commodity price. All commodities must have the same currency code.
LandedCostRequest.shipment.shipmentItems.[].commodityId -- Commodity ID is used to associate tariffs with product in the output. Should be unique for each commodity in a request. It is an arbitrary string provided by the user of the API that will be returned with the Landed Cost Quote to indicate which commodity the tariffs apply to.
LandedCostRequest.shipment.shipmentItems.[].description -- This field is populated with description of the commodity. This field is required if hsCode is not provided.
LandedCostRequest.shipment.shipmentItems.[].grossWeight -- Specifies the gross weight of the commodity as any non-negative value.
LandedCostRequest.shipment.shipmentItems.[].grossWeightUnit -- Specifies the units of the gross weight. Required if GrossWeight is used. If GrossWeight is not specified, this value must not be set to anything but null. Supported values: LB, KG
LandedCostRequest.shipment.shipmentItems.[].hsCode -- Specifies a valid HS or HTS code for the shipment's destination or import country. This field is required if description is not provided.
LandedCostRequest.shipment.shipmentItems.[].originCountryCode -- Country of Manufacture or origin.
LandedCostRequest.shipment.shipmentItems.[].priceEach -- Specifies the price for each commodity unit in the settlement currency. The total price of the entire number of shipmentItems may not exceed 999999999999.99
LandedCostRequest.shipment.shipmentItems.[].quantity -- Specifies the number of product units to be shipped. The total price of the entire number of shipmentItems may not exceed 999999999999.99, 1 or greater than 1
LandedCostRequest.shipment.shipmentType -- Specifies the shipment type such as Gift, Document, Commercial (Sale), etc.Supported Shipment Types: 1. GIFT 2. COMMERCIAL 3. SALE 4. SAMPLE 5. REPAIR 6. RETURN 7. OTHER Default value will vary and based on import country.
LandedCostRequest.shipment.transModes -- The modes of transportation (in upper case).Supported Values: 1. INT_AIR 2. INT_OCEAN 3. INT_RAIL 4. INT_TRUCK 5. DOM_AIR 6. DOM_OCEAN 7. DOM_RAIL 8. DOM_TRUCK Default value will vary based on the import country.
LandedCostRequest.shipment.transportCost -- Specifies the Freight charge or transport costs, which are used for tariff calculations. Landed cost result might have some dependency on the freight charges in some countries. Therefore, freight amount should be always provided for accurate Landed Cost result. Allowed values: 1. Any non-negative floating-point number. 2. Numeric value with optional decimal value.
LandedCostRequest.transID -- Unique transaction ID for the request.
Locator
LocatorRequest --
LocatorRequest.AllowAllConfidenceLevels -- Indicator to allow confidence level in search.
LocatorRequest.FreightIndicator -- FreightIndicator. Required for Freight Location Search.
LocatorRequest.LocationID -- Location ID is the identification number of the UPS affiliated location.
LocatorRequest.LocationSearchCriteria --
LocatorRequest.LocationSearchCriteria.AccessPointSearch --
LocatorRequest.LocationSearchCriteria.AccessPointSearch.AccessPointStatus -- Status of UPS Access Point. Valid values are: 01-Active-available07-Active-unavailable.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.AccountNumber -- The account number to use for UPS Access Point Search in the country or territory. Used to locate a private network for the account. Once this parameter is present any access point address or geocode search is ignored. It cannot be combined with PublicAccessPointID search parameter.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.ExactMatchIndicator -- Presence of this tag represents that "AccessPointSearchByAddress" service is requested. The value of this tag is ignored.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.ExcludeFromResult --
LocatorRequest.LocationSearchCriteria.AccessPointSearch.ExcludeFromResult.BusinessClassificationCode -- This contains the business classification code to exclude from UPS Access Point Search by address or geocode. Multiple codes can are possible in separate elements. Please refer to Appendix D for detailed business codes.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.ExcludeFromResult.BusinessName -- This contains the business name to exclude from UPS Access Point Search by address or geocode. Partial names are accepted.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.ExcludeFromResult.PostalCodeList --
LocatorRequest.LocationSearchCriteria.AccessPointSearch.ExcludeFromResult.PostalCodeList.PostalCode --
LocatorRequest.LocationSearchCriteria.AccessPointSearch.ExcludeFromResult.PostalCodeList.PostalCode.[].PrimaryPostalCode -- Primary postal code.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.ExcludeFromResult.PostalCodeList.PostalCode.[].SecondaryPostalCode -- Secondary postal code.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.ExcludeFromResult.Radius -- Public Access points within Radius (in specified Unit of Measure) of any included private access points will be excluded from the results. Valid only if at least one IncludeCriteria/MerchantAccountNumber is provided.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.ExistIndicator -- Presence of this tag represents that "AccessPointAvailability" service is requested. The value of this tag is ignored.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria --
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria.MerchantAccountNumberList --
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria.MerchantAccountNumberList.MerchantAccountNumber -- Account number to be used for a private network access point search where a UPS access point candidate list is obtained in search by address or geocode search.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria.SearchFilter --
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria.SearchFilter.ClickAndCollectSortWithDistance -- This contains the distance (in given UnitOfMeasurement) wherin to sort the click and collect access point locations above other access point locations when a UPS Access Point candidate list is obtained in search by address or geocode search.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria.SearchFilter.DCRIndicator -- DCR/DCO Availability indicator for UPS Access Point. Either this indicator is present or not present. Presence indicates a search for access points with DCR. Any data in the element is ignored.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria.SearchFilter.ShipperPreparationDelay -- Value for the number of days to check for shipping availability from the current day. When this value is present, ShippingAvailabilityIndicator is implied implicitly.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria.SearchFilter.ShippingAvailabilityIndicator -- Shipping Availability indicator for UPS Access Point. Either this indicator is present or not present. Presence indicates a search of access points with shipping availability. Any data in it is ignored.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria.ServiceOfferingList --
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria.ServiceOfferingList.ServiceOffering --
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria.ServiceOfferingList.ServiceOffering.[].Code -- The valid values are: 001-Direct To Retail002-Not In One ADL003-Click and Collect004-Retail to Retail005-Pickup006-Drop Off007-PUDO008-Early Pickup Delivery Time009-Accept prepaid drop offs010-DCO DCR intercept accepted 011-Accepts Payments 012-Pay At Store013-Accepts Restricted Articles
LocatorRequest.LocationSearchCriteria.AccessPointSearch.IncludeCriteria.ServiceOfferingList.ServiceOffering.[].Description -- Description of the service offering. Text will be displayed in the locale requested.
LocatorRequest.LocationSearchCriteria.AccessPointSearch.PublicAccessPointID -- The Public Access Point ID to use for UPS Access Point Search. Once this parameter is present , address or geocode search is ignored. It cannot be combined with AccountNumber search parameter.
LocatorRequest.LocationSearchCriteria.BrexitFilter -- Brexit Filter. Applicable for country code GB; Pass the PostalCode for the address in the location search if Brexit functionality is desired. UAPs with postal code starts with BT returned when brexit filter starts with BT, else UAPs returned with non BT postal code. Applicable for UAP and Proximal building search.
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch --
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.DayOfWeekCode -- Day Of week Code. Valid Values are 1 to 7. 1-Sunday2-Monday 3-Tuesday 4-Wednesday5-Thursday6-Friday7-Saturday.
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.FacilityAddress --
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.FacilityAddress.[].AddressLine -- Address line
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.FacilityAddress.[].City -- City. Required for Freight Will call search if FreightWillCallRequestType is 3.
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.FacilityAddress.[].CountryCode -- Country or territory code.
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.FacilityAddress.[].PostalCodeExtendedLow -- 4 Digit postal code extension. Valid for US only.
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.FacilityAddress.[].PostalCodePrimaryLow -- Postal code. Required for Freight Will call search if FreightWillCallRequestType is 1.
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.FacilityAddress.[].SLIC -- Facility SLIC. Required for Freight Will call search if FreightWillCallRequestType is 2.
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.FacilityAddress.[].State -- State. Required if FrieghtWillCallRequestType is 3 if State is available.
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.FormatPostalCode -- FormatPostalCode would be required in the request when FreightWillCallRequestType is 1. Valid values are:NFR-No format requestedFR-format requestedFS-format and searchNVR-No validation requested.
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.FreightWillCallRequestType -- Valid values are: 1 - Postal Code2 - Delivery SLIC3 - Delivery City/State.1: Freight Will Call Search based on Postal Code, this search is valid for Postal code countries. 2: Freight Will Call Search based on SLIC. 3: Freight Will Call Search based on City and/or State. This Search is valid for non-postal code Countries
LocatorRequest.LocationSearchCriteria.FreightWillCallSearch.OriginOrDestination -- OriginOrDestination is required for FreightWillCallRequestType 1 and type 3 . Valid values:01-Origin facilities02-Destination facilities.
LocatorRequest.LocationSearchCriteria.MaximumListSize -- If present, indicates the maximum number of locations the client wishes to receive in response; ranges from 1 to 50 with a default value of 5.
LocatorRequest.LocationSearchCriteria.OpenTimeCriteria --
LocatorRequest.LocationSearchCriteria.OpenTimeCriteria.DayOfWeekCode -- Day Of week Code.Valid values:1-Sunday2-Monday3-Tuesday4-Wednesday5-Thursday6-Friday7-Saturday
LocatorRequest.LocationSearchCriteria.OpenTimeCriteria.FromTime -- From time. Time Format HHMM.
LocatorRequest.LocationSearchCriteria.OpenTimeCriteria.ToTime -- To Time. Time Format HHMM
LocatorRequest.LocationSearchCriteria.SearchOption --
LocatorRequest.LocationSearchCriteria.SearchOption.[].OptionCode --
LocatorRequest.LocationSearchCriteria.SearchOption.[].OptionCode.[].Code -- These codes vary by country. It is strongly recommended that clients contact UPS to retrieve the primary search indicator and the valid Location Types and Service Level Options for each country or territory. Refer to Location Search Option Codes in the Appendix for additional information.
LocatorRequest.LocationSearchCriteria.SearchOption.[].OptionType --
LocatorRequest.LocationSearchCriteria.SearchOption.[].OptionType.Code -- Code for Option type valid values are:- 01-Location- 02-Retail Location- 03-Additional Services- 04-Program Type - 05-Service Level Option.- 06-End Point Service Offering
LocatorRequest.LocationSearchCriteria.SearchOption.[].Relation --
LocatorRequest.LocationSearchCriteria.SearchOption.[].Relation.Code -- Applicable for Additional Services and Program Types. Valid values: - 01 - And (Default)- 02 - Or
LocatorRequest.LocationSearchCriteria.SearchRadius -- Defines the maximum radius the user wishes to search for a UPS location. If the user does not specify, the default value is 100 miles. Whole numbers only. Valid values are:5-100 for UnitOfMeasure MI5-150 for UnitOfMesaure KM
LocatorRequest.LocationSearchCriteria.ServiceSearch --
LocatorRequest.LocationSearchCriteria.ServiceSearch.ServiceCode --
LocatorRequest.LocationSearchCriteria.ServiceSearch.ServiceCode.[].Code -- Code indicating the different services. Valid values are:01-Ground.02-Air.03-Express04-Standard05-International (Only avialable July 17)
LocatorRequest.LocationSearchCriteria.ServiceSearch.ServiceOptionCode --
LocatorRequest.LocationSearchCriteria.ServiceSearch.ServiceOptionCode.[].Code -- Code that defines the optional service. Valid values:- 01 - Saturday pickup.Only valid for air service.
LocatorRequest.LocationSearchCriteria.ServiceSearch.Time -- Scheduled Local Drop-off Time. Format: HHMM
LocatorRequest.OriginAddress --
LocatorRequest.OriginAddress.AddressKeyFormat --
LocatorRequest.OriginAddress.AddressKeyFormat.AddressLine -- Address Line Information. The user may submit street level address information or provide Intersection information.
LocatorRequest.OriginAddress.AddressKeyFormat.AddressLine2 -- Additional Address Line Information.
LocatorRequest.OriginAddress.AddressKeyFormat.AddressLine3 -- Additional Address Line Information.
LocatorRequest.OriginAddress.AddressKeyFormat.ConsigneeName -- Name. Not relevant for this tool
LocatorRequest.OriginAddress.AddressKeyFormat.CountryCode -- Two-character country or territory abbreviation
LocatorRequest.OriginAddress.AddressKeyFormat.PoliticalDivision1 -- State or province
LocatorRequest.OriginAddress.AddressKeyFormat.PoliticalDivision2 -- City or Town.
LocatorRequest.OriginAddress.AddressKeyFormat.PoliticalDivision3 -- Barrio or other sub-division of City
LocatorRequest.OriginAddress.AddressKeyFormat.PostcodeExtendedLow -- 4 Digit postal code extension. Valid for US only.
LocatorRequest.OriginAddress.AddressKeyFormat.PostcodePrimaryLow -- Main postal code. Required if the user does not submit the City, State/Province address combination.
LocatorRequest.OriginAddress.AddressKeyFormat.SingleLineAddress -- Single line search information. Can contain values of origin address in a single line. Will override other origin address information.Conditionally Required for Non-Postal Code Countries. Applicable Country Ireland (IE)SingleLineAddress used for the lookupSingleLineAddress (Format - CSV) (\"Values:\" + postalCode + city + state + address + landmark + phoneNumber)
LocatorRequest.OriginAddress.Geocode --
LocatorRequest.OriginAddress.Geocode.Latitude -- The latitude of the origin address or the center point of the area code.
LocatorRequest.OriginAddress.Geocode.Longitude -- The longitude of the origin address or the center point of the area code.
LocatorRequest.OriginAddress.MaximumListSize -- If present, indicates the maximum number of locations the client wishes to receive in an address candidate response where the provided origin information is insufficient to accurately establish location. Valid values: 1-50, default 10
LocatorRequest.Request --
LocatorRequest.Request.RequestAction -- Indicates the action to be taken by the XML service. The only valid value is 'Locator'.
LocatorRequest.Request.RequestOption -- Indicates the type of request.Valid values:1-Locations (Drop Locations and Will call locations)8-All available Additional Services16-All available Program Types24-All available Additional Services and Program types32-All available Retail Locations40-All available Retail Locations and Additional Services 48-All available Retail Locations and Program Types 56-All available Retail Locations, Additional Services and Program Types 64-Search for UPS Access Point Locations.
LocatorRequest.Request.TransactionReference --
LocatorRequest.Request.TransactionReference.CustomerContext -- The client uses CustomerContext to synchronize request/response pairs. The client establishes CustomerContext, which can contain any information client want, as long as it is valid XML; it is echoed back by the server
LocatorRequest.SearchOptionCode -- Valid values: 01-Proximity Search Details02-Address Search Details03-Proximity Search Summary04-Address Search Summary05-Freight Will Call Search. Either OptionType 03 or 04 is required.
LocatorRequest.ServiceGeoUnit --
LocatorRequest.ServiceGeoUnit.GeoPoliticalUnit -- GeoPoliticalUnit. Required if ServiceGeoUnit container present.Valid value is '002' .
LocatorRequest.ServiceGeoUnit.ServiceCode -- Service Code. Required if ServiceGeoUnit Container present. Valid value is '096' .
LocatorRequest.SortCriteria --
LocatorRequest.SortCriteria.SortType -- For different sort type. Valid values:01-Closest Location02-Deadline for Drop-off by Air/Express03-Deadline for Drop-off by Ground/Standard04-Latest Close Time05-Earliest Open Time.
LocatorRequest.Translate --
LocatorRequest.Translate.Locale -- Locale is the 5 digit combination of 2 character language code and 2 character country or territory code separated by an underscore ('_') character. Will be used to determine what language the response will be sent in. Default value is: en_US. Examples are: fr_CA, es_MX.
LocatorRequest.UnitOfMeasurement --
LocatorRequest.UnitOfMeasurement.Code -- Valid values are: - MI-Miles- KM-Kilometers
Paperless
path="/paperlessdocuments/{version}/image" top-component=PAPERLESSDOCUMENTRequestWrapper
PushToImageRepositoryRequest --
PushToImageRepositoryRequest.FormsGroupID -- FormsGroupID would be required in Push Request if user needs to update uploaded DocumentID(s) in Forms History.
PushToImageRepositoryRequest.FormsHistoryDocumentID --
PushToImageRepositoryRequest.FormsHistoryDocumentID.DocumentID -- DocumentID represents a document uploaded to Forms History.
PushToImageRepositoryRequest.PRQConfirmationNumber -- PRQ Confirmation being specified by client. Required for freight shipments.
PushToImageRepositoryRequest.Request --
PushToImageRepositoryRequest.Request.RequestOption -- Enables the user to specify optional processing. Currently, there is no optional process in Paperless Document API.
PushToImageRepositoryRequest.Request.SubVersion -- Not Used.
PushToImageRepositoryRequest.Request.TransactionReference --
PushToImageRepositoryRequest.Request.TransactionReference.CustomerContext -- The client uses CustomerContext to synchronize request/response pairs. The client establishes CustomerContext, which can contain any information you want; it is echoed back by the server.
PushToImageRepositoryRequest.ShipmentDateAndTime -- The date and time of the processed shipment. Required only for small package shipments. The valid format is yyyy-MM-dd-HH.mm.ss
PushToImageRepositoryRequest.ShipmentIdentifier -- Shipment Identifier is required for this request.
PushToImageRepositoryRequest.ShipmentType -- Valid values are: 1 = small package, 2 = freight.
PushToImageRepositoryRequest.ShipperNumber -- The Shipper's UPS Account Number. Your UPS Account Number must have 'Upload Forms Created Offline' enabled to use this webservice.
PushToImageRepositoryRequest.TrackingNumber -- UPS Tracking Number associated with this shipment. Required only for small package shipment.
path="/paperlessdocuments/{version}/upload" top-component=PAPERLESSDOCUMENTUploadRequestWrapper
UploadRequest --
UploadRequest.Request --
UploadRequest.Request.RequestOption -- Enables the user to specify optional processing. Currently, there is no optional process in Paperless Document API.
UploadRequest.Request.SubVersion -- Not Used.
UploadRequest.Request.TransactionReference --
UploadRequest.Request.TransactionReference.CustomerContext -- The client uses CustomerContext to synchronize request/response pairs. The client establishes CustomerContext, which can contain any information you want; it is echoed back by the server.
UploadRequest.ShipperNumber -- The Shipper's UPS Account Number. Your UPS Account Number must have 'Upload Forms Created Offline' enabled to use this webservice.
UploadRequest.UserCreatedForm --
UploadRequest.UserCreatedForm.[].UserCreatedFormDocumentType -- The type of documents in UserCreatedForm file. The allowed document types are 001 - Authorization Form, 002 - Commercial Invoice, 003 - Certificate of Origin, 004 - Export Accompanying Document, 005 - Export License, 006 - Import Permit, 007 - One Time NAFTA, 008 - Other Document, 009 - Power of Attorney, 010 - Packing List, 011 - SED Document, 012 - Shipper's Letter of Instruction, 013 - Declaration. The total number of documents allowed per file or per shipment is 13. Each document type needs to be three digits.
UploadRequest.UserCreatedForm.[].UserCreatedFormFile -- The user created form file. The maximum allowable size of each file is restricted to 10 MB. Note: The maximum allowable size of each file is restriced to 1MB in CIE (Customer Integration Environment).
UploadRequest.UserCreatedForm.[].UserCreatedFormFileFormat -- The UserCreatedForm file format. The allowed file formats are bmp, doc, gif, jpg, pdf, png, rtf, tif, txt and xls. The only exceptions for having file format of length 4 character are docx and xlsx. All other file formats needs to be of length 3.
UploadRequest.UserCreatedForm.[].UserCreatedFormFileName -- The name of the file.
Pickup
path="/pickup/{version}/servicecenterlocations" top-component=PICKUPServCenterRequestWrapper
PickupGetServiceCenterFacilitiesRequest --
PickupGetServiceCenterFacilitiesRequest.DestinationAddress --
PickupGetServiceCenterFacilitiesRequest.DestinationAddress.City -- Indicates the address of the consignee to allow for the nearest Pickup facility Search. Required for non-postal country Ireland (IE).
PickupGetServiceCenterFacilitiesRequest.DestinationAddress.CountryCode -- The pickup country or territory code as defined by ISO-3166. Please check check separate pickup country or territory list to find out all the pickup eligible countries.
PickupGetServiceCenterFacilitiesRequest.DestinationAddress.PostalCode -- Indicates the address of the consignee to allow for the nearest Pickup facility Search It does not apply to non-postal countries. Example: IE and HK.
PickupGetServiceCenterFacilitiesRequest.DestinationAddress.StateProvince -- Indicates the address of the consignee to allow for the nearest Pickup facility Search.1 = District code for Hong Kong (HK)2 = County for Ireland (IE)3 = State or province for all the postal countries Required for non-postal countries including HK and IE.
PickupGetServiceCenterFacilitiesRequest.Locale -- Origin Country or Territory Locale. Locale should be Origin Country. Example: en_US. The Last 50 instruction will be send based on this locale. Locale is required if PoximityIndicator is present for Drop Off facilities.
PickupGetServiceCenterFacilitiesRequest.OriginAddress --
PickupGetServiceCenterFacilitiesRequest.OriginAddress.City -- Indicates the address of the shipper to allow for the nearest Drop off facility Search Conditionally required if proximitySearchIndicator is present.
PickupGetServiceCenterFacilitiesRequest.OriginAddress.CountryCode -- Indicates the address of the shipper to allow for the nearest Drop off facility Search
PickupGetServiceCenterFacilitiesRequest.OriginAddress.OriginSearchCriteria --
PickupGetServiceCenterFacilitiesRequest.OriginAddress.OriginSearchCriteria.DistanceUnitOfMeasure -- Unit of Measure Required if ProximitySearchIndicator is present. Example: MI or KM
PickupGetServiceCenterFacilitiesRequest.OriginAddress.OriginSearchCriteria.MaximumLocation -- Maximum Number of locations. Valied values: - 1 to 100Default: 100
PickupGetServiceCenterFacilitiesRequest.OriginAddress.OriginSearchCriteria.SearchRadius -- Search Request range. Valied values: - 1 to 200Default: 200
PickupGetServiceCenterFacilitiesRequest.OriginAddress.PostalCode -- Indicates the address of the shipper to allow for the nearest Drop off facility Search Conditionally required if proximitySearchIndicator is present and if country or territory has postal code.It does not apply to non-postal countries such as IE and HK.
PickupGetServiceCenterFacilitiesRequest.OriginAddress.StateProvince -- Indicates the address of the shipper to allow for the nearest Drop off facility Search. Conditionally required if proximitySearchIndicator is present and if country or territory is US/CA/IE/HK.
PickupGetServiceCenterFacilitiesRequest.OriginAddress.StreetAddress -- Indicates the address of the shipper to allow for the nearest Drop off facility Search. Conditionally required if proximitySearchIndicator is present.
PickupGetServiceCenterFacilitiesRequest.PickupPiece --
PickupGetServiceCenterFacilitiesRequest.ProximitySearchIndicator -- Proximity Indicator. Indicates the user requested the proximity search for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday locations for the origin address and/or the airport code, and the sort code for destination address.
PickupGetServiceCenterFacilitiesRequest.Request --
PickupGetServiceCenterFacilitiesRequest.Request.TransactionReference --
PickupGetServiceCenterFacilitiesRequest.Request.TransactionReference.CustomerContext -- The CustomerContext information that is echoed back during response.
path="/pickupcreation/{version}/pickup" top-component=PICKUPCreationRequestWrapper
PickupCreationRequest --
PickupCreationRequest.AlternateAddressIndicator -- Indicates if pickup address is a different address than that specified in a customer's profile. Valid values:Y = Alternate addressN = Original pickup address (default)
PickupCreationRequest.CashType -- Describes the type of cash funds that the driver will collect.Applicable to the following countries:BE,FR,DE,IT,MX,NL,PL,ES,GBValid values: 01 - Pickup only (default)02 - Transportation only03 - Pickup and Transportation
PickupCreationRequest.FreightOptions --
PickupCreationRequest.FreightOptions.DestinationAddress --
PickupCreationRequest.FreightOptions.DestinationAddress.City -- The city of pickup address if available. It is required for non-postal country Ireland (IE).
PickupCreationRequest.FreightOptions.DestinationAddress.CountryCode -- The pickup country or territory code as defined by ISO-3166. Refer to Country or Territory Codes in the Appendix for valid values. Upper-case two-letter string.
PickupCreationRequest.FreightOptions.DestinationAddress.PostalCode -- Postal Code for postal countries. It does not apply to non-postal countries such as IE and HK
PickupCreationRequest.FreightOptions.DestinationAddress.StateProvince -- 1. It means district code for Hong Kong (HK)2. It means county for Ireland (IE)3. It means state or province for all the postal countries It is required for non-postal countries including HK and IE.
PickupCreationRequest.FreightOptions.OriginServiceCenterCode -- Origin SLIC. This will be obtained from submitting a pickup service center request. See PickupGetFacilitiesServiceCenterRequest.
PickupCreationRequest.FreightOptions.OriginServiceCountryCode -- Country or territory of Service Center SLIC chosen to drop off.
PickupCreationRequest.FreightOptions.ShipmentDetail --
PickupCreationRequest.FreightOptions.ShipmentDetail.HazmatIndicator -- Indicates hazardous materials
PickupCreationRequest.FreightOptions.ShipmentDetail.PalletInformation --
PickupCreationRequest.FreightOptions.ShipmentDetail.PalletInformation.Dimensions --
PickupCreationRequest.FreightOptions.ShipmentDetail.PalletInformation.Dimensions.Height -- Dimension height of pallet.
PickupCreationRequest.FreightOptions.ShipmentDetail.PalletInformation.Dimensions.Length -- Dimension length of pallet.
PickupCreationRequest.FreightOptions.ShipmentDetail.PalletInformation.Dimensions.UnitOfMeasurement --
PickupCreationRequest.FreightOptions.ShipmentDetail.PalletInformation.Dimensions.UnitOfMeasurement.Code -- - IN = Inches- CM = Centimeters
PickupCreationRequest.FreightOptions.ShipmentDetail.PalletInformation.Dimensions.UnitOfMeasurement.Description -- See Code above.
PickupCreationRequest.FreightOptions.ShipmentDetail.PalletInformation.Dimensions.Width -- Dimension width of pallet.
PickupCreationRequest.FreightOptions.ShipmentServiceOptions --
PickupCreationRequest.FreightOptions.ShipmentServiceOptions.DropoffAtUPSFacilityIndicator -- Identifies service center location information for Origin List of UPS Facilities.
PickupCreationRequest.FreightOptions.ShipmentServiceOptions.HoldForPickupIndicator -- Identifies service center location information for Destination of UPS Facilities.
PickupCreationRequest.FreightOptions.ShipmentServiceOptions.OriginLiftGateIndicator -- Presence indicates OriginLiftGateRequiredIndicator is present. Conditionally requirements. Must not be present if DropOffAtUPSFacilityIndicator is true
PickupCreationRequest.OverweightIndicator -- Indicates if at least any package is over 70 lbs or 32 kgs. Valid values: Y = Over weight N = Not over weight (default) Not required for WWEF service.
PickupCreationRequest.PaymentMethod -- The payment method to pay for this on call pickup.00 = No payment needed01 = Pay by shipper account03 = Pay by charge card04 = Pay by 1Z tracking number05 = Pay by check or money order06 = Cash(applicable only for these countries - BE,FR,DE,IT,MX,NL,PL,ES,GB,CZ,HU,FI,NO)07=Pay by PayPalRefer to Appendix # for valid payment methods for CZ, HU, FI and NO For countries and (or) zip codes where pickup is free of charge, please submit 00, means no payment needed as payment method. - If 01 is the payment method, then ShipperAccountNumber and ShipperAccount CountryCode must be provided.- If 03 is selected, then CreditCard information should be provided.- If 04 is selected, then the shipper agreed to pay for the pickup packages.- If 05 is selected, then the shipper will pay for the pickup packages with a check or money order.
PickupCreationRequest.PickupAddress --
PickupCreationRequest.PickupAddress.AddressLine -- Detailed street address. For Jan. 2010 release, only one AddressLine is allowed
PickupCreationRequest.PickupAddress.City -- City or equivalent
PickupCreationRequest.PickupAddress.CompanyName -- Company name
PickupCreationRequest.PickupAddress.ContactName -- Name of contact person
PickupCreationRequest.PickupAddress.CountryCode -- The pickup country or territory code as defined by ISO-3166. Refer to Country or Territory Codes in the Appendix for valid values.
PickupCreationRequest.PickupAddress.Floor -- Floor number
PickupCreationRequest.PickupAddress.Phone --
PickupCreationRequest.PickupAddress.Phone.Extension -- Phone extension
PickupCreationRequest.PickupAddress.Phone.Number -- Phone number
PickupCreationRequest.PickupAddress.PickupPoint -- The specific spot to pickup at the address.
PickupCreationRequest.PickupAddress.PostalCode -- Postal code or equivalent for postal countries
PickupCreationRequest.PickupAddress.ResidentialIndicator -- Indicates if the pickup address is commercial or residential. Valid values:Y = Residential addressN = Non-residential (Commercial) address (default)
PickupCreationRequest.PickupAddress.Room -- Room number
PickupCreationRequest.PickupAddress.StateProvince -- State or province for postal countries; county for Ireland (IE) and district code for Hong Kong (HK)
PickupCreationRequest.PickupAddress.Urbanization -- - Barrio for Mexico (MX)- Urbanization for Puerto Rico (PR)- Shire for United Kingdom (UK)
PickupCreationRequest.PickupDateInfo --
PickupCreationRequest.PickupDateInfo.CloseTime -- Pickup location's local close time.- User provided Close Time must be later than the Earliest Allowed Customer Close Time. - Earliest Allowed Customer Close Time is defined by UPS pickup operation system. - CloseTime minus ReadyTime must be greater than the LeadTime. - LeadTime is determined by UPS pickup operation system. LeadTime is the minimum amount of time UPS requires between customer's request for a pickup and driver arriving at the location for the pickup. Format: HHmm- Hour: 0-23- Minute: 0-59
PickupCreationRequest.PickupDateInfo.PickupDate -- Local pickup date of the location. Format: yyyyMMdd- yyyy = Year Appliable- MM = 01–12- dd = 01–31
PickupCreationRequest.PickupDateInfo.ReadyTime -- Pickup location's local ready time. ReadyTime means the time when your shipment(s) can be ready for UPS to pick up. - User provided ReadyTime must be earlier than CallByTime. - CallByTime is determined by UPS pickup operation system. CallByTime is the Latest time a Customer can call UPS or self-serve on UPS.com and complete a Pickup Request and UPS can still make the Pickup service request. - If ReadyTime is earlier than current local time, UPS uses the current local time as the ReadyTime. Format: HHmmHour: 0-23Minute: 0-59
PickupCreationRequest.PickupPiece --
PickupCreationRequest.PickupPiece.[].ContainerCode -- Container type. Valid values:- 01 = PACKAGE- 02 = UPS LETTER- 03 = PALLETNote: 03 is used for only WWEF services
PickupCreationRequest.PickupPiece.[].DestinationCountryCode -- The destination country code as defined by ISO-3166.Refer to Country or Territory Codes in the Appendix for valid values.
PickupCreationRequest.PickupPiece.[].Quantity -- Number of pieces to be picked up. Max per service: 999
PickupCreationRequest.PickupPiece.[].ServiceCode -- Refer to Service Codes in the Appendix for valid values.
PickupCreationRequest.RateChartType -- Rate Type with which pickup is rated. Possible RateChart values for different regions will be: US 48 origin: - 1 – Daily Rates - 3 – Standard List Rates - 4 – Retail Rates. Alaska/Hawaii origin:- 1 – Daily Rates - 3 – Standard List Rates - 4 – Retail Rates. All Other origins:- 1 – Rates - 5 - Regional Rates - 6 - General List Rates. 3 and 4 do not apply
PickupCreationRequest.RatePickupIndicator -- Indicates whether to rate the on-callpickup or not. Valid values:Y = Rate this pickupN = Do not rate this pickup (default)
PickupCreationRequest.ReferenceNumber -- Information entered by a customer for Privileged reference
PickupCreationRequest.Request --
PickupCreationRequest.Request.SubVersion -- When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility.To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description. Supported values: 1607, 1707,2007Example: Itemized Charges are returned only when the Subversion element is present and greater than or equal to '1601'. Format: YYMM = Year and month of the release.Example: 1601 = 2016 January
PickupCreationRequest.Request.TransactionReference --
PickupCreationRequest.Request.TransactionReference.CustomerContext -- The CustomerContext information that is echoed back during response.
PickupCreationRequest.ServiceCategory -- Service Category.Applicable to the following countries:BE, FR, DE, IT, MX, NL, PL, ES, GB Valid values: 01 - domestic (default)02 - international03 - transborder
PickupCreationRequest.Shipper --
PickupCreationRequest.Shipper.Account --
PickupCreationRequest.Shipper.Account.AccountCountryCode -- Country or territory code as defined by ISO-3166.Refer to Country or Terriotry Codes in the Appendix for valid values.
PickupCreationRequest.Shipper.Account.AccountNumber -- UPS account number. Shipper's (requester of the pickup) UPS account number
PickupCreationRequest.Shipper.ChargeCard --
PickupCreationRequest.Shipper.ChargeCard.CardAddress --
PickupCreationRequest.Shipper.ChargeCard.CardAddress.AddressLine -- Address Lines of the credit card billing address. Max of three address lines can be provided.
PickupCreationRequest.Shipper.ChargeCard.CardAddress.City -- Charge card billing city
PickupCreationRequest.Shipper.ChargeCard.CardAddress.CountryCode -- Charge card billing address country or territory code defined by ISO-3166.Upper-case two letter string. For Discover card it should be US.
PickupCreationRequest.Shipper.ChargeCard.CardAddress.PostalCode -- Charge card billing address postal code. This is a required field for postal countries.
PickupCreationRequest.Shipper.ChargeCard.CardAddress.StateProvince -- Charge card billing State province code
PickupCreationRequest.Shipper.ChargeCard.CardHolderName -- Charge card holder name. If the name is not provided, defaults to "No Name Provided".
PickupCreationRequest.Shipper.ChargeCard.CardNumber -- Charge card number. For Privileged clients, this element must be tokenized card number.
PickupCreationRequest.Shipper.ChargeCard.CardType -- Charge card type. Valid values:- 01 = American Express- 03 = Discover- 04 = Mastercard- 06 = VISA Discover card Pickup country US only.
PickupCreationRequest.Shipper.ChargeCard.ExpirationDate -- Credit card expiration date.Format: yyyyMMyyyy = 4 digit year, valid value current year - 10 years.MM = 2 digit month, valid values 01-12
PickupCreationRequest.Shipper.ChargeCard.SecurityCode -- Three or four digits that can be found either on top of credit card number or on the back of credit card. Number of digits varies for different type of credit card. Valid values are 3 or 4 digits.Security code is required if credit card information is provided.
PickupCreationRequest.ShippingLabelsAvailable -- This element should be set to "Y" in the request to indicate that user has pre-printed shipping labels for all the packages, otherwise this will be treated as false.
PickupCreationRequest.SpecialInstruction -- Special handling instruction from the customer
PickupCreationRequest.TaxInformationIndicator -- Indicates whether to return detailed taxes for the on-callpickups. Valid values:Y = Rate this pickup with taxesN = Do not rate this pickup with taxes (default)
PickupCreationRequest.TotalWeight --
PickupCreationRequest.TotalWeight.UnitOfMeasurement -- The code representing the unit of measurement associated with the package.LBS = PoundsKGS = Kilograms
PickupCreationRequest.TotalWeight.Weight -- The weight of the package. One decimal digit is allowed. Example: 10.9
PickupCreationRequest.TrackingData --
PickupCreationRequest.TrackingData.[].TrackingNumber -- Tracking number for return shipment or forward shipment packages. Tracking number(s) that have been previously used to pay for on-call pickup cannot be used again.
PickupCreationRequest.TrackingDataWithReferenceNumber --
PickupCreationRequest.TrackingDataWithReferenceNumber.ReferenceNumber -- The reference number associated with the tracking number.
PickupCreationRequest.TrackingDataWithReferenceNumber.TrackingNumber -- Tracking number for shipment packages.
PickupCreationRequest.UserLevelDiscountIndicator -- Indicates whether to return user level promo discount for the on-callpickups. Valid values:Y = Rate this pickup with user level promo discountN = Do not rate this pickup with user level promo discount(default)
path="/shipments/{version}/pickup/{pickuptype}" top-component=PICKUPRequestWrapper
PickupRateRequest --
PickupRateRequest.AlternateAddressIndicator -- Indicates if the pickup address is different than the address specified in the customer's profile. Valid values:Y = Alternate addressN = Original pickup address (default)
PickupRateRequest.PickupAddress --
PickupRateRequest.PickupAddress.AddressLine -- Detailed street address. For Jan. 2010 release, only one AddressLine is allowed.
PickupRateRequest.PickupAddress.City -- City or equivalent
PickupRateRequest.PickupAddress.CountryCode -- Upper-case two-char long country code as defined by ISO-3166. Refer to Country or Territory Codes in the Appendix for valid values.
PickupRateRequest.PickupAddress.PostalCode -- Postal code for countries with postal codes.
PickupRateRequest.PickupAddress.ResidentialIndicator -- Indicates if the pickup address is commerical or residential.Valid values:Y = Residential addressN = Non-residential (Commercial) address (default)
PickupRateRequest.PickupAddress.StateProvince -- State province code or equivalent
PickupRateRequest.PickupDateInfo --
PickupRateRequest.PickupDateInfo.CloseTime -- The latest local close time. Format: HHmm- Hour: 0-23- Minute: 0-59
PickupRateRequest.PickupDateInfo.PickupDate -- The specific local pickup date. Format: yyyyMMdd- yyyy = Year Applicable- MM = 01-12- dd = 01-31
PickupRateRequest.PickupDateInfo.ReadyTime -- The earliest local ready Time. Format: HHmm- Hour: 0-23- Minute: 0-59
PickupRateRequest.RateChartType -- Rate Type with which pickup is rated. Possible RateChart values for different regions will be: US 48 origin: 1 – Daily Rates 3 – Standard List Rates 4 – Retail Rates. Alaska/Hawaii origin:1 – Daily Rates 3 – Standard List Rates 4 – Retail Rates. All Other origins:1 – Rates 5 - Regional Rates 6 - General List Rates. 3 and 4 do not apply
PickupRateRequest.Request --
PickupRateRequest.Request.RequestOption -- Not used by pick up
PickupRateRequest.Request.SubVersion -- When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility.To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description. Supported values: 1607, 1707,2007Example: Itemized Charges are returned only when the Subversion element is present and greater than or equal to '1601'. Format: YYMM = Year and month of the release.Example: 1601 = 2016 January
PickupRateRequest.Request.TransactionReference --
PickupRateRequest.Request.TransactionReference.CustomerContext -- The CustomerContext information that is echoed back during response.
PickupRateRequest.ServiceDateOption -- Indicates the pickup timeframe.- 01 = Same-Day Pickup- 02 = Future-Day Pickup- 03 = A Specific-Day Pickup If 03 is selected, then PickupDate, EarliestReadyTime, and LatestClosetime must be specified.
PickupRateRequest.ShipperAccount --
PickupRateRequest.ShipperAccount.AccountCountryCode -- Country code as defined by ISO-3166.Refer to Country or Territory Codes in the Appendix for valid values.
PickupRateRequest.ShipperAccount.AccountNumber -- UPS account number. Shipper's (requester of the pickup) UPS account number
PickupRateRequest.TaxInformationIndicator -- Indicates whether to return detailed taxes for on-callpickups.Valid values:- Y = Rate this pickup with taxes- N = Do not rate this pickup with taxes (default)
PickupRateRequest.UserLevelDiscountIndicator -- Indicates whether to return user level promo discount for the on-callpickups. Valid values:Y = Rate this pickup with user level promo discountN = Do not rate this pickup with user level promo discount(default)
PreNotification
PreNotificationRequest --
PreNotificationRequest.Request --
PreNotificationRequest.Request.TransactionReference --
PreNotificationRequest.Request.TransactionReference.CustomerContext -- The CustomerContext information which will be echoed during response.
PreNotificationRequest.Shipment --
PreNotificationRequest.Shipment.Package --
PreNotificationRequest.Shipment.Package.[].ChemicalRecord --
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].AdditionalDescription -- Additional remarks or special provision information.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].AllPackedInOneIndicator -- Presence/Absence Indicator. Any value is ignored. Presence indicates if multiple, different hazmat/chemicals are contained within one box in a package
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].ClassDivisionNumber -- This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'LQ' or 'FR'
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].CommodityRegulatedLevelCode -- Indicates the type of commodity, Fully Regulated (FR), Limited Quantity (LQ), Lightly Regulated (LR) Valid values are LR, FR and LQ.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].EmergencyContact -- The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhoneNumber.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].EmergencyPhone -- 24 Hour Emergency Phone Number of the shipper. Valid values for this field are (0) through (9) with trailing blanks. For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries the layout is country code, area code, number. The following are restricted in the phone number period ".", dash "-", plus sign "+" and conventional parentheses "(" and ")", "EXT" or "OPT" The following are restricted in the phone number period ".", dash "-", plus sign "+" and conventional parentheses "(" and ")", "EXT" or "OPT"
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].HazardLabelRequired -- Defines the type of label that is required on the package for the commodity.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].IDNumber -- This is the ID number (UN/NA/ID) for the specified commodity. UN/NA/ID Identification Number assigned to the specified regulated good. (Include the UN/NA/ID as part of the entry).
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].OverPackedIndicator -- Presence/Absence Indicator. Any value is ignored. Presence indicates that shipment is overpack.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].PackagingGroupType -- This is the packing group category associated to the specified commodity. Must be shown in Roman Numerals. Valid values are: - I- II- III- blank
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].PackagingInstructionCode -- The packing instructions related to the chemical record.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].PackagingType -- The type of package used to contain the regulated good. (Ex: Fiberboard Box).
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].PackagingTypeQuantity -- The number of pieces of the specific commodity. Required if CommodityRegulatedLevelCode = LQ or FR. Valid values are 1 to 999.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].ProperShippingName -- The Proper Shipping Name assigned by ADR, CFR or IATA. Required if CommodityRegulatedLevelCode = LQ or FR.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].QValue -- When a HazMat shipment specifies AllPackedInOneIndicator and the regulation set for that shipment is IATA, Q-Value specifies exactly one of the following values: 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0 Valid values are : 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].Quantity -- Required if CommodityRegulatedLevelCode = LQ or FR. The numerical value of the mass capacity of the regulated good.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].ReportableQuantity -- Indicates whether or not a material being transported meets the definition of a hazardous material and meets or exceeds a reportable quantity threshold. If reportable quantity is met, "RQ" should be entered. Any other value will be interpreted as "Non Reportable" quantity.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].SubRiskClass -- Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma.)
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].TechnicalName -- The technical name (when required) for the specified commodity.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].TransportCategory -- Transport Category. Valid values are 0 to 4.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].TunnelRestrictionCode -- Defines what is restricted to pass through a tunnel.
PreNotificationRequest.Shipment.Package.[].ChemicalRecord.[].UOM -- Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good.
PreNotificationRequest.Shipment.Package.[].PackagePoints -- Regulated Commodity Transport Package Score Quantity
PreNotificationRequest.Shipment.Package.[].PackageWeight --
PreNotificationRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement --
PreNotificationRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement.Code -- Package weight unit of measurement code. Codes are: LBS = PoundsKGS = Kilograms
PreNotificationRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement.Description -- Description of the unit of measurement for package weight.
PreNotificationRequest.Shipment.Package.[].PackageWeight.Weight -- Packages weight.
PreNotificationRequest.Shipment.Package.[].TrackingNumber -- The packages tracking number.
PreNotificationRequest.Shipment.Package.[].TransportationMode -- Declares that a package was prepared according to ground, passenger aircraft, or cargo aircraft only. Only required when the CommodityRegulatedLevelCode is FR or LQ. Valid entries include: GND, CAO, PAX.
PreNotificationRequest.Shipment.Package.[].VoidIndicator -- Indicator to specify that a Dangerous Goods package is voided. True if VoidIndicator tag exists; false otherwise.
PreNotificationRequest.Shipment.PickupDate -- Date of the On Call Air Pickup. Format is YYYYMMDD
PreNotificationRequest.Shipment.RegulationSet -- The Regulatory set associated with every regulated shipment. It must be same across the shipment. Valid values are:- ADR – European Agreement concerning the International Carriage of Dangerous Goods by Road. - 49CFR – Title 49 of the United States Code of Federal Regulations. - IATA – International Air Transport Association (IATA) Dangerous Goods Regulations.
PreNotificationRequest.Shipment.Service --
PreNotificationRequest.Shipment.Service.Code -- UPS service type code.
PreNotificationRequest.Shipment.Service.Description -- Description of the service code. Examples are Next Day Air, Worldwide Express, and Ground.
PreNotificationRequest.Shipment.ShipFromAddress --
PreNotificationRequest.Shipment.ShipFromAddress.AddressLine -- The Ship From street address including name and number (when applicable).
PreNotificationRequest.Shipment.ShipFromAddress.City -- The Ship From city.
PreNotificationRequest.Shipment.ShipFromAddress.CountryCode -- The Ship From location's country or territory code.
PreNotificationRequest.Shipment.ShipFromAddress.PostalCode -- The Ship From location's postal code. 9 characters are accepted.
PreNotificationRequest.Shipment.ShipFromAddress.StateProvinceCode -- The Ship From location's state or province code.
PreNotificationRequest.Shipment.ShipToAddress --
PreNotificationRequest.Shipment.ShipToAddress.AddressLine -- The Ship To street address including name and number (when applicable).
PreNotificationRequest.Shipment.ShipToAddress.City -- The Ship To city.
PreNotificationRequest.Shipment.ShipToAddress.CountryCode -- The Ship To location's country or territory code.
PreNotificationRequest.Shipment.ShipToAddress.PostalCode -- The Ship To location's postal code. 9 characters are accepted.
PreNotificationRequest.Shipment.ShipToAddress.StateProvinceCode -- The Ship To location's state or province code.
PreNotificationRequest.Shipment.ShipmentIdentificationNumber -- 1Z Number of the first package in the shipment.
PreNotificationRequest.Shipment.ShipperNumber -- Shipper's six digit account number.
Quantum View
QuantumViewRequest --
QuantumViewRequest.Bookmark -- Bookmarks the file for next retrieval. It is a base64Encoded String. It contains the combination of SubscriberID + SubscriptionName + File Name if the request is for all data. It contains SubscriberID if the request is for unread data. When a response comes back with a bookmark it indicates that there is more data. To fetch the remaining data, the requester should come back with the bookmark added to the original request.
QuantumViewRequest.Request --
QuantumViewRequest.Request.RequestAction -- Indicates the action to be taken by the XML service. The only valid value is 'QVEvents'
QuantumViewRequest.Request.TransactionReference --
QuantumViewRequest.Request.TransactionReference.CustomerContext -- The CustomerContext Information which will be echoed during response.
QuantumViewRequest.SubscriptionRequest --
QuantumViewRequest.SubscriptionRequest.[].DateTimeRange --
QuantumViewRequest.SubscriptionRequest.[].DateTimeRange.BeginDateTime -- Beginning date time for the retrieval criteria of the subscriptions. It is required for date time request criteria. Format: YYYYMMDDHHmmss.
QuantumViewRequest.SubscriptionRequest.[].DateTimeRange.EndDateTime -- Ending date time for the retrieval criteria of the subscriptions. Format: YYYYMMDDHHmmss. When a null or empty EndDateTime is passed in the request, it is defaulted to 7 days from the given begin date.
QuantumViewRequest.SubscriptionRequest.[].FileName -- File name of specific subscription requested by user. Format: YYMMDD_HHmmssnnn. (nnn - sequence number: usually = 001)
QuantumViewRequest.SubscriptionRequest.[].Name -- Name of subscription requested by user, as one type of request criteria. Required when the customer wants to request data for a specific subscription name. Subscription name consists of up to 21 alphanumerics.
Rating
RateRequest --
RateRequest.CustomerClassification --
RateRequest.CustomerClassification.Code -- Customer classification code. Valid values:00 - Rates Associated with Shipper Number01 - Daily Rates04 - Retail Rates05 - Regional Rates06 - General List Rates53 - Standard List RatesLength is not validated.If customer classification code is not a valid value please refer to Rate Types Table on page 11.
RateRequest.CustomerClassification.Description -- Customer classification description of the code above. Ignored if provided in the Request. Length is not validated.
RateRequest.PickupType --
RateRequest.PickupType.Code -- Pickup Type Code. Valid values: 01 - Daily Pickup (Default - used when an invalid pickup type code is provided)03 - Customer Counter06 - One Time Pickup19 - Letter Center20 - Air Service CenterLength is not validated. When negotiated rates are requested, 07 (onCallAir) will be ignored.Refer to the Rate Types Table in the Appendix for rate type based on Pickup Type and Customer Classification Code.
RateRequest.PickupType.Description -- Pickup Type Description. Ignored if provided in the Request.
RateRequest.Request --
RateRequest.Request.RequestOption -- Used to define the request type. Valid Values:- Rate = The server rates (The default Request option is Rate if a Request Option is not provided).- Shop = The server validates the shipment, and returns rates for all UPS products from the ShipFrom to the ShipTo addresses. - Ratetimeintransit = The server rates with transit time information- Shoptimeintransit = The server validates the shipment, and returns rates and transit times for all UPS products from the ShipFrom to the ShipTo addresses. Rate is the only valid request option for UPS Ground Freight Pricing requests.
RateRequest.Request.SubVersion -- Indicates Rate API to display the new release features in Rate API response based on Rate release. See the What's New section for the latest Rate release. Supported values: 1601, 1607, 1701, 1707, 2108, 2205
RateRequest.Request.TransactionReference --
RateRequest.Request.TransactionReference.CustomerContext -- May be used to synchronize request/response pairs. Information in the request element is echoed back in the response.
RateRequest.Shipment --
RateRequest.Shipment.AlternateDeliveryAddress --
RateRequest.Shipment.AlternateDeliveryAddress.Address --
RateRequest.Shipment.AlternateDeliveryAddress.Address.AddressLine -- The UPS Access Point's street address, including name and number (when applicable). Length is not validated.
RateRequest.Shipment.AlternateDeliveryAddress.Address.City -- UPS Access Point city.
RateRequest.Shipment.AlternateDeliveryAddress.Address.CountryCode -- UPS Access Point country or territory code.
RateRequest.Shipment.AlternateDeliveryAddress.Address.POBoxIndicator -- Presence/Absence Indicator. Any value inside is ignored.This field is a flag to indicate if the Alternate Delivery location is a PO box location. True if POBoxIndicator tag exists; false otherwise. Not valid with Shipment Indication Types:- 01 - Hold for Pickup at UPS Access Point- 02 - UPS Access Point™ Delivery
RateRequest.Shipment.AlternateDeliveryAddress.Address.PostalCode -- UPS Access Point Postal code.
RateRequest.Shipment.AlternateDeliveryAddress.Address.ResidentialAddressIndicator -- Presence/Absence Indicator. Any value inside is ignored.This field is a flag to indicate if the Alternate Delivery location is a residential location. True if ResidentialAddressIndicator tag exists. For future use.
RateRequest.Shipment.AlternateDeliveryAddress.Address.StateProvinceCode -- UPS Access Point State or Province code.
RateRequest.Shipment.AlternateDeliveryAddress.Name -- UPS Access Point location name.
RateRequest.Shipment.DeliveryTimeInformation --
RateRequest.Shipment.DeliveryTimeInformation.PackageBillType -- Valid values are:- 02 - Document only - 03 - Non-Document- 04 - WWEF Pallet- 07 - Domestic PalletIf 04 is included, Worldwide Express Freight and UPS Worldwide Express Freight Midday services (if applicable) will be included in the response.
RateRequest.Shipment.DeliveryTimeInformation.Pickup --
RateRequest.Shipment.DeliveryTimeInformation.Pickup.Date -- Shipment Date; The Pickup date is a Shipment Date and it is a required input field. The user is allowed to query up to 35 days into the past and 60 days into the future. Format: YYYYMMDD If a date is not provided, it will be defaulted to the current system date.
RateRequest.Shipment.DeliveryTimeInformation.Pickup.Time -- Reflects the time the package is tendered to UPS for shipping (can be dropped off at UPS or picked up by UPS). Military Time Format HHMMSS or HHMM. Invalid pickup time will not be validated.
RateRequest.Shipment.DeliveryTimeInformation.ReturnContractServices --
RateRequest.Shipment.DeliveryTimeInformation.ReturnContractServices.[].Code -- Return contract Service code. Valid Code "01" - Heavy Goods. If 01 will return Heavy Goods service transit times for a given origin and destination (if applicable) Invalid Code will be ignore.
RateRequest.Shipment.DeliveryTimeInformation.ReturnContractServices.[].Description -- Return contract service Description
RateRequest.Shipment.DocumentsOnlyIndicator -- Valid values are Document and Non-document. If the indicator is present then the value is Document else Non-Document. Note: Not applicable for FRS rating requests. Empty Tag.
RateRequest.Shipment.FRSPaymentInformation --
RateRequest.Shipment.FRSPaymentInformation.AccountNumber -- UPS Account Number.
RateRequest.Shipment.FRSPaymentInformation.Address --
RateRequest.Shipment.FRSPaymentInformation.Address.CountryCode -- Country or Territory code for the UPS accounts & billing address. Country or Territory Code is required when the FRS Payment Information type = 02 and type= 03.
RateRequest.Shipment.FRSPaymentInformation.Address.PostalCode -- Postal Code for UPS accounts billing address. Postal Code may be present when the FRS Payment Information type = 02 and type = 03.
RateRequest.Shipment.FRSPaymentInformation.Type --
RateRequest.Shipment.FRSPaymentInformation.Type.Code -- Payer Type code for FRS Rate request. Valid Values are: 01 = Prepaid 02 = FreightCollect 03 = BillThirdParty
RateRequest.Shipment.FRSPaymentInformation.Type.Description -- Text description of the code representing the GFP payment type.
RateRequest.Shipment.FreightShipmentInformation --
RateRequest.Shipment.FreightShipmentInformation.DensityEligibleIndicator -- The presence of the tag indicates that the rate request is density based.For Density Based Rating (DBR), the customer must have DBR Contract Service.
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo --
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeight --
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeight.UnitOfMeasurement --
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeight.UnitOfMeasurement.Code -- Code associated with Unit of Measurement for the Adjusted height. Valid value is IN Unit of measurement code for Adjusted height is validated only when Handling unit type is SKD = Skid or PLT = Pallet.
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeight.UnitOfMeasurement.Description -- Description for Code associated with Unit of Measurement for the Adjusted height.
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeight.Value -- Adjusted Height value for the handling unit.
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.AdjustedHeightIndicator -- The presence of the AdjustedHeightIndicator allows UPS to do height reduction adjustment for density based rate request.
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits --
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions --
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.Height -- The height of the line item used to determine dimensional weight.
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.Length -- The length of the line item used to determine dimensional weight.
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.UnitOfMeasurement --
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.UnitOfMeasurement.Code -- Code for UnitOfMeasurement for the line item dimension. Valid value - IN = Inches
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.UnitOfMeasurement.Description -- Description for UnitOfMeasurement for the line item dimension.
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Dimensions.Width -- The width of the line item used to determine dimensional weight.
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Quantity -- Handling Unit Quantity for Density based rating.
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Type --
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Type.Code -- The code associated with Handling Unit Type. Valid values: SKD = Skid CBY = CarboyPLT = PalletTOT = TotesLOO = LooseOTH = Other
RateRequest.Shipment.FreightShipmentInformation.FreightDensityInfo.HandlingUnits.[].Type.Description -- A description of the code for the Handling Unit type.
RateRequest.Shipment.GoodsNotInFreeCirculationIndicator -- Goods Not In Free Circulation indicator. This is an empty tag, any value inside is ignored. This indicator is invalid for a package type of UPS Letter and DocumentsOnly.
RateRequest.Shipment.InvoiceLineTotal --
RateRequest.Shipment.InvoiceLineTotal.CurrencyCode -- Invoice Line Total Currency type. The Currency code should match the origin country's or territory's currency code, otherwise the currency code entered will be ignored. Note: UPS doesn't support all international currency codes. Please check the developer guides for Supported Currency codes.
RateRequest.Shipment.InvoiceLineTotal.MonetaryValue -- Total amount of the invoice accompanying the shipment. Required when the InvoiceLineTotal container exists in the rate request. Valid values are from 1 to 99999999.
RateRequest.Shipment.MasterCartonIndicator -- Presence/Absence Indicator. Any value inside is ignored. MasterCartonIndicator is an indicator and presence implies that shipment is Master Carton type. If present, the shipment will be rated as a Master Carton Type. If this indicator is requested with NegotiatedRatesIndicator, rates would be returned only for Negotiated Rates and not for Published Rates.
RateRequest.Shipment.NumOfPieces -- Total number of pieces in all pallets. Required for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipments.
RateRequest.Shipment.OriginRecordTransactionTimestamp -- The time that the request was made from the originating system. UTC time down to milliseconds. Example - 2016-07-14T12:01:33.999 Applicable only for HazMat request and with subversion greater than or equal to 1701.
RateRequest.Shipment.Package --
RateRequest.Shipment.Package.[].AdditionalHandlingIndicator -- A flag indicating if the packages require additional handling. True if AdditionalHandlingIndicator tag exists; false otherwise. Additional Handling indicator indicates it's a non-corrugated package. Empty Tag.
RateRequest.Shipment.Package.[].Commodity --
RateRequest.Shipment.Package.[].Commodity.FreightClass -- Freight Classification. Freight class partially determines the freight rate for the article. See Appendix of the Rating Ground Freight Web Services Developers Guide for list of Freight classes. For GFP Only.
RateRequest.Shipment.Package.[].Commodity.NMFC --
RateRequest.Shipment.Package.[].Commodity.NMFC.PrimeCode -- Value of NMFC Prime. Contact your service representative if you need information concerning NMFC Codes. Required if NMFC Container is present. For GFP Only.
RateRequest.Shipment.Package.[].Commodity.NMFC.SubCode -- Value of NMFC Sub. Contact your service representative if you need information concerning NMFC Codes. Needs to be provided when the SubCode associated with the PrimeCode is other than 00. API defaults the sub value to 00 if not provided. If provided the Sub Code should be associated with the PrimeCode of the NMFC.
RateRequest.Shipment.Package.[].DimWeight --
RateRequest.Shipment.Package.[].DimWeight.UnitOfMeasurement --
RateRequest.Shipment.Package.[].DimWeight.UnitOfMeasurement.Code -- Code representing the unit of measure associated with the package weight. Valid values: - LBS - Pounds- KGS - Kilograms.
RateRequest.Shipment.Package.[].DimWeight.UnitOfMeasurement.Description -- Text description of the code representing the unit of measure associated with the package weight. Length and value are not validated.
RateRequest.Shipment.Package.[].DimWeight.Weight -- Dimensional weight of the package. Decimal values are not accepted, however there is one implied decimal place for values in this field (i.e. 115 = 11.5).
RateRequest.Shipment.Package.[].Dimensions --
RateRequest.Shipment.Package.[].Dimensions.Height -- Height of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.6 digits in length with 2 digits of significance after the decimal point.
RateRequest.Shipment.Package.[].Dimensions.Length -- Length of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.6 digits in length with 2 digits of significance after the decimal point.
RateRequest.Shipment.Package.[].Dimensions.UnitOfMeasurement --
RateRequest.Shipment.Package.[].Dimensions.UnitOfMeasurement.Code -- Package dimensions unit of measurement code.Valid values:- IN- CM
RateRequest.Shipment.Package.[].Dimensions.UnitOfMeasurement.Description -- Text description of the code representing the UnitOfMeasurement associated with the package. This element is not validated.
RateRequest.Shipment.Package.[].Dimensions.Width -- Width of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.6 digits in length with 2 digits of significance after the decimal point.
RateRequest.Shipment.Package.[].LargePackageIndicator -- This element does not require a value and if one is entered it will be ignored. If present, it indicates the shipment will be categorized as a Large Package.
RateRequest.Shipment.Package.[].MinimumBillableWeightIndicator -- Presence/Absence Indicator. Any value inside is ignored. It indicates if packge is qualified for minimum billable weight. Applicable for UPS Worldwide Economy DDU service
RateRequest.Shipment.Package.[].OversizeIndicator -- Presence/Absence Indicator. Any value inside is ignored. It indicates if packge is oversized. Applicable for UPS Worldwide Economy DDU service
RateRequest.Shipment.Package.[].PackageServiceOptions --
RateRequest.Shipment.Package.[].PackageServiceOptions.AccessPointCOD --
RateRequest.Shipment.Package.[].PackageServiceOptions.AccessPointCOD.CurrencyCode -- Access Point COD Currency Code. Required if Access Point COD container is present. UPS does not support all international currency codes. Refer to the appendix for a list of valid codes.
RateRequest.Shipment.Package.[].PackageServiceOptions.AccessPointCOD.MonetaryValue -- Access Point COD Monetary Value. Required if Access Point COD container is present. 8 digits prior to the decimal place and 2 after.
RateRequest.Shipment.Package.[].PackageServiceOptions.COD --
RateRequest.Shipment.Package.[].PackageServiceOptions.COD.CODAmount --
RateRequest.Shipment.Package.[].PackageServiceOptions.COD.CODAmount.CurrencyCode -- Currency Code. Required if a value for the COD amount exists in the MonetaryValue tag. Must match one of the IATA currency codes. UPS does not support all international currency codes. Refer to Currency Codes in the Appendix for a list of valid codes.
RateRequest.Shipment.Package.[].PackageServiceOptions.COD.CODAmount.MonetaryValue -- The COD value for the package. Required if COD option is present. The maximum amount allowed is 50,000 USD.
RateRequest.Shipment.Package.[].PackageServiceOptions.COD.CODFundsCode -- Indicates the type of funds that will be used for the C.O.D. payment. For valid values, refer to Rating and Shipping COD Supported Countries or Territories in the Appendix.
RateRequest.Shipment.Package.[].PackageServiceOptions.DeclaredValue --
RateRequest.Shipment.Package.[].PackageServiceOptions.DeclaredValue.CurrencyCode -- The IATA currency code associated with the declared value amount for the package. Required if a value for the package declared value amount exists in the MonetaryValue tag. Must match one of the IATA currency codes. Length is not validated. UPS does not support all international currency codes. Refer to Currency Codes in the Appendix for a list of valid codes.
RateRequest.Shipment.Package.[].PackageServiceOptions.DeclaredValue.MonetaryValue -- The monetary value for the declared value amount associated with the package. Max value of 5,000 USD for Local and 50,000 USD for Remote. Absolute maximum value is 21474836.47
RateRequest.Shipment.Package.[].PackageServiceOptions.DeliveryConfirmation --
RateRequest.Shipment.Package.[].PackageServiceOptions.DeliveryConfirmation.DCISType -- Type of delivery confirmation. Valid values: 1 - Unsupported 2 - Delivery Confirmation Signature Required 3 - Delivery Confirmation Adult Signature Required
RateRequest.Shipment.Package.[].PackageServiceOptions.DryIce --
RateRequest.Shipment.Package.[].PackageServiceOptions.DryIce.AuditRequired -- Presence/Absence Indicator. Any value inside is ignored. Indicates a Dry Ice audit will be performed per the Regulation Set requirements. Empty tag means indicator is present.
RateRequest.Shipment.Package.[].PackageServiceOptions.DryIce.DryIceWeight --
RateRequest.Shipment.Package.[].PackageServiceOptions.DryIce.DryIceWeight.UnitOfMeasurement --
RateRequest.Shipment.Package.[].PackageServiceOptions.DryIce.DryIceWeight.UnitOfMeasurement.Code -- DryIce weight unit of measurement code. Valid values:- 00 - KG (Metric Unit of Measurements) or KGS- 01 - LB (English Unit of Measurements) or LBS
RateRequest.Shipment.Package.[].PackageServiceOptions.DryIce.DryIceWeight.UnitOfMeasurement.Description -- Text description of the code representing the unit of measure associated with the package.
RateRequest.Shipment.Package.[].PackageServiceOptions.DryIce.DryIceWeight.Weight -- Weight for Dry Ice. Cannot be more than package weight. Should be more than 0.0. Valid characters are 0-9 and "." (Decimal point). Limit to 1 digit after the decimal. The maximum length of the field is 5 including "." and can hold up to 1 decimal place.
RateRequest.Shipment.Package.[].PackageServiceOptions.DryIce.MedicalUseIndicator -- Presence/Absence Indicator. Any value inside is ignored. Relevant only in CFR regulation set. If present it is used to designate the Dry Ice is for any medical use and rates are adjusted for DryIce weight more than 2.5 KGS or 5.5 LBS.
RateRequest.Shipment.Package.[].PackageServiceOptions.DryIce.RegulationSet -- Regulation set for DryIce Shipment. Valid values: CFR = For HazMat regulated by US Dept of Transportation within the U.S. or ground shipments to Canada,IATA = For Worldwide Air movement. The following values are valid: CFR and IATA.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat --
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.AllPackedInOneIndicator -- Presence/Absence Indicator. Any value is ignored. Indicates the hazmat shipment/package is all packed in one. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord --
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].AdditionalDescription -- Additional remarks or special provision information. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Additional information that may be required by regulation about a hazardous material, such as, "Limited Quantity", DOT-SP numbers, EX numbers. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].ChemicalRecordIdentifier -- Identifies the Chemcial Record. Required if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].ClassDivisionNumber -- This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'LQ' or 'FR' Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].CommodityRegulatedLevelCode -- Indicates the type of commodity - Fully Regulated (FR), Limited Quantity (LQ), Excepted Quantity (EQ), Lightly Regulated (LR). Default value is FR.Valid values are LR, FR, LQ, EQ. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].EmergencyContact -- The emergency information, contact name and/or contact number, required to be communicated when a call is placed to the EmergencyPhoneNumber. The information is required if there is a value in the EmergencyPhoneNumber field above and the shipment is with a US50 or PR origin and/or destination and the RegulationSet is IATA. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].EmergencyPhone -- 24 Hour Emergency Phone Number of the shipper. Valid values for this field are (0) through (9) with trailing blanks. For numbers within the U.S., the layout is '1', area code, 7-digit number. For all other countries or territories the layout is country or territory code, area code, number. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].HazardLabelRequired -- Defines the type of label that is required on the package for the commodity. Not applicable if CommodityRegulatedLevelCode = LR or EQ. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].IDNumber -- This is the ID number (UN/NA/ID) for the specified commodity. Required if CommodityRegulatedLevelCode = LR, LQ or FR and if the field applies to the material by regulation. UN/NA/ID Identification Number assigned to the specified regulated good. (Include the UN/NA/ID as part of the entry). Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].PackagingGroupType -- This is the packing group category associated to the specified commodity. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Must be shown in Roman Numerals.Valid values are:I, II,III,blank. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].PackagingInstructionCode -- The packing instructions related to the chemical record. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].PackagingType -- The package type code identifying the type of packaging used for the commodity. (Ex: Fiberboard Box). Required if CommodityRegulatedLevelCode = LQ or FR. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].PackagingTypeQuantity -- The number of pieces of the specific commodity. Required if CommodityRegulatedLevelCode = LQ or FR.Valid values are 1 to 999. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].ProperShippingName -- The Proper Shipping Name assigned by ADR, CFR or IATA. Required if CommodityRegulatedLevelCode = LR, LQ or FR. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].Quantity -- Required if CommodityRegulatedLevelCode = LQ or FR. The numerical value of the mass capacity of the regulated good. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].RegulationSet -- The Regulatory set associated with every regulated shipment. It must be the same across the shipment. Valid values: ADR - For Europe to Europe Ground Movement CFR - For HazMat regulated by US Dept. of Transportation within the U.S. or ground shipments to Canada, IATA - For Worldwide Air movement TDG - For Canada to Canada ground movement or Canada to U.S. standard movement Applies only if SubVersion is greater than or equal to 1701. For multiple ChemicalRecords per package or multiple packages containing different RegulationSet, RegulationSet of first ChemicalRecord would be considered for validating and rating the entire shipment.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].ReportableQuantity -- Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. If reportable quantity is met, 'RQ' should be entered. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].SubRiskClass -- Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma). Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].TechnicalName -- The technical name (when required) for the specified commodity. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].TransportCategory -- Transport Category.Valid values are 0 to 4. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].TransportationMode -- The method of transport by which a shipment is approved to move and the regulations associated with that method. Only required when the CommodityRegulatedLevelCode is FR or LQ.Valid values: 01 - Highway02 - Ground03 - Passenger Aircraft04 - Cargo Aircraft Only Applies only if SubVersion is greater than or equal to 1701. For multiple ChemicalRecords per package having different TransportationMode, TransportationMode of first ChemicalRecord would be considered for validating and rating the package. All TransportationMode except for '04' are general service offering. If any chemical record contains '04' as TransportationMode, ShipperNumber needs to be authorized to use '04' as TransportationMode.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].TunnelRestrictionCode -- Defines what is restricted to pass through a tunnel. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.HazMatChemicalRecord.[].UOM -- Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good. For Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.OverPackedIndicator -- Presence/Absence Indicator. Any value is ignored. Presence indicates that shipment is overpack. Applies only if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.PackageIdentifier -- Identifies the package containing Dangerous Goods. Required if SubVersion is greater than or equal to 1701.
RateRequest.Shipment.Package.[].PackageServiceOptions.HazMat.QValue -- QValue is required when a HazMat shipment specifies AllPackedInOneIndicator and the regulation set for that shipment is IATA. Applies only if SubVersion is greater than or equal to 1701. Valid values are : 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0
RateRequest.Shipment.Package.[].PackageServiceOptions.Insurance --
RateRequest.Shipment.Package.[].PackageServiceOptions.Insurance.BasicFlexibleParcelIndicator --
RateRequest.Shipment.Package.[].PackageServiceOptions.Insurance.BasicFlexibleParcelIndicator.CurrencyCode -- The IATA currency code associated with the amount for the package. UPS does not support all international currency codes. Refer to the appendix for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.Package.[].PackageServiceOptions.Insurance.BasicFlexibleParcelIndicator.MonetaryValue -- The monetary value associated with the package. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.Package.[].PackageServiceOptions.Insurance.ExtendedFlexibleParcelIndicator --
RateRequest.Shipment.Package.[].PackageServiceOptions.Insurance.ExtendedFlexibleParcelIndicator.CurrencyCode -- The IATA currency code associated with the amount for the package. UPS does not support all international currency codes. Refer to the appendix for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.Package.[].PackageServiceOptions.Insurance.ExtendedFlexibleParcelIndicator.MonetaryValue -- The monetary value associated with the package. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.Package.[].PackageServiceOptions.Insurance.TimeInTransitFlexibleParcelIndicator --
RateRequest.Shipment.Package.[].PackageServiceOptions.Insurance.TimeInTransitFlexibleParcelIndicator.CurrencyCode -- The IATA currency code associated with the amount for the package. UPS does not support all international currency codes. Refer to the appendix for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.Package.[].PackageServiceOptions.Insurance.TimeInTransitFlexibleParcelIndicator.MonetaryValue -- The monetary value associated with the package. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.Package.[].PackageServiceOptions.ProactiveIndicator -- Any value associated with this element will be ignored. If present, the package is rated for UPS Proactive Response and proactive package tracking.Contractual accessorial for health care companies to allow package monitoring throughout the UPS system. Shippers account needs to have valid contract for UPS Proactive Response.
RateRequest.Shipment.Package.[].PackageServiceOptions.RefrigerationIndicator -- Presence/Absence Indicator. Any value is ignored. If present, indicates that the package contains an item that needs refrigeration. Shippers account needs to have a valid contract for Refrigeration.
RateRequest.Shipment.Package.[].PackageServiceOptions.ShipperDeclaredValue --
RateRequest.Shipment.Package.[].PackageServiceOptions.ShipperDeclaredValue.CurrencyCode -- The IATA currency code associated with the amount for the package. UPS does not support all international currency codes. Refer to the appendix for a list of valid codes.
RateRequest.Shipment.Package.[].PackageServiceOptions.ShipperDeclaredValue.MonetaryValue -- The monetary value for the amount associated with the package.
RateRequest.Shipment.Package.[].PackageServiceOptions.ShipperReleaseIndicator -- The presence indicates that the package may be released by driver without a signature from the consignee. Empty Tag. Only available for US50/PR to US50/PR packages without return service.
RateRequest.Shipment.Package.[].PackageServiceOptions.UPSPremiumCareIndicator -- The UPSPremiumCareIndicator indicates special handling is required for shipment having controlled substances. Empty Tag means indicator is present. Valid only for Canada to Canada movements.Available for the following Return Services:- Returns Exchange (available with a contract)- Print Return Label- Print and Mail- Electronic Return Label- Return Service Three AttemptMay be requested with following UPS services: - UPS Express® Early- UPS Express- UPS Express Saver- UPS Standard. Not available for packages with the following:- Delivery Confirmation - Signature Required- Delivery Confirmation - Adult Signature Required.
RateRequest.Shipment.Package.[].PackageWeight --
RateRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement --
RateRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement.Code -- Code representing the unit of measure associated with the package weight.Unit of Measurement "OZS" is the only valid UOM for Worldwide Economy DDU Shipments. Valid values: - LBS - Pounds (default)- KGS - Kilograms- OZS - Ounces
RateRequest.Shipment.Package.[].PackageWeight.UnitOfMeasurement.Description -- Text description of the code representing the unit of measure associated with the package weight. Length and value are not validated.
RateRequest.Shipment.Package.[].PackageWeight.Weight -- Actual package weight. Weight accepted for letters/envelopes.
RateRequest.Shipment.Package.[].PackagingType --
RateRequest.Shipment.Package.[].PackagingType.Code -- The code for the UPS packaging type associated with the package. Valid values: - 00 - UNKNOWN - 01 - UPS Letter - 02 - Package - 03 - Tube - 04 - Pak - 21 - Express Box - 24 - 25KG Box - 25 - 10KG Box - 30 - Pallet - 2a - Small Express Box - 2b - Medium Express Box - 2c - Large Express Box. For FRS rating requests the only valid value is customer supplied packaging “02”.
RateRequest.Shipment.Package.[].PackagingType.Description -- A text description of the code for the UPS packaging type associated with the shipment. Length is not validated.
RateRequest.Shipment.Package.[].SimpleRate --
RateRequest.Shipment.Package.[].SimpleRate.Code -- Simple Rate Package Size Valid values: XS - Extra Small S - Small M - Medium L - Large XL - Extra Large
RateRequest.Shipment.Package.[].SimpleRate.Description -- Simple Rate Package Size Description
RateRequest.Shipment.Package.[].UPSPremier --
RateRequest.Shipment.Package.[].UPSPremier.Category -- UPS Premier Category Valid values are 01,02,03 UPS Premier Silver - 01 UPS Premier Gold - 02 UPS Premier Platinum - 03
RateRequest.Shipment.PaymentDetails --
RateRequest.Shipment.PaymentDetails.ShipmentCharge --
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillReceiver --
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillReceiver.AccountNumber -- The UPS account number. The account must be a valid UPS account number that is active. For US, PR and CA accounts, the account must be a daily pickup account, an occasional account, a customer B.I.N account, or a dropper shipper account. All other accounts must be either a daily pickup account, an occasional account, a drop shipper account, or a non-shipping account.
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillReceiver.Address --
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillReceiver.Address.PostalCode -- The postal code for the UPS account's pickup address. The pickup postal code was entered in the UPS system when the account was set-up.
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillShipper --
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillShipper.AccountNumber -- UPS account number Must be the same UPS account number as the one provided in Shipper/ShipperNumber.
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillThirdParty --
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillThirdParty.AccountNumber -- The UPS account number of the third party shipper. The account must be a valid UPS account number that is active. For US, PR and CA accounts, the account must be either a daily pickup account, an occasional account, or a customer B.I.N account, or a drop shipper account. All other accounts must be either a daily pickup account, an occasional account, a drop shipper account, or a non-shipping account.
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillThirdParty.Address --
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillThirdParty.Address.AddressLine -- The origin street address including name and number (when applicable).
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillThirdParty.Address.City -- Origin city.
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillThirdParty.Address.CountryCode -- Origin country or territory code. Refer to the Supported Country or Territory Tables located in the Appendix.
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillThirdParty.Address.PostalCode -- Origin postal code. The postal code must be the same as the UPS account pickup address postal code. Required for United States and Canadian UPS accounts and/or if the UPS account pickup address has a postal code. If the UPS account's pickup country or territory is US or Puerto Rico, the postal code is 5 or 9 digits. The character '-' may be used to separate the first five digits and the last four digits. If the UPS account's pickup country or territory is CA, the postal code is 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit.
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].BillThirdParty.Address.StateProvinceCode -- Origin state code.
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].ConsigneeBilledIndicator -- Consignee Billing payment option indicator. The presence indicates consignee billing option is selected. The absence indicates one of the other payment options is selected. Empty Tag. This element or its sibling element, BillShipper, BillReceiver or BillThirdParty, must be present but no more than one can be present. This billing option is valid for a shipment charge type of Transportation only. Only applies to US/PR and PR/US shipment origins and destination.
RateRequest.Shipment.PaymentDetails.ShipmentCharge.[].Type -- Values are 01 = Transportation, 02 = Duties and Taxes
RateRequest.Shipment.PaymentDetails.SplitDutyVATIndicator -- Split Duty VAT Indicator. The presence indicates the payer specified for Transportation Charges will pay transportation charges and any duties that apply to the shipment. The payer specified for Duties and Taxes will pay the VAT (Value-Added Tax) only. Empty Tag. The payment method for Transportation charges must be UPS account. The UPS account must be a daily pickup account or an occasional account.
RateRequest.Shipment.PromotionalDiscountInformation --
RateRequest.Shipment.PromotionalDiscountInformation.PromoAliasCode -- Promotion Alias code Required if PromotionalDiscountInformation container is present.
RateRequest.Shipment.PromotionalDiscountInformation.PromoCode -- Promotion Code. A discount that is applied to the user. Required if PromotionalDiscountInformation container is present.
RateRequest.Shipment.RatingMethodRequestedIndicator -- Presence/Absence Indicator. Any value inside is ignored. RatingMethodRequestedIndicator is an indicator. If present, Billable Weight Calculation method and Rating Method information would be returned in response.
RateRequest.Shipment.Service --
RateRequest.Shipment.Service.Code -- The code for the UPS Service associated with the shipment. NOTE: For a complete listing of values, refer to Service Codes in the AppendixValid domestic values: - 01 = Next Day Air - 02 = 2nd Day Air - 03 = Ground - 12 = 3 Day Select - 13 = Next Day Air Saver - 14 = UPS Next Day Air Early - 59 = 2nd Day Air A.M. - 75 = UPS Heavy GoodsValid international values: - 07 = Worldwide Express - 08 = Worldwide Expedited - 11= Standard - 54 = Worldwide Express Plus - 65 = Saver - 96 = UPS Worldwide Express Freight- 71 = UPS Worldwide Express Freight Midday Required for Rating and ignored for Shopping.
RateRequest.Shipment.Service.Description -- A text description of the UPS Service associated with the shipment. Length is not validated.
RateRequest.Shipment.ShipFrom --
RateRequest.Shipment.ShipFrom.Address --
RateRequest.Shipment.ShipFrom.Address.AddressLine -- The origin street address including name and number (when applicable). Length is not validated.
RateRequest.Shipment.ShipFrom.Address.City -- Origin city. Required if country or territory does not utilize postal codes. Length is not validated.
RateRequest.Shipment.ShipFrom.Address.CountryCode -- Origin country or territory code. Refer to the Supported Country or Territory Tables located in the Appendix. Required, but defaults to US.
RateRequest.Shipment.ShipFrom.Address.PostalCode -- Origin postal code. Required if country or territory utilizes postal codes (e.g. US and PR).
RateRequest.Shipment.ShipFrom.Address.StateProvinceCode -- Origin state code. A StateProvinceCode and valid account number are required when requesting negotiated rates. Otherwise the StateProvinceCode is optional.If the TaxInformationIndicator flag is present in the request, a StateProvinceCode must be entered for tax charges to be accurately calculated in the response.
RateRequest.Shipment.ShipFrom.AttentionName -- Origin attention name. Length is not validated.
RateRequest.Shipment.ShipFrom.Name -- Origin attention name or company name. Length is not validated.
RateRequest.Shipment.ShipTo --
RateRequest.Shipment.ShipTo.Address --
RateRequest.Shipment.ShipTo.Address.AddressLine -- Destination street address including name and number (when applicable). Max Occurrence can be 3. Length is not validated.
RateRequest.Shipment.ShipTo.Address.City -- Destination city. Required if country or territory does not utilize postal codes. Length is not validated.
RateRequest.Shipment.ShipTo.Address.CountryCode -- Destination country or territory code. Refer to the Supported Country or Territory Tables located in the Appendix.
RateRequest.Shipment.ShipTo.Address.PostalCode -- Destination postal code. Required if country or territory utilizes postal codes (i.e. US and PR).
RateRequest.Shipment.ShipTo.Address.ResidentialAddressIndicator -- Residential Address flag. This field is a flag to indicate if the destination is a residential location. True if ResidentialAddressIndicator tag exists; false otherwise. This element does not require a value and if one is entered it will be ignored.Note: When requesting TimeInTransit information, this indicator must be passed to determine if Three Day Select or Ground shipment is eligible for Saturday Delivery at no charge. If this indicator is not present, address will be considered as commercial. Empty Tag.
RateRequest.Shipment.ShipTo.Address.StateProvinceCode -- Destination state code.
RateRequest.Shipment.ShipTo.AttentionName -- Destination attention name. Length is not validated.
RateRequest.Shipment.ShipTo.Name -- Destination attention name or company name. Length is not validated.
RateRequest.Shipment.ShipmentIndicationType --
RateRequest.Shipment.ShipmentIndicationType.[].Code -- Code for Shipment Indication Type.Valid values: - 01 - Hold for Pickup at UPS Access Point - 02 - UPS Access Point™ Delivery
RateRequest.Shipment.ShipmentIndicationType.[].Description -- Description for Shipment Indication Type. Length is not Validated.
RateRequest.Shipment.ShipmentRatingOptions --
RateRequest.Shipment.ShipmentRatingOptions.FRSShipmentIndicator -- FRS Indicator. The indicator is required to obtain rates for UPS Ground Freight Pricing (GFP). The account number must be enabled for GFP.
RateRequest.Shipment.ShipmentRatingOptions.NegotiatedRatesIndicator -- NegotiatedRatesIndicator - Required to display two types of discounts: 1) Bids or Account Based Rates2) Web/Promotional Discounts BidsAccount Based Rates: If the indicator is present, the Shipper is authorized, and the Rating API XML Request is configured to return Negotiated Rates, then Negotiated Rates should be returned in the response. Web/Promotional Discounts: If the indicator is present, the Shipper is authorized for Web/Promotional Discounts then Negotiated Rates should be returned in the response.
RateRequest.Shipment.ShipmentRatingOptions.RateChartIndicator -- RateChartIndicator - If present in a request, the response will contain a RateChart element.
RateRequest.Shipment.ShipmentRatingOptions.TPFCNegotiatedRatesIndicator -- This indicator applies for a third party (3P) / Freight collect (FC) shipment only. For 3P/FC shipment if the shipper wishes to request for the negotiated rates of the third party then this indicator should be included in the request. If authorized the 3P/FC negotiated rates will be applied to the shipment and rates will be returned in response.
RateRequest.Shipment.ShipmentRatingOptions.UserLevelDiscountIndicator -- UserLevelDiscountIndicator - required to obtain rates for User Level Promotions. This is required to obtain User Level Discounts. There must also be no ShipperNumber in the Shipper container.
RateRequest.Shipment.ShipmentServiceOptions --
RateRequest.Shipment.ShipmentServiceOptions.AccessPointCOD --
RateRequest.Shipment.ShipmentServiceOptions.AccessPointCOD.CurrencyCode -- Access Point COD Currency Code. Required if Access Point COD container is present. UPS does not support all international currency codes. Refer to the appendix for a list of valid codes.
RateRequest.Shipment.ShipmentServiceOptions.AccessPointCOD.MonetaryValue -- Access Point COD Monetary Value. Required if Access Point COD container is present. 8 digits prior to the decimal place and 2 after.
RateRequest.Shipment.ShipmentServiceOptions.AvailableServicesOption -- If we need diferent available services in response, this option is used for shop request option. SaturdayDeliveryIndicator/ SundayDeliveryIndicator will be ignored in that case. Valid Values:1- Weekday+Saturday services2- Weekday+Sunday services3- Weekday+Sat services+Sun services
RateRequest.Shipment.ShipmentServiceOptions.COD --
RateRequest.Shipment.ShipmentServiceOptions.COD.CODAmount --
RateRequest.Shipment.ShipmentServiceOptions.COD.CODAmount.CurrencyCode -- COD amount currency code type.
RateRequest.Shipment.ShipmentServiceOptions.COD.CODAmount.MonetaryValue -- COD Amount.
RateRequest.Shipment.ShipmentServiceOptions.COD.CODFundsCode -- For valid values, refer to Rating and Shipping COD Supported Countries or Territories in the Appendix.
RateRequest.Shipment.ShipmentServiceOptions.CertificateOfOriginIndicator -- The empty tag in request indicates that customer would be using UPS prepared SED form. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.ShipmentServiceOptions.CommercialInvoiceRemovalIndicator -- Presence/Absence Indicator. Any value inside is ignored. CommercialInvoiceRemovalIndicator - empty tag means indicator is present. CommercialInvoiceRemovalIndicator allows a shipper to dictate that UPS remove the Commercial Invoice from the user's shipment before the shipment is delivered to the ultimate consignee.
RateRequest.Shipment.ShipmentServiceOptions.DeliverToAddresseeOnlyIndicator -- Presence/Absence Indicator. Any value inside is ignored. DeliverToAddresseeOnlyIndicator is shipper specified restriction that requires the addressee to be the one who takes final delivery of the "Hold For PickUp at UPS Access Point" package. Presence of indicator means shipper restriction will apply to the shipment. Only valid for Shipment Indication type "01 - Hold For PickUp at UPS Access Point".
RateRequest.Shipment.ShipmentServiceOptions.DeliveryConfirmation --
RateRequest.Shipment.ShipmentServiceOptions.DeliveryConfirmation.DCISType -- Type of delivery confirmation. Valid values: 1 - Delivery Confirmation Signature Required 2 - Delivery Confirmation Adult Signature Required
RateRequest.Shipment.ShipmentServiceOptions.DeliveryOptions --
RateRequest.Shipment.ShipmentServiceOptions.DeliveryOptions.DropOffAtUPSFacilityIndicator -- The presence of the tag DropOffAtUPSFacilityIndicator indicates the package will be dropped at a UPS facility for shipment.
RateRequest.Shipment.ShipmentServiceOptions.DeliveryOptions.LiftGateAtDeliveryIndicator -- The presence of the tag LiftGateAtDeliveryIndicator indicates that the shipment requires a lift gate for delivery.
RateRequest.Shipment.ShipmentServiceOptions.DirectDeliveryOnlyIndicator -- Presence/Absence Indicator. Any value inside is ignored. Direct Delivery Only (DDO) accessorial in a request would ensure that delivery is made only to the Ship To address on the shipping label. This accessorial is not valid with Shipment Indication Types:- 01 - Hold For Pickup At UPS Access Point - 02 - UPS Access Point™ Delivery
RateRequest.Shipment.ShipmentServiceOptions.EPRAIndicator -- For valid values, refer to Rating and Shipping COD Supported Countries or Territories in the Appendix.Presence/Absence Indicator. Any value inside is ignored. This field is a flag to indicate Package Release Code is requested for shipment. This accessorial is only valid with ShipmentIndicationType '01' - Hold for Pickup at UPS Access Point™.
RateRequest.Shipment.ShipmentServiceOptions.ImportControl --
RateRequest.Shipment.ShipmentServiceOptions.ImportControl.Code -- Code for type of Import Control shipment. Valid values are: '01' = ImportControl Print and Mail '02' = ImportControl One-Attempt '03' = ImportControl Three-Attempt'04' = ImportControl Electronic Label '05' = ImportControl Print Label.
RateRequest.Shipment.ShipmentServiceOptions.ImportControl.Description -- Text description of the code representing the Import Control associated with the shipment.
RateRequest.Shipment.ShipmentServiceOptions.InsideDelivery -- Inside Delivery accessory. Valid values: - 01 - White Glove- 02 - Room of Choice- 03 - Installation Shippers account needs to have a valid contract for Heavy Goods Service.
RateRequest.Shipment.ShipmentServiceOptions.ItemDisposalIndicator -- Presence/Absence Indicator. Any value inside is ignored. If present, indicates that the customer would like items disposed. Shippers account needs to have a valid contract for Heavy Goods Service.
RateRequest.Shipment.ShipmentServiceOptions.PickupOptions --
RateRequest.Shipment.ShipmentServiceOptions.PickupOptions.HoldForPickupIndicator -- The presence of the tag HoldForPickupIndicator indicates that the user opted to hold the shipment at UPS location for pickup.
RateRequest.Shipment.ShipmentServiceOptions.PickupOptions.LiftGateAtPickupIndicator -- The presence of the tag LiftGatePickupRequiredIndicator indicates that the shipment requires a lift gate for pickup.
RateRequest.Shipment.ShipmentServiceOptions.RestrictedArticles --
RateRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.AlcoholicBeveragesIndicator -- This field is a flag to indicate if the package has Alcohol. True if present; false otherwise. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.DiagnosticSpecimensIndicator -- This field is a flag to indicate if the package has Biological substances. True if present; false otherwise. Valid for UPS World Wide Express Freight shipments. Lane check will happen based on postal code/ city.
RateRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.ECigarettesIndicator -- This field is a flag to indicate if the package has E-Cigarettes. True if present; false otherwise. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.HempCBDIndicator -- This field is a flag to indicate if the package has Hemp/CBD. True if present; false otherwise. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.PerishablesIndicator -- This field is a flag to indicate if the package has Perishables. True if present; false otherwise. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.PlantsIndicator -- This field is a flag to indicate if the package has Plants. True if present; false otherwise. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.SeedsIndicator -- This field is a flag to indicate if the package has Seeds. True if present; false otherwise. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.SpecialExceptionsIndicator -- This field is a flag to indicate if the package has Special Exceptions Restricted Materials. True if present; false otherwise. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.ShipmentServiceOptions.RestrictedArticles.TobaccoIndicator -- This field is a flag to indicate if the package has Tobacco. True if present; false otherwise. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.ShipmentServiceOptions.ReturnOfDocumentIndicator -- Return of Documents Indicator - If the flag is present, the shipper has requested the ReturnOfDocument accessorial be added to the shipment Valid for Poland to Poland shipment.
RateRequest.Shipment.ShipmentServiceOptions.ReturnService --
RateRequest.Shipment.ShipmentServiceOptions.ReturnService.Code -- Code for type of Return shipment. Valid values are:'2' = UPS Print and Mail Return Label '3' =UPS One-Attempt Return Label'5' = UPS Three Attempt Return Label'8' = UPS Electronic Return Label'9' = UPS Print Return Label'10' = UPS Exchange Print Return Label '11' = UPS Pack & Collect Service 1-Attempt Box 1 '12' = UPS Pack & Collect Service 1-Attempt Box 2 '13' = UPS Pack & Collect Service 1-Attempt Box 3 '14' = UPS Pack & Collect Service 1-Attempt Box 4 '15' = UPS Pack & Collect Service 1-Attempt Box 5 '16' = UPS Pack & Collect Service 3-Attempt Box 1 '17' = UPS Pack & Collect Service 3-Attempt Box 2 '18' = UPS Pack & Collect Service 3-Attempt Box 3 '19' = UPS Pack & Collect Service 3-Attempt Box 4 '20' = UPS Pack & Collect Service 3-Attempt Box 5 10 = UPS Exchange Print Return Label and 5 = UPS Three Attempt Return Label are not valid for UPS WorldWide Express Freight and UPS Worldwide Express Freight Midday Services. 3 = UPS One-Attempt Return Label is not valid return service with UPS Premium Care accessorial.
RateRequest.Shipment.ShipmentServiceOptions.ReturnService.Description -- Description for type of Return Service.
RateRequest.Shipment.ShipmentServiceOptions.SDLShipmentIndicator -- Empty Tag means the indicator is present. This field is a flag to indicate if the receiver needs SDL rates in response. True if SDLShipmentIndicator tag exists; false otherwise. If present, the State Department License (SDL) rates will be returned in the response.This service requires that the account number is enabled for SDL.
RateRequest.Shipment.ShipmentServiceOptions.SaturdayDeliveryIndicator -- A flag indicating if a shipment must be delivered on a Saturday. True if SaturdayDeliveryIndicator tag exists; false otherwise Empty Tag.
RateRequest.Shipment.ShipmentServiceOptions.SaturdayPickupIndicator -- A flag indicating if the shipment requires a Saturday pickup. True if SaturdayPickupIndicator tag exists; false otherwise. Not available for GFP rating requests. Empty Tag.
RateRequest.Shipment.ShipmentServiceOptions.ShipperExportDeclarationIndicator -- The empty tag in request indicates that customer would be using UPS prepared SED form. Valid for UPS World Wide Express Freight shipments.
RateRequest.Shipment.ShipmentServiceOptions.SundayDeliveryIndicator -- A flag indicating if a shipment must be delivered on a Sunday. True if SundayDeliveryIndicator tag exists; false otherwise Empty Tag.
RateRequest.Shipment.ShipmentServiceOptions.UPScarbonneutralIndicator -- UPS carbon neutral indicator. Indicates the shipment will be rated as carbon neutral.
RateRequest.Shipment.ShipmentTotalWeight --
RateRequest.Shipment.ShipmentTotalWeight.UnitOfMeasurement --
RateRequest.Shipment.ShipmentTotalWeight.UnitOfMeasurement.Code -- Code representing the unit of measure associated with the package weight. Valid values: - LBS = Pounds- KGS = Kilograms.
RateRequest.Shipment.ShipmentTotalWeight.UnitOfMeasurement.Description -- Text description of the code representing the unit of measure associated with the shipment weight.
RateRequest.Shipment.ShipmentTotalWeight.Weight -- Non-zero total weight of all packages in the shipment.
RateRequest.Shipment.Shipper --
RateRequest.Shipment.Shipper.Address --
RateRequest.Shipment.Shipper.Address.AddressLine -- Shipper's street address including name and number (when applicable). Maximum Occurrence should be three. Length is not validated.
RateRequest.Shipment.Shipper.Address.City -- Shipper's city. Required if country or territory does not utilize postal codes. Length is not validated.
RateRequest.Shipment.Shipper.Address.CountryCode -- Country or Territory code. Refer to the Supported Country or Territory Tables located in Appendix.
RateRequest.Shipment.Shipper.Address.PostalCode -- Shipper's postal code. Length is not validated.
RateRequest.Shipment.Shipper.Address.StateProvinceCode -- Shipper's state code. Length is not validated.
RateRequest.Shipment.Shipper.AttentionName -- Shipper's attention name. Length is not validated.
RateRequest.Shipment.Shipper.Name -- Shipper's name or company name. Length is not validated.
RateRequest.Shipment.Shipper.ShipperNumber -- Shipper's UPS account number. A valid account number is required to receive negotiated rates. Optional otherwise. Cannot be present when requesting UserLevelDiscount.
RateRequest.Shipment.TaxInformationIndicator -- Presence/Absence Indicator. Any value inside is ignored. TaxInformationIndicator is an indicator. The Tax related information includes any type of Taxes, corresponding Monetary Values, Total Charges with Taxes and disclaimers (if applicable) would be returned in response. If present, any taxes that may be applicable to a shipment would be returned in response. If this indicator is requested with NegotiatedRatesIndicator, Tax related information, if applicable, would be returned only for Negotiated Rates and not for Published Rates.
RateRequest.Shipment.WWEShipmentIndicator -- Presence/Absence Indicator. Any value inside is ignored. WWEShipmentIndicator is an indicator and presence implies that WWE service details requested for RequestOption=Shop or RequestOption=Shoptimeintransit RequestOption=Shop or RequestOption=Shoptimeintransit
Time in Transit
.avvFlag -- Used to bypass address validation when the address has already been validated by the calling application. Valid values: true, false Defaults to true Note: not to be exposed to external customers.
.billType -- Required for International Requests. Valid values: "02","03","04" 02 - Document 03 - Non Document 04 - WWEF (Pallet)
.destinationCityName -- The shipment destination city. Required for International Requests for those countries that do not utilize postal codes.
.destinationCountryCode -- The country code of the destination. Valid values: Must conform to ISO-defined country codes.
.destinationPostalCode -- The shipment destination postal code. Required for Domestic requests. Either 5, or 9-digit U.S. zip codes must be used for U.S. addresses. For non-U.S. addresses, this is recommended for all countries that utilize postal codes.
.destinationStateProvince -- The shipment destination state or province. For U.S. addresses, the value must be a valid 2-character value (per U.S. Mail standards). For non-U.S. addresses the full State or Province name should be provided.
.destinationTownName -- The shipment destination town. Town is a subdivision of city.
.dropOffAtFacilityIndicator -- Sets the indicator for an international Freight Pallet shipment that is going to be dropped off by shipper to a UPS facility. The indicator is used when the Bill Type is "04". Valid values: "0", "1". 0 = WWDTProcessIF.PICKUP_BY_UPS 1 = WWDTProcessIf.DROPOFF_BY_SHIPPER The default value is "0"
.holdForPickupIndicator -- Sets the indicator for an international Freight Pallet shipment that is going to be pick-up by consignee in a destination facility. The indicator is used when the Bill Type is "04". Valid values: "0", "1". 0 = WWDTProcessIF.DELIVERY_BY_UPS 1 = WWDTProcessIf.PICKUP_BY_CONSIGNEE The default value is "0"
.maxList -- Sets the limit for the number of candidates returned in candidate list. Default value is 200.
.numberOfPackages -- Sets the number of packages in shipment. Default value is 1.
.originCityName -- The shipment origin city. Required for International requests for those countries that do not utilize postal codes.
.originCountryCode -- The country code of the origin shipment. Valid Values: Must conform to the ISO-defined, two-letter country or territory codes. Refer to Country or Territory Codes in the Appendix above for valid values.
.originPostalCode -- Required for Domestic requests. The shipment origin postal code. Either the 5, or 9-digit US zip codes must be used for U.S. addresses. For non-U.S. addresses, this is recommended for all countries that utilize postal codes.
.originStateProvince -- The shipment origin state or province. For U.S. addresses, the value must be a valid 2-character value (per U.S. Mail standards) For non-U.S. addresses the full State or Province name should be provided.
.originTownName -- The shipment origin town. Town is a subdivision of city.
.residentialIndicator -- Indicates if address is residential or commercial. Required for Domestic requests. Valid values: "01", "02" 01 = Residential 02 = Commercial Defaults to commercial for International Requests.
.returnUnfilterdServices -- Used to get back a full list of services - bypassing current WWDT business rules to remove services from the list being returned to clients for US domestic that are slower than UPS Ground. Default value is false.
.shipDate -- The date the shipment is tendered to UPS for shipping (can be dropped off at UPS or picked up by UPS). Allowed range is up to 60 days in future and 35 days in past. This date may or may not be the UPS business date. Format is YYYY-MM-DD. YYYY = 4 digit year; MM = 2 digit month, valid values 01-12; DD = 2 digit day of month, valid values 01-31 If no value is provided, defaults to current system date.
.shipTime -- The time the shipment is tendered to UPS for shipping (can be dropped off at UPS or picked up by UPS). Format is HH:MM:SS Defaults to current time if not provided.
.shipmentContentsCurrencyCode -- The unit of currency used for values. Required if ShipmentContentsValue is populated. Valid value: must conform to ISO standards.
.shipmentContentsValue -- The monetary value of shipment contents. Required when origin country does not equal destination country and BillType is 03 (non-documented) or 04 (WWEF) Required when origin country does not equal destination country, and destination country = CA, and BillType = 02 (document). Note: If decimal values are used, valid values will be rounded to the tenths.
.weight -- The weight of the shipment. Required for International requests. Note: If decimal values are used, valid values will be rounded to the tenths. Note: Maximum value is 70 kilograms or 150 pounds.
.weightUnitOfMeasure -- Required for International requests and when weight value is provided. Valid Values: "LBS", "KGS"
TrackAlert
.countryCode -- Represents the country code. This field is reserved for future use.
.destination --
.destination.credential -- It is an opaque string meant for client authentication. If for any reason this credential changes then any event notification will fail until a new subscription is made.
.destination.credentialType -- It is an open-entry field that indicates type of credentials supported by the client.
.destination.url -- It is an HTTP-based callback end point that is exposed by the client to receive event notification. This endpoint must be operational arround the clock to ensure no event notifications are missed.If this endpoint is not continuously available, incoming events will be lost.
.locale -- Locale setting is composed of language code and country code, separated by an underscore. This field is reserved for future use.
.scanPreference -- Represents scan/event preferences for the subscription endpoint, Place holder for Future use.
.trackingNumberList -- Represents list of tracking numbers in request.
