Shipping Carrier Parameters
The official carrier openapi docs can be a little difficult to navigate. Below is flat list of all parameters:
UPS
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.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..Code -- Valid codes:- 01 = Prepaid- 02 = FreightCollect - 03 = ThirdParty
ShipmentRequest.Shipment.FRSPaymentInformation..Description -- Specifies the description for Ground Freight Pricing payment type.
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.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.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.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.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.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.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.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.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.PreAlertNotification --
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.
Rating
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.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.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.PaymentDetails --
RateRequest.Shipment.PaymentDetails.ShipmentCharge --
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.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
FedEx
Shipment
.requestedShipment --
.requestedShipment.blockInsightVisibility -- Indicate if the shipment be available to be visible/tracked using FedEx InSight® tool. If value indicated as true, only the shipper/payer will have visibility of this shipment in the FedEx InSight® tool.
.requestedShipment.customsClearanceDetail --
.requestedShipment.customsClearanceDetail.brokers -- Specify broker information. Use this option only if you are using Broker Select Option for your shipment. A country code must be specified in addition to one of the following address items: postal code, city, or location id.
.requestedShipment.customsClearanceDetail.commercialInvoice --
.requestedShipment.customsClearanceDetail.commercialInvoice.comments -- The comments that will populate the Commercial Invoice (or Pro Forma). Only the comments specified in the first two indexes of the array will be printed on the invoice and other comments would be ignored as the limitation is set for only two indexes. It considers the comment which is in the first index as a Special Instructions, Hence the comment at first index will be printed under special instructions and the other will be printed at comments section in the Commercial Invoice Document. Example: comments
.requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences -- These are additional customer reference data for commercial invoice.
.requestedShipment.customsClearanceDetail.commercialInvoice.declarationStatement -- This is the declaration statement which will populate the Commercial Invoice (or Pro Forma).Maximum length is 554.Example: declarationStatement
.requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail --
.requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.emailAddress -- This is email Address.Example: xxxx@xxx.com
.requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.recipientType -- Specify the recipient Type.Example: SHIPPER/BROKER
.requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.type -- Specify the email status.Example: EMAILED
.requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge -- Indicate the freight charge.
.requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge.amount -- This is the amount. Maximum limit is 5 digits before decimal.Example: 12.45
.requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge.currency -- This is the currency code for the amount.Example: USDClick here to see Currency codes
.requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts -- Indicate the handling cost.
.requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts.amount -- This is the amount. Maximum limit is 5 digits before decimal.Example: 12.45
.requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts.currency -- This is the currency code for the amount.Example: USDClick here to see Currency codes
.requestedShipment.customsClearanceDetail.commercialInvoice.originatorName -- The originator name that will populate the Commercial Invoice (or Pro Forma).
.requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts -- Indicate the packing cost.
.requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts.amount -- This is the amount. Maximum limit is 5 digits before decimal.Example: 12.45
.requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts.currency -- This is the currency code for the amount.Example: USDClick here to see Currency codes
.requestedShipment.customsClearanceDetail.commercialInvoice.shipmentPurpose -- This is the reason for the shipment. Note: SOLD is not a valid purpose for a Proforma Invoice.
.requestedShipment.customsClearanceDetail.commercialInvoice.specialInstructions -- These are special instructions that will be populated on the Commercial Invoice (or Pro Forma).Example: specialInstructions
.requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge -- Indicate the taxes or miscellaneous charges(other than freight charges or insurance charges) that are associated with the shipment.
.requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge.amount -- This is the amount. Maximum limit is 5 digits before decimal.Example: 12.45
.requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge.currency -- This is the currency code for the amount.Example: USDClick here to see Currency codes
.requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousChargeType -- Indicate the type of taxes Or miscellaneous charge.
.requestedShipment.customsClearanceDetail.commercialInvoice.termsOfSale -- Specify terms Of Sale that will be populated on the Commercial Invoice (or Pro Forma). Maximum length is 3Valid values are:FCA/FOB (Free Carrier/Free On Board): Seller is responsible for all costs of delivering goods to destination. (Default)CIP (Costs, Insurance Paid): Seller is responsible for miscellaneous charges to destination.CPT (Carriage Paid To): Buyer is responsible for insurance.EXW (Ex Works): Seller makes goods available to buyer. Buyer is responsible for delivering goods to destination.DDU (Delivered Duty Unpaid): Seller is responsible for delivering goods to destination. Buyer is responsible for clearing goods through Bureau of Customs and Border Protection.DDP (Delivered Duty Paid): Seller is responsible for delivering goods to destination, including duties, taxes, and miscellaneous fees.DAP (Delivered at Place): Seller pays for carriage to the named place, except for costs related to import clearance, and assumes all risks prior to the point that the goods are ready for unloading by the buyer.DPU(Deliver at Place of Unloading)
.requestedShipment.customsClearanceDetail.commodities -- Indicates the details about the dutiable packages. Maximum upto 999 commodities per shipment.
.requestedShipment.customsClearanceDetail.customsOption --
.requestedShipment.customsClearanceDetail.customsOption.description -- Specify additional description about customs options. This is a required field when the Type is OTHER.
.requestedShipment.customsClearanceDetail.customsOption.type -- Specify the reason for a global return, as recognized by Customs. Valid values:COURTESY_RETURN_LABEL: Applicable for Outbound shipments.EXHIBITION_TRADE_SHOW: For exhibition or trade-show, outbound and inbound.FAULTY_ITEM: For faulty item being returned, inbound only.FOLLOWING_REPAIR: For repaired or processed item being sent, outbound only.FOR_REPAIR: For repair or processing, outbound and inbound.ITEM_FOR_LOAN: For loan item, outbound and inbound.OTHER: Other reason, outbound and inbound. This type requires a description.REJECTED: For rejected merchandise being returned, inbound.REPLACEMENT: For replacement being sent, outbound only.TRIAL: For use in a trial, outbound and inbound.
.requestedShipment.customsClearanceDetail.declarationStatementDetail --
.requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail --
.requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail.countryOfOriginLowValueDocumentRequested -- Specify the country Of Origin of Low Value Document for Customs declaration.
.requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail.customsRole -- Specify the shipper role for Customs declaration.
.requestedShipment.customsClearanceDetail.dutiesPayment --
.requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails --
.requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNickname -- This is account nick name.
.requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNumber -- This is bill to account number.
.requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNumberCountryCode -- This is the country code of the account number.Example: CA
.requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.aliasId -- This is bill to alias identifier.
.requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.billingCode -- Indicates a billing code.
.requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.billingType -- These are duties and taxes billing type.
.requestedShipment.customsClearanceDetail.dutiesPayment.paymentType -- This is a payment type, basically indicates who is the payor for the shipment.Required for Express and Ground.The payment type COLLECT is applicable only for Ground shipments.
.requestedShipment.customsClearanceDetail.dutiesPayment.payor --
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty --
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.accountNumber --
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.accountNumber.value -- The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address --
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.city -- This is a placeholder for City Name.Note: This is conditional and not required in all the requests.Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges.Example: Beverly Hills
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.postalCode -- Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10. Example: 65247click here to see Postal aware countries
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.stateOrProvinceCode -- This is a placeholder for State or Province code.Example: CAclick here to see State or Province Code
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.streetLines -- This is the combination of number, street name, etc. Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included. Maximum length per line is 35.Example: [10 FedEx Parkway, Suite 302, .etc.]
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact --
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.companyName -- Specify contact company name.Recommended length is 35.Note: There's no specific validation for the company name.
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.faxNumber -- Specify contact fax number.Note: Recommended length is 15. There's no specific validation for the fax number. Example: 1234567890
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.personName -- Specify contact person name.Recommended length is 70. Note: There's no specific validation for the person name. Example: John Taylor
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.phoneExtension -- Specify contact phone extension. Note: Recommended length is 6. There's no specific validation for the phone extension. Example: 1234
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.phoneNumber -- Contact person's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.Example: 918xxxxx890
.requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins -- This is the tax identification number details.
.requestedShipment.customsClearanceDetail.exportDetail --
.requestedShipment.customsClearanceDetail.exportDetail.b13AFilingOption -- Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands.
.requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail --
.requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.destinationCountries -- Specify DCS shipment destination country. You may enter up to four country codes in this element. Up to 11 alphanumeric characters are allowed.Example: USclick here to see Country codes
.requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.endUser -- Specify End User name. Its is required if StatementTypes is entered as DEPARTMENT_OF_STATE. Example: John Wick
.requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.statementTypes -- Specify appropriate destination control statement type(s), Also make sure to specify destination country and end user.
.requestedShipment.customsClearanceDetail.exportDetail.exportComplianceStatement -- For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number.The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES. Example: AESX20220714987654Note: The ITN or FTR exemption number you submit in the ship request prints on the international shipping label.For CA export shipments,it can be Proof of report number(15-32 alphanumeric) , Summary proof of report number(7-32 alphanumeric) or Exemption number(2 digit) based on the selected b13AFilingOption.Example: 98765432107654321(POR number), 7654321(Summary POR number) and 02(Exemption number).
.requestedShipment.customsClearanceDetail.exportDetail.permitNumber -- This is a Permit Number. This field is applicable only to Canada export non-document shipments of any value to any destination. No special characters are allowed. Example: 12345
.requestedShipment.customsClearanceDetail.freightOnValue -- Specify the risk owner for the Freight shipment.This element is only mandatory or valid for Intra India shipments.
.requestedShipment.customsClearanceDetail.generatedDocumentLocale -- This is the locale for generated document.Example: en_USclick here to see LocalesNote: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
.requestedShipment.customsClearanceDetail.importerOfRecord -- The descriptive data for the importer of Record for the shipment and their physical address, contact and account number information.
.requestedShipment.customsClearanceDetail.importerOfRecord.accountNumber --
.requestedShipment.customsClearanceDetail.importerOfRecord.accountNumber.value -- The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
.requestedShipment.customsClearanceDetail.importerOfRecord.address --
.requestedShipment.customsClearanceDetail.importerOfRecord.address.city -- The name of city, town of the recipient.Max length is 35.Example: Beverly Hills
.requestedShipment.customsClearanceDetail.importerOfRecord.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.customsClearanceDetail.importerOfRecord.address.postalCode -- This is the postal code.Note: This is Optional for non postal-aware countries. Maximum length is 10.Example: 65247click here to see Postal aware countries
.requestedShipment.customsClearanceDetail.importerOfRecord.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.customsClearanceDetail.importerOfRecord.address.stateOrProvinceCode -- This is a placeholder for state or province code.Example: CA.click here to see State or Province Code
.requestedShipment.customsClearanceDetail.importerOfRecord.address.streetLines -- This is the combination of number, street name, etc. Maximum length per line is 35.Example: 10 FedEx Parkway, Suite 302.Note:At least one line is required.Streetlines more than 3 will be ignored.Empty lines should not be includedFor SmartPost Shipments, only 30 characters from the individual street lines will be printed on the labels.
.requestedShipment.customsClearanceDetail.importerOfRecord.contact --
.requestedShipment.customsClearanceDetail.importerOfRecord.contact.companyName -- Specify contact company name. Maximum length is 35. Note: Either the companyName or personName is mandatory.
.requestedShipment.customsClearanceDetail.importerOfRecord.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.customsClearanceDetail.importerOfRecord.contact.personName -- Specify contact name. Maximum length is 70. Note: Either the companyName or personName is mandatory. Example: John Taylor
.requestedShipment.customsClearanceDetail.importerOfRecord.contact.phoneExtension -- Specify contact phone extension. Maximum length is 6. Example: 1234
.requestedShipment.customsClearanceDetail.importerOfRecord.contact.phoneNumber -- The shipper's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.Example: 918xxxxx890
.requestedShipment.customsClearanceDetail.importerOfRecord.tins -- This is the tax identification number details.
.requestedShipment.customsClearanceDetail.insuranceCharge -- Specify insurance charges if applicable. Note: FedEx does not provide insurance of any kind.
.requestedShipment.customsClearanceDetail.insuranceCharge.amount -- This is the amount. Maximum limit is 5 digits before decimal.Example: 12.45
.requestedShipment.customsClearanceDetail.insuranceCharge.currency -- This is the currency code for the amount.Example: USDClick here to see Currency codes
.requestedShipment.customsClearanceDetail.isDocumentOnly -- Used to specify if a shipment is document shipment or not. Used only for International Express document shipments. Default value is false.
.requestedShipment.customsClearanceDetail.partiesToTransactionAreRelated -- Specify if the transacting parties are related.
.requestedShipment.customsClearanceDetail.recipientCustomsId --
.requestedShipment.customsClearanceDetail.recipientCustomsId.type -- This is ID Type.
.requestedShipment.customsClearanceDetail.recipientCustomsId.value -- This is the ID number.
.requestedShipment.customsClearanceDetail.regulatoryControls -- These are the regulatory controls applicable to the shipment.
.requestedShipment.customsClearanceDetail.totalCustomsValue -- This is the total customs value.
.requestedShipment.customsClearanceDetail.totalCustomsValue.amount -- This is the amount. Maximum limit is 5 digits before decimal.Example: 12.45
.requestedShipment.customsClearanceDetail.totalCustomsValue.currency -- This is the currency code for the amount.Example: USDClick here to see Currency codes
.requestedShipment.emailNotificationDetail --
.requestedShipment.emailNotificationDetail.aggregationType -- This is the shipment Notification Aggregation Type.
.requestedShipment.emailNotificationDetail.emailNotificationRecipients -- These are email notification recipient details.
.requestedShipment.emailNotificationDetail.personalMessage -- This is your personal message for the email.Note: The maximum personal message character limit depends on the element notificationFormatType values:If notificationFormatType is TEXT, then only 120 characters printed on the emailIf notificationFormatType is HTML, then 500 characters printed on the emailExample: This is concerning the order 123456 of 26 July 2021 - art no 34324-23 Teddy Bear, brown
.requestedShipment.expressFreightDetail --
.requestedShipment.expressFreightDetail.bookingConfirmationNumber -- This is an advanced booking number that must be acquired through the appropriate channel in the shipment origin country. Without the booking number pickup and space allocation for the Express Freight shipment are not guaranteed. Minimum length: 5 digits Maximum length: 12 digits Example: XXXX56789812
.requestedShipment.expressFreightDetail.packingListEnclosed -- This indicates whether or not the Packing List is enclosed with the shipment. A packing list is a document that includes details about the contents of a package. Example: true
.requestedShipment.expressFreightDetail.shippersLoadAndCount -- Indicates the content of a container were loaded and counted by the shipper.Minimum length: 1 digits Maximum length: 5 digits Example: If a skid has 32 small boxes on it that are shrinkwrapped, the shippersLoadAndCount should be “32”
.requestedShipment.labelSpecification --
.requestedShipment.labelSpecification.customerSpecifiedDetail --
.requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels -- Specify how the additional details to be provided on the labels.
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent --
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded --
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification --
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.dataField -- Indicate the path request/reply element to be printed on doc tab.Example:REQUEST/SHIPMENT/ShipTimestampREQUEST/PACKAGE/weight/ValueREQUEST/PACKAGE/InsuredValue/AmountREQUEST/SHIPMENT/SpecialServicesRequested/CodDetail/CodCollectionAmount/AmountREQUEST/SHIPMENT/Shipper/Address/StreetLines[1]CLIENT/MeterNumberTRANSACTION/CustomerTransactionIdREQUEST/SHIPMENT/TotalWeight/ValueREQUEST/SHIPMENT/ShipTimestampREQUEST/SHIPMENT/Recipient/Contact/PersonNameREPLY/SHIPMENT/OperationalDetail/DeliveryDateREPLY/PACKAGE/RATE/ACTUAL/BaseCharge/AmountREPLY/PACKAGE/RATE/ACTUAL/TotalFreightDiscounts/AmountREPLY/PACKAGE/RATE/ACTUAL/TotalSurcharges/AmountREPLY/PACKAGE/RATE/ACTUAL/NetCharge/AmountREPLY/SHIPMENT/RATES/PAYOR_ACCOUNT/TotalSurcharges/Amount
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.header -- Indicates the parameter name in the header for the doc tab zone.Example: WHT
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.justification -- Indicates the justification format for the string.
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.literalValue -- Indicates the actual data to be printed in the label
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.zoneNumber -- It is a non-negative integer that represents the portion of doc-tab in a label.Example: 1
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.symbology -- Indicates the type of barcode symbology used on FedEx documents and labels.
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.docTabContentType -- Indicates the content type of the doc tab.
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001 --
.requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications -- Indicate the doc tab specifications for the individual doc tab zone on the label.
.requestedShipment.labelSpecification.customerSpecifiedDetail.maskedData -- Specify which data/sections on the label to be masked.Note: SECONDARY_BARCODE – This is used for Smartpost shipment labels.SHIPPER_INFORMATION – This is used for Third Party Consignee, Intra-UK shipments.TOTAL_WEIGHT – This replaces the Total weight with Actual Weight in Master label and AWB copies.
.requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels -- Specify how the regulatory details to be provided on the labels.
.requestedShipment.labelSpecification.imageType -- Specify the image format used for a shipping document.click here to see label format types
.requestedShipment.labelSpecification.labelFormatType -- Specify the label Format Type.click here to see label format types
.requestedShipment.labelSpecification.labelOrder -- This is the order of the Shipping label/documents to be generated.
.requestedShipment.labelSpecification.labelPrintingOrientation -- This is applicable only to documents produced on thermal printers with roll stock.
.requestedShipment.labelSpecification.labelRotation -- This is applicable only to documents produced on thermal printers with roll stock.
.requestedShipment.labelSpecification.labelStockType -- Indicate the label stock type used. click here to see label format types
.requestedShipment.labelSpecification.printedLabelOrigin --
.requestedShipment.labelSpecification.printedLabelOrigin.address --
.requestedShipment.labelSpecification.printedLabelOrigin.address.city -- This is a placeholder for City Name.Note: This is conditional and not required in all the requests.Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges.Example: Beverly Hills
.requestedShipment.labelSpecification.printedLabelOrigin.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.labelSpecification.printedLabelOrigin.address.postalCode -- Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10. Example: 65247click here to see Postal aware countries
.requestedShipment.labelSpecification.printedLabelOrigin.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.labelSpecification.printedLabelOrigin.address.stateOrProvinceCode -- This is a placeholder for State or Province code.Example: CAclick here to see State or Province Code
.requestedShipment.labelSpecification.printedLabelOrigin.address.streetLines -- This is the combination of number, street name, etc. Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included. Maximum length per line is 35.Example: [10 FedEx Parkway, Suite 302, .etc.]
.requestedShipment.labelSpecification.printedLabelOrigin.contact --
.requestedShipment.labelSpecification.printedLabelOrigin.contact.companyName -- Specify contact company name.Recommended length is 35.Note: There's no specific validation for the company name.
.requestedShipment.labelSpecification.printedLabelOrigin.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.labelSpecification.printedLabelOrigin.contact.faxNumber -- Specify contact fax number.Note: Recommended length is 15. There's no specific validation for the fax number. Example: 1234567890
.requestedShipment.labelSpecification.printedLabelOrigin.contact.personName -- Specify contact person name.Recommended length is 70. Note: There's no specific validation for the person name. Example: John Taylor
.requestedShipment.labelSpecification.printedLabelOrigin.contact.phoneExtension -- Specify contact phone extension. Note: Recommended length is 6. There's no specific validation for the phone extension. Example: 1234
.requestedShipment.labelSpecification.printedLabelOrigin.contact.phoneNumber -- Contact person's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.Example: 918xxxxx890
.requestedShipment.labelSpecification.returnedDispositionDetail -- Specify whether or not the return deposition is needed.
.requestedShipment.masterTrackingId --
.requestedShipment.masterTrackingId.formId -- This is FedEx tracking Identifier associated with the package.Example: 8600
.requestedShipment.masterTrackingId.trackingIdType -- Specify the FedEx transportation type. Example: EXPRESS
.requestedShipment.masterTrackingId.trackingNumber -- This is the number associated with the package that is used to track it.For child shipment of an oneLabelAtATime shipments,this should be same as the masterTrackingNumber of the parent shipment. Example: 49XXX0000XXX20032835
.requestedShipment.masterTrackingId.uspsApplicationId -- Specify the USPS tracking Identifier associated with FedEx SmartPost shipment.Example: 92
.requestedShipment.origin -- Indicate shipment origin address information, if it is different from the shipper address.
.requestedShipment.origin.address --
.requestedShipment.origin.address.city -- This is a placeholder for City Name.Note: This is conditional and not required in all the requests.Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges.Example: Beverly Hills
.requestedShipment.origin.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.origin.address.postalCode -- Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10. Example: 65247click here to see Postal aware countries
.requestedShipment.origin.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.origin.address.stateOrProvinceCode -- This is a placeholder for State or Province code.Example: CAclick here to see State or Province Code
.requestedShipment.origin.address.streetLines -- This is the combination of number, street name, etc. Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included. Maximum length per line is 35.Example: [10 FedEx Parkway, Suite 302, .etc.]
.requestedShipment.origin.contact --
.requestedShipment.origin.contact.companyName -- Specify contact company name.Recommended length is 35.Note: There's no specific validation for the company name.
.requestedShipment.origin.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.origin.contact.faxNumber -- Specify contact fax number.Note: Recommended length is 15. There's no specific validation for the fax number. Example: 1234567890
.requestedShipment.origin.contact.personName -- Specify contact person name.Recommended length is 70. Note: There's no specific validation for the person name. Example: John Taylor
.requestedShipment.origin.contact.phoneExtension -- Specify contact phone extension. Note: Recommended length is 6. There's no specific validation for the phone extension. Example: 1234
.requestedShipment.origin.contact.phoneNumber -- Specify contact phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers. Note: Recommended Maximum length is 15 and there's no specific validation will be done for the phone number. Example: 918xxxxx890
.requestedShipment.packagingType -- Specify the packaging used.Note: For Express Freight shipments, the packaging will default to YOUR_PACKAGING irrespective of the user provided package type in the request.Example: FEDEX_PAKclick here to see Package Types
.requestedShipment.pickupType -- Indicate the pickup type method by which the shipment to be tendered to FedEx.Click here for more information on Pickup Types.
.requestedShipment.preferredCurrency -- Indicate the currency the caller requests to have used in all returned monetary values. Should be Used in conjunction with the element RateRequestType.Example: USDclick here to see available Currency codesNote: Incorrect currency codes should not be supplied. The system ignores the incorrect currency code.
.requestedShipment.rateRequestType -- Indicate the type of rates to be returned. The account specific rates are returned by default if the account number is specified in the request.Following are values:LIST - Returns FedEx published list rates in addition to account-specific rates (if applicable).INCENTIVE - This is one-time discount for incentivising the customer. For more information, contact your FedEx representative.ACCOUNT - Returns account specific rates (Default).PREFERRED - Returns rates in the preferred currency specified in the element preferredCurrency.RETAIL - Returns customer rate from one of retail FedEx service centers.Examples: ["ACCOUNT", "PREFERRED"]
.requestedShipment.recipientLocationNumber -- A unique identifier for a recipient location.
.requestedShipment.recipients -- Indicate the descriptive data for the recipient location to which the shipment is to be received.
.requestedShipment.requestedPackageLineItems -- These are one or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics of all packages in the shipment.At least one instance containing the weight for at least one package is required for EXPRESS and GROUND shipments.Single piece requests will have one RequestedPackageLineItem.Multiple piece requests will have multiple RequestedPackageLineItems.Maximum occurrences is 30.
.requestedShipment.serviceType -- Indicate the FedEx service type used for this shipment.Example: STANDARD_OVERNIGHTclick here to see Service Types
.requestedShipment.shipDatestamp -- This is the shipment date. Default value is current date in case the date is not provided or a past date is provided.Format [YYYY-MM-DD].Example: 2019-10-14
.requestedShipment.shipmentSpecialServices --
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail --
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient -- The descriptive data for the recipient of the shipment and the physical location for the shipment destination.
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address --
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.city -- The name of city, town of the recipient.Max length is 35.Example: Beverly Hills
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.postalCode -- This is the postal code.Note: This is Optional for non postal-aware countries. Maximum length is 10.Example: 65247click here to see Postal aware countries
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.stateOrProvinceCode -- This is a placeholder for state or province code.Example: CA.click here to see State or Province Code
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.streetLines -- This is the combination of number, street name, etc. Maximum length per line is 35.Example: 10 FedEx Parkway, Suite 302.Note:At least one line is required.Streetlines more than 3 will be ignored.Empty lines should not be includedFor SmartPost Shipments, only 30 characters from the individual street lines will be printed on the labels.
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact --
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.companyName -- Specify contact company name. Maximum length is 35. Note: Either the companyName or personName is mandatory.
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.personName -- Specify contact name. Maximum length is 70. Note: Either the companyName or personName is mandatory. Example: John Taylor
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.phoneExtension -- Specify contact phone extension. Maximum length is 6. Example: 1234
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.phoneNumber -- The shipper's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.Example: 918xxxxx890
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.deliveryInstructions -- Specify the delivery instructions to be added with the shipment. Use with Ground Home Delivery.Example: Delivery Instructions
.requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins -- This is the tax identification number details.
.requestedShipment.shipmentSpecialServices.etdDetail --
.requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments -- Use this object to specify the details regarding already uploded document(s). This object is required if the documents are uploaded Pre-Shipment uploaded documents. It is recommended to provide values for all elements under this object.
.requestedShipment.shipmentSpecialServices.etdDetail.attributes -- Use this attribute to specify if the Trade documents will be uploaded post the shipment.
.requestedShipment.shipmentSpecialServices.etdDetail.requestedDocumentTypes -- Indicate the types of shipping documents produced for the shipper by FedEx. The types of shipping documents are copied back to the shipper in the shipment result data.Note: For more information document types, refer business overview topic - Shipping and Customs Documents.
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail --
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress --
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address --
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.city -- This is a placeholder for City Name.Note: This is conditional and not required in all the requests.Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges.Example: Beverly Hills
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.postalCode -- Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10. Example: 65247click here to see Postal aware countries
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.stateOrProvinceCode -- This is a placeholder for State or Province code.Example: CAclick here to see State or Province Code
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.streetLines -- This is the combination of number, street name, etc. Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included. Maximum length per line is 35.Example: [10 FedEx Parkway, Suite 302, .etc.]
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact --
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.companyName -- Specify contact company name.Recommended length is 35.Note: There's no specific validation for the company name.
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.faxNumber -- Specify contact fax number.Note: Recommended length is 15. There's no specific validation for the fax number. Example: 1234567890
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.personName -- Specify contact person name.Recommended length is 70. Note: There's no specific validation for the person name. Example: John Taylor
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneExtension -- Specify contact phone extension. Note: Recommended length is 6. There's no specific validation for the phone extension. Example: 1234
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneNumber -- Contact person's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.Example: 918xxxxx890
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationId -- This is an alphanumeric identifier used for Location/Facility Identification.Example: YBZANote: For HAL Shipment, Location ID is REQUIRED to ensure packages are delivered to the right location.Use endpoint [Find Location] in [Location Search API], to find the correct location ID for your shipment.
.requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationType -- Specifies the type of facility at which package/shipment is to be held.
.requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail --
.requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.deliveryDate -- This is delivery date. Required for FedEx Date Certain Home Delivery. Valid dates are Monday to Sunday. There may be a delay in delivery on Sundays to locations that are geographically difficult to access.Example: 2019-06-26
.requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.homedeliveryPremiumType -- This is Home Delivery Premium Type. It allows to specify additional premimum service options for the home delivery shipment. Can specify Evening delivery or a Date certain, or can specify appointment for the delivery.
.requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber --
.requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.areaCode -- Indicate the area code for the phone number.
.requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.extension -- Indicate the extension for the phone number.
.requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.localNumber -- Indicate the local phone number for contacting in the event of an emergency. Maximum length is 10.
.requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.personalIdentificationNumber -- Indicate the Personal Identification Number associated with the phone number.
.requestedShipment.shipmentSpecialServices.internationalControlledExportDetail --
.requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.entryNumber -- Indicate Entry Number for the export.Example: 125
.requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.foreignTradeZoneCode -- Indicate the Foreign Trade Zone Code.Example: US
.requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.licenseOrPermitExpirationDate -- Indicate the expiration date for the license or permit. The format is YYYY-MM-DD.Example: "2019-12-03"
.requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.licenseOrPermitNumber -- Indicate License Or Permit Number for the commodity being exported.Example: 11
.requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.type -- Indicate International Controlled Export Type.
.requestedShipment.shipmentSpecialServices.internationalTrafficInArmsRegulationsDetail --
.requestedShipment.shipmentSpecialServices.internationalTrafficInArmsRegulationsDetail.licenseOrExemptionNumber -- The export or license number for the ITAR shipment.Minimum length is 5 characters.Maximum length is 21 characters.Example: 9871234
.requestedShipment.shipmentSpecialServices.pendingShipmentDetail --
.requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments -- These are the reference document details with the shipment.
.requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail --
.requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.message -- This is an optional personalized message to be included in the email to the recipient.
.requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients -- This is Email label recipient email address, shipment role, & language locale details. Atleast one entry must be specified.
.requestedShipment.shipmentSpecialServices.pendingShipmentDetail.expirationTimeStamp -- This is the Email Label expiration date. The maximum expiration date for an Email Return Label must be greater of equal to the day of the label request and not greater than 2 years in the future.Example: 2020-01-01
.requestedShipment.shipmentSpecialServices.pendingShipmentDetail.pendingShipmentType -- This is Pending Shipment Type. Must include the value 'EMAIL' for email return shipments.Not applicable for other types of shipments.
.requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions --
.requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions.options -- These are processing options.
.requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification --
.requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification.types -- This is the recommended document Type.click here to see shipment document type
.requestedShipment.shipmentSpecialServices.returnShipmentDetail --
.requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail --
.requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail.shipDatestamp -- This is the ship date for the outbound shipment associated with a return shipment. The format is YYYY-MM-DD. Example: 2019-10-01
.requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail.trackingNumber -- This is the tracking number associated with this package.Example: 49XXX0000XXX20032835
.requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail --
.requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail.allowedSpecialService -- Indicate the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created.Only services represented in EmailLabelAllowedSpecialServiceType will be controlled by this list.
.requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail.merchantPhoneNumber -- This is the merchant phone number and required for Email Return Labels.Example: 19012635656
.requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnType -- This is the return Type. Required to be set to PRINT_RETURN_LABEL for printed return label shipments. For email return label shipments returnType must be set to PENDING and pendingShipmentDetail must be set to EMAIL.
.requestedShipment.shipmentSpecialServices.returnShipmentDetail.rma --
.requestedShipment.shipmentSpecialServices.returnShipmentDetail.rma.reason -- Specify the reason for the return. Note: There is no validation for reason. Recommended length is 60 alpha-numeric charactersExample: Wrong color or size.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail --
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail --
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.chargeLevelType -- Specify which level the charges to be applied.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.chargeType -- Specify Charge type.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.rateLevelType -- Specify which level the rate to be applied.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.rateType -- Specify the Rate Type used.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount -- Indicate the COD collection amount.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount.amount -- This is the amount. Maximum limit is 5 digits before decimal.Example: 12.45
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount.currency -- This is the currency code for the amount.Example: USDClick here to see Currency codes
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionType -- Identifies the type of funds FedEx should collect upon shipment delivery
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient -- Descriptive data of the Cash On Delivery along with their details of the physical location.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.accountNumber --
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.accountNumber.value -- The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address --
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.city -- The name of city, town of the recipient.Max length is 35.Example: Beverly Hills
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.postalCode -- This is the postal code.Note: This is Optional for non postal-aware countries. Maximum length is 10.Example: 65247click here to see Postal aware countries
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.stateOrProvinceCode -- This is a placeholder for state or province code.Example: CA.click here to see State or Province Code
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.streetLines -- This is the combination of number, street name, etc. Maximum length per line is 35.Example: 10 FedEx Parkway, Suite 302.Note:At least one line is required.Streetlines more than 3 will be ignored.Empty lines should not be includedFor SmartPost Shipments, only 30 characters from the individual street lines will be printed on the labels.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact --
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.companyName -- Specify contact company name. Maximum length is 35. Note: Either the companyName or personName is mandatory.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.personName -- Specify contact name. Maximum length is 70. Note: Either the companyName or personName is mandatory. Example: John Taylor
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.phoneExtension -- Specify contact phone extension. Maximum length is 6. Example: 1234
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.phoneNumber -- The shipper's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.Example: 918xxxxx890
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins -- This is the tax identification number details.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress --
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address --
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.city -- This is a placeholder for City Name.Note: This is conditional and not required in all the requests.Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges.Example: Beverly Hills
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.postalCode -- Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10. Example: 65247click here to see Postal aware countries
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.stateOrProvinceCode -- This is a placeholder for State or Province code.Example: CAclick here to see State or Province Code
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.streetLines -- This is the combination of number, street name, etc. Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included. Maximum length per line is 35.Example: [10 FedEx Parkway, Suite 302, .etc.]
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact --
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.companyName -- Specify contact company name.Recommended length is 35.Note: There's no specific validation for the company name.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.faxNumber -- Specify contact fax number.Note: Recommended length is 15. There's no specific validation for the fax number. Example: 1234567890
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.personName -- Specify contact person name.Recommended length is 70. Note: There's no specific validation for the person name. Example: John Taylor
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.phoneExtension -- Specify contact phone extension. Note: Recommended length is 6. There's no specific validation for the phone extension. Example: 1234
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.phoneNumber -- Contact person's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.Example: 918xxxxx890
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.remitToName -- Specify the name of the person or company receiving the secured/unsecured funds payment.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.returnReferenceIndicatorType -- Indicate return reference type information to include on the COD return shipping label.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount -- Indicate the COD amount for this shipment.
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount.amount -- This is the amount. Maximum limit is 5 digits before decimal.Example: 12.45
.requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount.currency -- This is the currency code for the amount.Example: USDClick here to see Currency codes
.requestedShipment.shipmentSpecialServices.shipmentDryIceDetail --
.requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.packageCount -- Indicates the total number of packages in the shipment that contain dry ice.Example: 12
.requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight --
.requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.units -- This is the package weight unit. For Dry Ice the unit of measure is KG.
.requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.value -- Weight Value. Example: 68.25Click here to see Weight Values.
.requestedShipment.shipmentSpecialServices.specialServiceTypes -- Special services requested for the shipment.Example: HOLD_AT_LOCATIONRETURN_SHIPMENTBROKER_SELECT_OPTIONCALL_BEFORE_DELIVERYCODCUSTOM_DELIVERY_WINDOWclick here to see Shipment Special Service Types
.requestedShipment.shipper -- Indicate the Shipper contact details for this shipment.
.requestedShipment.shipper.address --
.requestedShipment.shipper.address.city -- The name of city, town of the recipient.Max length is 35.Example: Beverly Hills
.requestedShipment.shipper.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.shipper.address.postalCode -- This is the postal code.Note: This is Optional for non postal-aware countries. Maximum length is 10.Example: 65247click here to see Postal aware countries
.requestedShipment.shipper.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.shipper.address.stateOrProvinceCode -- This is a placeholder for state or province code.Example: CA.click here to see State or Province Code
.requestedShipment.shipper.address.streetLines -- This is the combination of number, street name, etc. Maximum length per line is 35.Example: 10 FedEx Parkway, Suite 302.Note:At least one line is required.Streetlines more than 3 will be ignored.Empty lines should not be includedFor SmartPost Shipments, only 30 characters from the individual street lines will be printed on the labels.
.requestedShipment.shipper.contact --
.requestedShipment.shipper.contact.companyName -- Specify contact company name. Maximum length is 35. Note: Either the companyName or personName is mandatory.
.requestedShipment.shipper.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.shipper.contact.personName -- Specify contact name. Maximum length is 70. Note: Either the companyName or personName is mandatory. Example: John Taylor
.requestedShipment.shipper.contact.phoneExtension -- Specify contact phone extension. Maximum length is 6. Example: 1234
.requestedShipment.shipper.contact.phoneNumber -- The shipper's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.Example: 918xxxxx890
.requestedShipment.shipper.tins -- This is the tax identification number details.
.requestedShipment.shippingChargesPayment --
.requestedShipment.shippingChargesPayment.paymentType -- Specifies the payment Type. Note: This is required for Express, Ground and SmartPost shipments. The payment type COLLECT is applicable only for Ground shipments.
.requestedShipment.shippingChargesPayment.payor --
.requestedShipment.shippingChargesPayment.payor.responsibleParty --
.requestedShipment.shippingChargesPayment.payor.responsibleParty.accountNumber --
.requestedShipment.shippingChargesPayment.payor.responsibleParty.accountNumber.value -- The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
.requestedShipment.shippingChargesPayment.payor.responsibleParty.address --
.requestedShipment.shippingChargesPayment.payor.responsibleParty.address.city -- The name of city, town of the recipient.Max length is 35.Example: Beverly Hills
.requestedShipment.shippingChargesPayment.payor.responsibleParty.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.shippingChargesPayment.payor.responsibleParty.address.postalCode -- This is the postal code.Note: This is Optional for non postal-aware countries. Maximum length is 10.Example: 65247click here to see Postal aware countries
.requestedShipment.shippingChargesPayment.payor.responsibleParty.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.shippingChargesPayment.payor.responsibleParty.address.stateOrProvinceCode -- This is a placeholder for state or province code.Example: CA.click here to see State or Province Code
.requestedShipment.shippingChargesPayment.payor.responsibleParty.address.streetLines -- This is the combination of number, street name, etc. Maximum length per line is 35.Example: 10 FedEx Parkway, Suite 302.Note:At least one line is required.Streetlines more than 3 will be ignored.Empty lines should not be includedFor SmartPost Shipments, only 30 characters from the individual street lines will be printed on the labels.
.requestedShipment.shippingChargesPayment.payor.responsibleParty.contact --
.requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.companyName -- Specify contact company name. Maximum length is 35. Note: Either the companyName or personName is mandatory.
.requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.personName -- Specify contact name. Maximum length is 70. Note: Either the companyName or personName is mandatory. Example: John Taylor
.requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.phoneExtension -- Specify contact phone extension. Maximum length is 6. Example: 1234
.requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.phoneNumber -- The shipper's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.Example: 918xxxxx890
.requestedShipment.shippingDocumentSpecification --
.requestedShipment.shippingDocumentSpecification.certificateOfOrigin --
.requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages -- Specifies the usage and identification of customer supplied images to be used on this document.
.requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat --
.requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions -- Specifies how to create, organize, and return the document
.requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.docType -- Specify the image format used for a shipping document.click here to see label format types
.requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.locale -- These are locale details.example: 'en_US'click here to see LocalesNote: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
.requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.optionsRequested --
.requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.optionsRequested.options -- Indicates the format options. SUPPRESS_ADDITIONAL_LANGUAGES value will suppress English language if another language is specified in the language code field.
.requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.provideInstructions -- Indicates whether or not to provide the instructions.
.requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.stockType -- Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
.requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail --
.requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages -- Specifies the usage and identification of customer supplied images to be used on this document.
.requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat --
.requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions -- Specifies how to create, organize, and return the document
.requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.docType -- Specify the image format used for a shipping document.click here to see label format types
.requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.locale -- These are locale details.example: 'en_US'click here to see LocalesNote: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
.requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.optionsRequested --
.requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.optionsRequested.options -- Indicates the format options. SUPPRESS_ADDITIONAL_LANGUAGES value will suppress English language if another language is specified in the language code field.
.requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.provideInstructions -- Indicates whether or not to provide the instructions.
.requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.stockType -- Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
.requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail --
.requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat --
.requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions -- Specifies how to create, organize, and return the document
.requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.docType -- Specify the image format used for a shipping document.click here to see label format types
.requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.locale -- These are locale details.example: 'en_US'click here to see LocalesNote: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
.requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.optionsRequested --
.requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.optionsRequested.options -- Indicates the format options. SUPPRESS_ADDITIONAL_LANGUAGES value will suppress English language if another language is specified in the language code field.
.requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.provideInstructions -- Indicates whether or not to provide the instructions.
.requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.stockType -- Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
.requestedShipment.shippingDocumentSpecification.op900Detail --
.requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages -- Specify the use and identification of supplied images to be used on document.
.requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat --
.requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions -- Specifies how to create, organize, and return the document
.requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.docType -- Specify the image format used for a shipping document.click here to see label format types
.requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.locale -- These are locale details.example: 'en_US'click here to see LocalesNote: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
.requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.optionsRequested --
.requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.optionsRequested.options -- Indicates the format options. SUPPRESS_ADDITIONAL_LANGUAGES value will suppress English language if another language is specified in the language code field.
.requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.provideInstructions -- Indicates whether or not to provide the instructions.
.requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.stockType -- Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
.requestedShipment.shippingDocumentSpecification.op900Detail.signatureName -- Indicates the name to be printed as signature on the document instead of (or in addition to) a signature image.Example: John Hill
.requestedShipment.shippingDocumentSpecification.returnInstructionsDetail --
.requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.customText -- Specify additional information (text) to be inserted into the return document.Example: This is additional text printed on Return Label
.requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat --
.requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions -- Details on creating, organizing, and returning the document.
.requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.docType -- Specify the image format used for shipping document.click here to see label format types
.requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.locale -- These are locale details.example: 'en_US'click here to see LocalesNote: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
.requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.optionsRequested --
.requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.optionsRequested.options -- Indicates the format options. SUPPRESS_ADDITIONAL_LANGUAGES value will suppress English language if another language is specified in the language code field.
.requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.provideInstructions -- Use this element to indicate whether or not to provide the instructions.
.requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.stockType -- Specify the label stock type.click here to see label format types
.requestedShipment.shippingDocumentSpecification.shippingDocumentTypes -- Indicates the types of shipping documents requested.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail --
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod --
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod.begins -- Indicates the start date.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod.ends -- Indicates the end date.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.certifierJobTitle -- Specify the job title of the certifier
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.certifierSpecification -- This is certifier specification.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages -- Specifies the usage and identification of customer supplied images to be used on this document.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat --
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions -- Specifies how to create, organize, and return the document
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.docType -- Specify the image format used for a shipping document.click here to see label format types
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.locale -- These are locale details.example: 'en_US'click here to see LocalesNote: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.optionsRequested --
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.optionsRequested.options -- Indicates the format options. SUPPRESS_ADDITIONAL_LANGUAGES value will suppress English language if another language is specified in the language code field.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.provideInstructions -- Indicates whether or not to provide the instructions.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.stockType -- Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.importerSpecification -- This is importer specification.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer --
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address --
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.city -- This is a placeholder for City Name. Example: Beverly Hills
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.geographicCoordinates -- Indicates the geographic coordinates. example: geographicCoordinates
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.postalCode -- This is the Postal code.This is Optional for non postal-aware countries.Maximum length is 10.Example: 65247click here to see Postal aware countries
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.stateOrProvinceCode -- This is a placeholder for State or Province code.Example: CA.click here to see State or Province Code
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.streetLines -- This is the combination of number, street name, etc. Maximum length per line is 35.Example: 10 FedEx Parkway, Suite 302.Note:At least one line is required.Streetlines more than 3 will be ignored.Empty lines should not be includedFor SmartPost Shipments, only 30 characters from the individual street lines will be printed on the labels.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact --
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.companyName -- Specify contact company name.Recommended length is 35.Note: There's no specific validation of the company name.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.faxNumber -- Specify contact person's fax number. Maximum length is 15.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.personName -- Specify contact name. Maximum length is 70. Example: John Taylor
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.phoneExtension -- Specify contact phone extension. Maximum length is 6. Example: 1234
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.phoneNumber -- Specify contact phone number. Minimum length is 10 and supports Maximum as 15 for certain countries using longer phone numbers. Note: Recommended Maximum length is 15 and there's no specific validation will be done for the phone number. Example: 918xxxxx890
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins -- This is the tax identification number details.
.requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producerSpecification -- This is producer specification.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail --
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.certifierJobTitle -- Specify the job title of the certifier
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.certifierSpecification -- This is certifier specification.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages -- Specifies the usage and identification of customer supplied images to be used on this document.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat --
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions -- Specifies how to create, organize, and return the document
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.docType -- Specify the image format used for a shipping document.click here to see label format types
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.locale -- These are locale details.example: 'en_US'click here to see LocalesNote: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.optionsRequested --
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.optionsRequested.options -- Indicates the format options. SUPPRESS_ADDITIONAL_LANGUAGES value will suppress English language if another language is specified in the language code field.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.provideInstructions -- Indicates whether or not to provide the instructions.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.stockType -- Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.importerSpecification -- This is importer specification.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer --
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address --
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.city -- This is a placeholder for City Name. Example: Beverly Hills
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.geographicCoordinates -- Indicates the geographic coordinates. example: geographicCoordinates
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.postalCode -- This is the Postal code.This is Optional for non postal-aware countries.Maximum length is 10.Example: 65247click here to see Postal aware countries
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.stateOrProvinceCode -- This is a placeholder for State or Province code.Example: CA.click here to see State or Province Code
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.streetLines -- This is the combination of number, street name, etc. Maximum length per line is 35.Example: 10 FedEx Parkway, Suite 302.Note:At least one line is required.Streetlines more than 3 will be ignored.Empty lines should not be includedFor SmartPost Shipments, only 30 characters from the individual street lines will be printed on the labels.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact --
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.companyName -- Specify contact company name.Recommended length is 35.Note: There's no specific validation of the company name.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.faxNumber -- Specify contact person's fax number. Maximum length is 15.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.personName -- Specify contact name. Maximum length is 70. Example: John Taylor
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.phoneExtension -- Specify contact phone extension. Maximum length is 6. Example: 1234
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.phoneNumber -- Specify contact phone number. Minimum length is 10 and supports Maximum as 15 for certain countries using longer phone numbers. Note: Recommended Maximum length is 15 and there's no specific validation will be done for the phone number. Example: 918xxxxx890
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins -- This is the tax identification number details.
.requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producerSpecification -- This is producer specification.
.requestedShipment.smartPostInfoDetail --
.requestedShipment.smartPostInfoDetail.ancillaryEndorsement -- Indicate the type of ancillary endorsement. Is required for Presorted Standard but not for returns or parcel select. Note: Not all are usable for all ancillary endorsements.For more information, refer to the FedEx SmartPost®.
.requestedShipment.smartPostInfoDetail.hubId -- Specify the four-digit numeric Hub ID value used for smartport shipments.click here to see Hub Ids
.requestedShipment.smartPostInfoDetail.indicia -- Specify the indicia type.Available options include:MEDIA_MAILPARCEL_SELECT (1 LB through 70 LB)PRESORTED_BOUND_PRINTED_MATTERPRESORTED_STANDARD (less than 1 LB)PARCEL_RETURN
.requestedShipment.smartPostInfoDetail.specialServices -- Specify the special handling associated with Smartpost Shipment.
.requestedShipment.soldTo -- Will indicate the party responsible for purchasing the goods shipped from the shipper to the recipient. The sold to party is not necessarily the recipient or the importer of record. The sold to party is relevant when the purchaser, rather than the recipient determines when certain customs regulations apply.
.requestedShipment.soldTo.accountNumber -- Identification of a specific FedEx customer account.
.requestedShipment.soldTo.address --
.requestedShipment.soldTo.address.city -- The name of city, town of the recipient.Max length is 35.Example: Beverly Hills
.requestedShipment.soldTo.address.countryCode -- This is the two-letter country code.Maximum length is 2.Example: USclick here to see Country codes
.requestedShipment.soldTo.address.postalCode -- This is the postal code.Note: This is Optional for non postal-aware countries. Maximum length is 10.Example: 65247click here to see Postal aware countries
.requestedShipment.soldTo.address.residential -- Indicate whether this address is residential (as opposed to commercial).
.requestedShipment.soldTo.address.stateOrProvinceCode -- This is a placeholder for state or province code.Example: CA.click here to see State or Province Code
.requestedShipment.soldTo.address.streetLines -- This is the combination of number, street name, etc. Maximum length per line is 35.Example: 10 FedEx Parkway, Suite 302.Note:At least one line is required.Streetlines more than 3 will be ignored.Empty lines should not be includedFor SmartPost Shipments, only 30 characters from the individual street lines will be printed on the labels.
.requestedShipment.soldTo.contact --
.requestedShipment.soldTo.contact.companyName -- Specify contact company name. Maximum length is 35. Note: Either the companyName or personName is mandatory.
.requestedShipment.soldTo.contact.emailAddress -- Specify contact email address. Maximum length is 80. Example: sample@company.com
.requestedShipment.soldTo.contact.personName -- Specify contact name. Maximum length is 70. Note: Either the companyName or personName is mandatory. Example: John Taylor
.requestedShipment.soldTo.contact.phoneExtension -- Specify contact phone extension. Maximum length is 6. Example: 1234
.requestedShipment.soldTo.contact.phoneNumber -- The shipper's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.Example: 918xxxxx890
.requestedShipment.soldTo.tins -- Used for adding the tax id
.requestedShipment.totalDeclaredValue -- It is the sum of all declared values of all packages in a shipment. The amount of totalDeclaredValue must be equal to the sum of all the individual declaredValues in the shipment. The declaredValue and totalDeclaredValue must match in all currencies in one shipment. This value represents FedEx maximum liability associated with a shipment. This is including, but not limited to any loss, damage, delay, misdelivery, any failure to provide information, or misdelivery of information related to the Shipment.Note: The totalDeclaredValue should not exceed customsValue.
.requestedShipment.totalDeclaredValue.amount -- This is the amount. Maximum limit is 5 digits before decimal.Example: 12.45
.requestedShipment.totalDeclaredValue.currency -- This is the currency code for the amount.Example: USDClick here to see Currency codes
.requestedShipment.totalPackageCount -- For an MPS, this is the total number of packages in the shipment.Applicable for parent shipment for one label at a time shipments. Example: 25
.requestedShipment.totalWeight -- Indicate the shipment total weight in pounds.Example: 10.6Note: This only applies to International shipments and should be used on the first package of a multiple piece shipment.This value contains 1 explicit decimal position.For one Label at a time shipments, the unit of totalWeight is considered same as the unit of weight provided in requestedPackageLineItem field.
.requestedShipment.variableHandlingChargeDetail --
.requestedShipment.variableHandlingChargeDetail.fixedValue -- This is to specify a fixed handling charge on the shipment. The element allows entry of 7 characters before the decimal and 2 characters following the decimal. Example: 5.00.
.requestedShipment.variableHandlingChargeDetail.fixedValue.amount -- This is the amount. Maximum limit is 5 digits before decimal.Example: 12.45
.requestedShipment.variableHandlingChargeDetail.fixedValue.currency -- This is the currency code for the amount.Example: USDClick here to see Currency codes
.requestedShipment.variableHandlingChargeDetail.percentValue -- This is the variable handling percentage. If the percent value is mentioned as 10, it means 10%(multiplier of 0.1).Example: 12.45
.requestedShipment.variableHandlingChargeDetail.rateElementBasis -- Specify the charge type upon which the variable handling percentage amount is calculated.
.requestedShipment.variableHandlingChargeDetail.rateLevelType -- Specifies if the rate level type is either Individual or Bundled.
.requestedShipment.variableHandlingChargeDetail.rateType -- This is the rate type used for this package.