FedEx API Parameters

The official carrier openapi docs can be a little difficult to navigate. Below is flat list of all parameters:

Rating

Rate and Transit Times

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is the Account number details.<br><i>Note:<ul><li>If the paymentType is Sender, then the account number is optional in shippingChargesPayment.</li><li>In case if this is shipping account numbe...
accountNumber.value -- Type: string | Example: Your account number | This is the account number. Maximum Length is 9. <br>Example: Your account number
carrierCodes -- Type: array | Example: ['FDXE'] | Specify the four letter code of a FedEx operating company that meets your requirements.<br>Examples of FedEx Operating Companies are:<ul><li>FDXE - FedEx Express</li><li>FDXG - FedEx Ground</li><li...
carrierCodes[] -- Type: string
rateRequestControlParameters -- Type: object | Specify the return transit times, services needed on rate failure, choice of variable option and order to sort rate options to filter and sort the expected response.
rateRequestControlParameters.rateSortOrder -- Type: string | Valid values: COMMITASCENDING, SERVICENAMETRADITIONAL, COMMITDESCENDING | Example: SERVICENAMETRADITIONAL | This is a sort order you can specify to control the order of the response data: <br> Example: <ul><li>SERVICENAMETRADITIONAL - data in order of highest to lowest service (Default)</li><li>COMMITASC...
rateRequestControlParameters.returnTransitTimes -- Type: boolean | Indicate if the transit time and commit data are to be returned in the reply. Default value is false.<br>Valid values are TRUE and FALSE.
rateRequestControlParameters.servicesNeededOnRateFailure -- Type: boolean | Example: True | Specify the services to be requested if the rate data is not available.<br>Valid values are TRUE and FALSE.
rateRequestControlParameters.variableOptions -- Type: string | Valid values: SATURDAY_DELIVERY, FREIGHT_GUARANTEE, SMART_POST_ALLOWED_INDICIA, SMARTPOST_HUB_ID | Example: FREIGHT_GUARANTEE | Specify service options whose combinations are to be considered when replying with available services.
requestedShipment -- Type: object | This is shipment data for which a rate quote (or rate-shipping comparison) is requested.
requestedShipment.customsClearanceDetail -- Type: object | This is Customs clearance data associated with the shipment. This is used for both international and intra-country shipping and rating. Customs commodity data is required for international and intr...
requestedShipment.customsClearanceDetail.commercialInvoice -- Type: object | The Commercial Invoice element is required for electronic upload of CI data. It will serve to create/transmit an electronic Commercial Invoice through the FedEx system.<br>Customers are responsible...
requestedShipment.customsClearanceDetail.commercialInvoice.shipmentPurpose -- Type: string | Valid values: GIFT, NOT_SOLD, PERSONAL_EFFECTS, REPAIR_AND_RETURN, SAMPLE, SOLD, COMMERCIAL, RETURN_AND_REPAIR, PERSONAL_USE | Example: GIFT | The reason for the shipment.  Note: SOLD is not a valid purpose for a Proforma Invoice.
requestedShipment.customsClearanceDetail.commodities -- Type: array | Specify the commodity details.
requestedShipment.customsClearanceDetail.commodities[] -- Type: object
requestedShipment.customsClearanceDetail.commodities[].countryOfManufacture -- Type: string | Example: US | This is a manufacturing country. Maximum field Length is 4<br> Example: IN
requestedShipment.customsClearanceDetail.commodities[].customsValue -- Type: object | Example: {'amount': '100', 'currency': 'USD'} | Specify the required Customs value for this commodity. Indicate the amount details. This is optional, but if indicated, amount and currency must be provided.
requestedShipment.customsClearanceDetail.commodities[].customsValue.amount -- Type: number | Format: double | Example: 12.45 | Indicate the amount. Indicates the declared amount value for the shipment.
requestedShipment.customsClearanceDetail.commodities[].customsValue.currency -- Type: string | Example: USD | Indicate the three-character ISO currency code. <br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency Codes</a> Indicates the currency associated with the am...
requestedShipment.customsClearanceDetail.commodities[].description -- Type: string | Example: DOCUMENTS | Indicate the description of the dutiable packages.<br> Maximum Length is 450. <br> Example: DOCUMENTS <br><a onclick='loadDocReference("vaguecommoditydescriptions")'>Click here to see Vague commodi...
requestedShipment.customsClearanceDetail.commodities[].harmonizedCode -- Type: string | Example: 080211 | This is to specify the Harmonized Tariff System (HTS) code to meet U.S. and foreign governments' customs requirements. These are mainly used to estimate the duties and taxes.<br>Example: A six digi...
requestedShipment.customsClearanceDetail.commodities[].name -- Type: string | Example: DOCUMENTS | Indicate the Commodity name<br>Example: DOCUMENTS
requestedShipment.customsClearanceDetail.commodities[].numberOfPieces -- Type: integer | Format: int32 | Example: 1 | Specifies the number of pieces for this commodity.<br>Example: 10
requestedShipment.customsClearanceDetail.commodities[].partNumber -- Type: string | Example: P1 | Specify the part number if any. Example: P1
requestedShipment.customsClearanceDetail.commodities[].quantity -- Type: integer | Format: int32 | Example: 1 | Specify the total number of units (using quantityUnits as the unit of measure) of this commodity present in the shipment. This element is used to estimate duties and taxes. <br>Example: 1
requestedShipment.customsClearanceDetail.commodities[].quantityUnits -- Type: string | Example: PCS | Indicate quantiy unit used. Used to estimate duties and taxes <br> Example: PCS<br><a onclick='loadDocReference("harmonizedsystemcodeunitofmeasure-table1")'>click here to see Commodity Unit Measure...
requestedShipment.customsClearanceDetail.commodities[].unitPrice -- Type: object | Example: {'amount': '100', 'currency': 'USD'} | Indicate the amount details. This is optional, but if indicated, amount and currency must be provided. Specifies the unit price of the commodity.
requestedShipment.customsClearanceDetail.commodities[].unitPrice.amount -- Type: number | Format: double | Example: 12.45 | Indicate the amount. Indicates the declared amount value for the shipment.
requestedShipment.customsClearanceDetail.commodities[].unitPrice.currency -- Type: string | Example: USD | Indicate the three-character ISO currency code. <br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency Codes</a> Indicates the currency associated with the am...
requestedShipment.customsClearanceDetail.commodities[].weight -- Type: object | Example: {'units': 'LB', 'value': 10} | Specify the Total weight of this commodity. This element is used to estimate duties and taxes. These are the weight details.
requestedShipment.customsClearanceDetail.commodities[].weight.units -- Type: string | Valid values: KG, LB | Example: LB | Specifies the package weight unit. For Dry Ice the unit of measure is KG.
requestedShipment.customsClearanceDetail.commodities[].weight.value -- Type: number | Format: double | Example: 10 | Specifies the package weight.<br> Example: 68.25
requestedShipment.customsClearanceDetail.dutiesPayment -- Type: object | Example: {'payor': {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'parsedPersonName': {'firstName': 'first name', 'lastName': 'last name', 'middleName': 'middle name', 'suffix': 'suffix'}, 'phoneNumber': '1234567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': '123456789'}}}, 'paymentType': 'SENDER'} | These are details about shipment payment. Value payor is optional when paymentType provided as SENDER.
requestedShipment.customsClearanceDetail.dutiesPayment.paymentType -- Type: string | Valid values: SENDER | Indicate the payment Type. Applicable for Express and Ground rates.
requestedShipment.customsClearanceDetail.dutiesPayment.payor -- Type: object | Example: {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'accountNumber': {'value': 'This is the account number. Maximum Length is 9. <br>Example: Your account number'}}} | This is payer Information responsible for paying for the shipment.<br>Note: Optional when paymentType is SENDER.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty -- Type: object | Example: {'accountNumber': {'value': 123456789}} | These are payer details such as address, account and contacts. Indicate the party to a transaction including the physical address, contact information and account number information.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is the Account number details.<br><i>Note:<ul><li>If the paymentType is Sender, then the account number is optional in shippingChargesPayment.</li><li>In case if this is shipping account numbe...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.accountNumber.value -- Type: string | Example: Your account number | This is the account number. Maximum Length is 9. <br>Example: Your account number
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address -- Type: object | Example: {'streetLines': ['1550 Union Blvd', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'TN', 'postalCode': '38127', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.countryCode -- Type: string | Example: US | This is the two-letter country code. Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.postalCode -- Type: string | Example: 65247 | Indicate the Postal code. This is optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.stateOrProvinceCode -- Type: string | Example: TN | This is a placeholder for State or Province code. <br> Example: CA <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State Or Province Code</a>
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'parsedPersonName': {'firstName': 'firstName', 'lastName': 'lastName', 'middleName': 'middleName', 'suffix': 'suffix'}, 'phoneNumber': '1234567890', 'phoneExtension': '1234', 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.faxNumber -- Type: string | Example: 1234567890 | Specify contact fax number. Maximum length is 15. <br> Example: 1234567890
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.parsedPersonName -- Type: object | Example: {'firstName': 'John', 'lastName': 'Mayor', 'middleName': 'Redmond', 'suffix': 'Jr'} | This object is used to separate the person name into first and last name.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.parsedPersonName.firstName -- Type: string | Example: firstName | Specify the First Name. Maximum Length is 35. <br> Example: John
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.parsedPersonName.lastName -- Type: string | Example: lastName | Specify the Last Name. Maximum Length is 35. <br> Example: Mayor
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.parsedPersonName.middleName -- Type: string | Example: middleName | Specify the Middle Name.<br> Example: Redmond
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.parsedPersonName.suffix -- Type: string | Example: suffix | Specify the Suffix.<br> Example: Jr
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.personName -- Type: string | Example: John Taylor | Specify contact name.<br>Note: Recommended Length is 70. There's no specific validation for the length.<br> Example: John Taylor
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.phoneExtension -- Type: string | Example: 1234 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. Maximum length is 15. <br> Example: 1234567890
requestedShipment.customsClearanceDetail.freightOnValue -- Type: string | Valid values: CARRIER_RISK, OWN_RISK | Example: CARRIER_RISK | Indicates Freight on value for customs.
requestedShipment.documentShipment -- Type: boolean | Indicate whether or not its a document Shipment.
requestedShipment.edtRequestType -- Type: string | Valid values: ALL, NONE | Example: ALL | edtRequestType is a optional field used to request estimated duties and taxes related information. Default value for edtRequestType would be NONE when user does not provide a value.
requestedShipment.emailNotificationDetail -- Type: object | Object to specify email details for shipment notifications.
requestedShipment.emailNotificationDetail.PrintedReference -- Type: object | Specifies Printed Reference.
requestedShipment.emailNotificationDetail.PrintedReference.printedReferenceType -- Type: string | Valid values: BILL_OF_LADING, CONSIGNEE_ID_NUMBER, INTERLINE_PRO_NUMBER, PO_NUMBER, SHIPPER_ID_NUMBER, SHIPPER_ID1_NUMBER, SHIPPER_ID2_NUMBER | Indicates the printed reference type.
requestedShipment.emailNotificationDetail.PrintedReference.value -- Type: string | Specifies printed reference value.
requestedShipment.emailNotificationDetail.personalMessage -- Type: string | Indicates the personal message to be added with the notification.
requestedShipment.emailNotificationDetail.recipients -- Type: array | The list of recipients for shipment notifications.
requestedShipment.emailNotificationDetail.recipients[] -- Type: object | Data specifying the recipient(s) of notifications related to the movement of the shipment. At a minimnum an EmailnotificationRecipientType, at least one NoficationEventType, and an EmailAddress are...
requestedShipment.emailNotificationDetail.recipients[].emailAddress -- Type: string | Identifies the email address associated with this contact.
requestedShipment.emailNotificationDetail.recipients[].emailNotificationRecipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Required Email Notification Recipient Type.
requestedShipment.emailNotificationDetail.recipients[].locale -- Type: string | Specify the locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>Click here to see the list of available locales<br></a><br>Note: If the locale is left blank or an invali...
requestedShipment.emailNotificationDetail.recipients[].notificationEventType -- Type: array | Specifies notification event type.
requestedShipment.emailNotificationDetail.recipients[].notificationEventType[] -- Type: string | Valid values: ON_DELIVERY, ON_EXCEPTION, ON_SHIPMENT, ON_TENDER, ON_ESTIMATED_DELIVERY, ON_PICKUP, ON_LABEL, ON_BILL_OF_LADING
requestedShipment.emailNotificationDetail.recipients[].notificationFormatType -- Type: string | Valid values: HTML, TEXT | Specifies Notification Format Type.
requestedShipment.emailNotificationDetail.recipients[].notificationType -- Type: string | Valid values: EMAIL, SMS_TEXT_MESSAGE | Specifies the type of the notification received.
requestedShipment.emailNotificationDetail.recipients[].smsDetail -- Type: object | Specifies the SMS notification details.<br>Conditionally required for SMS notifications.
requestedShipment.emailNotificationDetail.recipients[].smsDetail.phoneNumber -- Type: string
requestedShipment.emailNotificationDetail.recipients[].smsDetail.phoneNumberCountryCode -- Type: string
requestedShipment.expressFreightDetail -- Type: object | Conditional" Details specific to a FedEx Express Freight® shipment (i.e. FedEx First Freight, FedEx 1Day, 2Day, and 3Day Freight).
requestedShipment.expressFreightDetail.bookingConfirmationNumber -- Type: string | An advance booking number is optional for FedEx 1Day Freight. When you call 1.800.332.0807 to book your freight shipment, you will receive a booking number. This booking number is included in the S...
requestedShipment.expressFreightDetail.shippersLoadAndCount -- Type: integer | Format: int32 | Describes the shippers loaded total package counts.
requestedShipment.groundShipment -- Type: boolean | If set to 'true', indicates it is a Ground shipment.<br> Example: 'false'
requestedShipment.groupShipment -- Type: boolean | Example: True
requestedShipment.packagingType -- Type: string | Example: YOUR_PACKAGING | This is the Packaging type associated with this rate. For Ground/SmartPost,it  will always be YOUR_PACKAGING. For domestic Express, the packaging may have been bumped so it may not match the value ...
requestedShipment.pickupDetail -- Type: object | This class describes the pickup characteristics of a shipment (e.g. for use in a tag/ship request). Not used in RATE request.
requestedShipment.pickupDetail.buildingPart -- Type: string | Valid values: APARTMENT, BUILDING, DEPARTMENT, FLOOR, ROOM, SUITE | Specifies Building Part.
requestedShipment.pickupDetail.buildingPartDescription -- Type: string | Specifies Building Part Description.
requestedShipment.pickupDetail.companyCloseTime -- Type: string | Company Close Time
requestedShipment.pickupDetail.courierInstructions -- Type: string | Specifies any courier instructions.
requestedShipment.pickupDetail.earlyPickup -- Type: boolean | Indicates if it is an early pickup. This applies only to Europe.
requestedShipment.pickupDetail.geographicalPostalCode -- Type: string | Geographical PostalCode
requestedShipment.pickupDetail.latestPickupDateTime -- Type: string | Specify the last possible pickup time and date.
requestedShipment.pickupDetail.packageLocation -- Type: string | Specify the last possible pickup location.
requestedShipment.pickupDetail.pickupOrigin -- Type: object | Example: {'accountNumber': {'value': 123456789}} | Indicate the party to a transaction including the physical address, contact information and account number information.
requestedShipment.pickupDetail.pickupOrigin.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is the Account number details.<br><i>Note:<ul><li>If the paymentType is Sender, then the account number is optional in shippingChargesPayment.</li><li>In case if this is shipping account numbe...
requestedShipment.pickupDetail.pickupOrigin.accountNumber.value -- Type: string | Example: Your account number | This is the account number. Maximum Length is 9. <br>Example: Your account number
requestedShipment.pickupDetail.pickupOrigin.address -- Type: object | Example: {'streetLines': ['1550 Union Blvd', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'TN', 'postalCode': '38127', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.pickupDetail.pickupOrigin.address.addressVerificationId -- Type: string
requestedShipment.pickupDetail.pickupOrigin.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.pickupDetail.pickupOrigin.address.countryCode -- Type: string | Example: US | This is the two-letter country code. Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.pickupDetail.pickupOrigin.address.postalCode -- Type: string | Example: 65247 | Indicate the Postal code. This is optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal...
requestedShipment.pickupDetail.pickupOrigin.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.pickupDetail.pickupOrigin.address.stateOrProvinceCode -- Type: string | Example: TN | This is a placeholder for State or Province code. <br> Example: CA <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State Or Province Code</a>
requestedShipment.pickupDetail.pickupOrigin.address.streetLines -- Type: array | Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included. Maximum Length is 35.
requestedShipment.pickupDetail.pickupOrigin.address.streetLines[] -- Type: string
requestedShipment.pickupDetail.pickupOrigin.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'parsedPersonName': {'firstName': 'firstName', 'lastName': 'lastName', 'middleName': 'middleName', 'suffix': 'suffix'}, 'phoneNumber': '1234567890', 'phoneExtension': '1234', 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details.
requestedShipment.pickupDetail.pickupOrigin.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. Identifies the company this contact is associated with. Maximum length is 35.
requestedShipment.pickupDetail.pickupOrigin.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.pickupDetail.pickupOrigin.contact.faxNumber -- Type: string | Example: 1234567890 | Specify contact fax number. Maximum length is 15. <br> Example: 1234567890 Identifies the fax number associated with this contact. Maximum length is 15.
requestedShipment.pickupDetail.pickupOrigin.contact.parsedPersonName -- Type: object | Example: {'firstName': 'John', 'lastName': 'Mayor', 'middleName': 'Redmond', 'suffix': 'Jr'} | This object is used to separate the person name into first and last name.
requestedShipment.pickupDetail.pickupOrigin.contact.parsedPersonName.firstName -- Type: string | Example: firstName | Specify the First Name. Maximum Length is 35. <br> Example: John
requestedShipment.pickupDetail.pickupOrigin.contact.parsedPersonName.lastName -- Type: string | Example: lastName | Specify the Last Name. Maximum Length is 35. <br> Example: Mayor
requestedShipment.pickupDetail.pickupOrigin.contact.parsedPersonName.middleName -- Type: string | Example: middleName | Specify the Middle Name.<br> Example: Redmond
requestedShipment.pickupDetail.pickupOrigin.contact.parsedPersonName.suffix -- Type: string | Example: suffix | Specify the Suffix.<br> Example: Jr
requestedShipment.pickupDetail.pickupOrigin.contact.personName -- Type: string | Example: John Taylor | Specify contact name.<br>Note: Recommended Length is 70. There's no specific validation for the length.<br> Example: John Taylor Identifies the contact person's name. Maximum Length is 70.
requestedShipment.pickupDetail.pickupOrigin.contact.phoneExtension -- Type: string | Example: 1234 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.pickupDetail.pickupOrigin.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. Maximum length is 15. <br> Example: 1234567890 Identifies the phone number associated with this contact. Maximum length is 15.
requestedShipment.pickupDetail.readyPickupDateTime -- Type: string | Indicates the date and time when the shipment/package is ready for pick up.
requestedShipment.pickupDetail.requestType -- Type: string | Valid values: FUTURE_DAY, SAME_DAY | Specify the request type.
requestedShipment.pickupType -- Type: string | Valid values: CONTACT_FEDEX_TO_SCHEDULE, DROPOFF_AT_FEDEX_LOCATION, USE_SCHEDULED_PICKUP | Example: DROPOFF_AT_FEDEX_LOCATION | Indicate the pickup type method by which the shipment to be tendered to FedEx.<br><a onclick='loadDocReference("pickuptypes")'>Click here for more information on Pickup Types.</a>
requestedShipment.preferredCurrency -- Type: string | Example: USD | Indicate the currency the caller requests to have used in all returned monetary values (when a choice is possible). Used in conjunction with the rateRequestType data element. This element is used t...
requestedShipment.rateRequestType -- Type: array | Example: ['ACCOUNT', 'LIST'] | Indicate the type of rates to be returned.<br>Following are values:<ul><li>LIST - Returns FedEx published list rates in addition to account-specific rates (if applicable).</li><li>PREFERRED - Retur...
requestedShipment.rateRequestType[] -- Type: string | Valid values: LIST, INCENTIVE, ACCOUNT, PREFERRED | Specifies the items.
requestedShipment.recipient -- Type: object | Indicate the descriptive data for the recipient location to which the shipment is to be received. Specify the shipper address details.
requestedShipment.recipient.address -- Type: object | Example: {'streetLines': ['1550 Union Blvd', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'TN', 'postalCode': '38127', 'countryCode': 'US', 'residential': False} | Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (such as a ci...
requestedShipment.recipient.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.recipient.address.countryCode -- Type: string | Example: US | This is the two-letter country code. Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.recipient.address.postalCode -- Type: string | Example: 65247 | Indicate the Postal code. This is optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal...
requestedShipment.recipient.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.recipient.address.stateOrProvinceCode -- Type: string | Example: TN | This is a placeholder for State or Province code. <br> Example: CA <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State Or Province Code</a>
requestedShipment.requestedPackageLineItems -- Type: array | 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...
requestedShipment.requestedPackageLineItems[] -- Type: object
requestedShipment.requestedPackageLineItems[].contentRecord -- Type: array | Specifies the content record.
requestedShipment.requestedPackageLineItems[].contentRecord[] -- Type: object | Specifies the details of the content of the package.
requestedShipment.requestedPackageLineItems[].contentRecord[].description -- Type: string | Specifies description for the content record.
requestedShipment.requestedPackageLineItems[].contentRecord[].itemNumber -- Type: string | Specifies Item Number.
requestedShipment.requestedPackageLineItems[].contentRecord[].partNumber -- Type: string | Specifies Part Number.
requestedShipment.requestedPackageLineItems[].contentRecord[].receivedQuantity -- Type: integer | Format: int32 | Specifies Received Quantity.
requestedShipment.requestedPackageLineItems[].declaredValue -- Type: object | Example: {'amount': '100', 'currency': 'USD'} | This is the Declared Value - represents FedEx Maximum liability in connection with a shipment of that Package, including but not limited to, any loss, damage, delay, misdelivery, any failure to pro...
requestedShipment.requestedPackageLineItems[].declaredValue.amount -- Type: number | Format: double | Example: 12.45 | Indicate the amount. Indicates the declared amount value for the shipment.
requestedShipment.requestedPackageLineItems[].declaredValue.currency -- Type: string | Example: USD | Indicate the three-character ISO currency code. <br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency Codes</a> Indicates the currency associated with the am...
requestedShipment.requestedPackageLineItems[].dimensions -- Type: object | Example: {'length': 100, 'width': 50, 'height': 30, 'units': 'CM'} | Specify the dimensions of this package and the unit type used for the measurements. Valid measurements are whole numbers greater than zero. Indicate the dimensions of the package.<br> Following con...
requestedShipment.requestedPackageLineItems[].dimensions.height -- Type: integer | Format: int32 | Example: 30 | Indicate the height of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].dimensions.length -- Type: integer | Format: int32 | Example: 100 | Indicate the length of the package. No implied decimal places. Maximum value: 999 <br> Example: 20
requestedShipment.requestedPackageLineItems[].dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Indicate the unit of measure for the provided dimensions.<br>Valid Values are:<ul><li>IN - Inches</li><li>CM - Centimeters</li></ul>
requestedShipment.requestedPackageLineItems[].dimensions.width -- Type: integer | Format: int32 | Example: 50 | Indicate the width of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].groupPackageCount -- Type: integer | Format: int32 | Example: 1 | Indicate the grouped package count. These are number of identical package(s) each with one or more commodities. <br> Example: 2
requestedShipment.requestedPackageLineItems[].packageSpecialServices -- Type: object | These special services are available at the package level for some or all service types.  Indicated if rate data is being requested for the special services. These special services are available at...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail -- Type: object | Indicate the alcohol shipment details. This object is mandatory if alcohol special service is selected.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.alcoholRecipientType -- Type: string | Valid values: LICENSEE, CONSUMER | Specify the recipient type for the alcohol shipment.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.shipperAgreementType -- Type: string | Example: Retailer | Specify the shipper entity type. <br>Example: Fulfillment house, Retailer or a Winery.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails -- Type: array | Specify the details about the batteries or cells that are contained within this specific package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[] -- Type: object | Describe the attributes of a battery or cell that are used for classification purposes. Typically this structure would be used to allow customers to declare batteries or cells for which full danger...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].material -- Type: string | Valid values: LITHIUM_METAL, LITHIUM_ION | Specify the material composition of the battery or cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].packing -- Type: string | Valid values: CONTAINED_IN_EQUIPMENT, PACKED_WITH_EQUIPMENT | Indicate the packing arrangement of the battery or cell with respect to other items within the same package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].regulatorySubType -- Type: string | Valid values: IATA_SECTION_II | Specify the regulation specific classification for the battery or cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail -- Type: object | Use this object to specify Dangerous Goods shipment Detail.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.accessibility -- Type: string | Valid values: ACCESSIBLE, INACCESSIBLE | Indicate the Dangerous Goods Accessibility Type.<br> Inaccessible means it does not have to be accessible on the aircraft.  Accessible means it must be fully accessible on the aircraft, and is more...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers -- Type: array | Indicate one or more containers used to pack dangerous goods commodities.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[] -- Type: object | Dangerous Goods Container
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].containerType -- Type: string | Example: Copper Box | Indicate the type of container.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].emergencyContactNumber -- Type: object | Indicates the telephone number to use for contact in the event of an emergency.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].emergencyContactNumber.areaCode -- Type: string | Example: 202 | Indicates the area code.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].emergencyContactNumber.countryCode -- Type: string | Example: US | The two-letter code used to identify a country.<br>Example: US
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].emergencyContactNumber.extension -- Type: string | Example: 3245 | Indicates the Extension.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].emergencyContactNumber.localNumber -- Type: string | Example: 23456 | Telephone number to use for contact in the event of an emergency.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].emergencyContactNumber.personalIdentificationNumber -- Type: string | Example: 9545678 | Indicates the Personal Identification Number.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities -- Type: array | Specify the kinds and quantities of all hazardous commodities in the current container.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[] -- Type: object | Documents the kind and quantity of an individual hazardous commodity in a package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description -- Type: object | Identifies and describes an individual hazardous commodity.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.authorization -- Type: string | Example: Authorization Information | Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.hazardClass -- Type: string | Example: hazardClass | Specify hazard class for commodity.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.id -- Type: string | Example: ID | Specifies the ID of label text.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.labelText -- Type: string | Example: labelText | Specifies the DOT diamond hazard label type. This element can also include limited quantity or exemption number.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.packingDetails -- Type: object | Specifies documentation and limits for validation of an individual packing group/category.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.packingDetails.cargoAircraftOnly -- Type: boolean | Indicates the shipment is packaged/documented for movement ONLY on cargo aircraft.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.packingDetails.packingInstructions -- Type: string | Example: instruction | Indicates the coded specification for how commodity is to be packed.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.packingGroup -- Type: string | Valid values: DEFAULT, I, II, III | Identifies IATA packing group for a hazardous commodity.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.percentage -- Type: number | Format: double | Example: 10 | Indicates the percentage.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.processingOptions -- Type: array | Indicates any special processing options to be applied to the description of the dangerous goods commodity.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.processingOptions[] -- Type: string | Valid values: INCLUDE_SPECIAL_PROVISIONS
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.properShippingName -- Type: string | Example: ShippingName | The proper shipping name as defined by the regulation.<br>The name can also include qualifying words.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.reportableQuantity -- Type: boolean | The element specifies the reportable quantity of the hazardous material.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.sequenceNumber -- Type: integer | Format: int32 | In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.subsidiaryClasses -- Type: array | Example: subsidiaryClass | Specifies the hazardous material subsidiary classes.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.subsidiaryClasses[] -- Type: string
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].description.technicalName -- Type: string | Example: technicalName | Specify the technical name for the hazardous commodity.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].innerReceptacles -- Type: array | Specifies the inner receptacles within the container.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].innerReceptacles[] -- Type: object | This describes information about the inner receptacles for the hazardous commodity in a particular dangerous goods container.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].innerReceptacles[].quantity -- Type: object | Specifies Hazardous Commodity Quantity Detail.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].innerReceptacles[].quantity.amount -- Type: number | Format: double | Specifies amount details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].innerReceptacles[].quantity.quantityType -- Type: string | Valid values: GROSS, NET | Specifies type of a quantity unit.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].innerReceptacles[].quantity.units -- Type: string | Example: LB | Specify unit details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].options -- Type: object | Customer-provided specifications for handling individual commodities.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].options.customerSuppliedLabelText -- Type: string | Example: LabelText | Text used in labeling the commodity under control of the labelTextOption field.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].options.labelTextOption -- Type: string | Valid values: APPEND, OVERRIDE, STANDARD | Example: Override | Specifies how the customer wishes the label text to be handled for this commodity in this package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].quantity -- Type: object | Specifies Hazardous Commodity Quantity Detail.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].quantity.amount -- Type: number | Format: double | Specifies amount details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].quantity.quantityType -- Type: string | Valid values: GROSS, NET | Specifies type of a quantity unit.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].hazardousCommodities[].quantity.units -- Type: string | Example: LB | Specify unit details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].numberOfContainers -- Type: integer | Format: int32 | Example: 10 | Indicate the number of containers.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].offeror -- Type: string | Example: Offeror Name | Specify the shipper name(offeror) or contact number. Required on all shipping papers.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].packaging -- Type: object | Identifies number and type of packaging units for hazardous commodities.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].packaging.count -- Type: integer | Format: int32 | Example: 20 | Indicate the number and type of packaging units for dangerous goods.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].packaging.units -- Type: string | Example: Liter | Specify the unit of the package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].packingType -- Type: string | Valid values: ALL_PACKED_IN_ONE | Indicate the packing type used.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.containers[].radioactiveContainerClass -- Type: string | Valid values: EXCEPTED_PACKAGE, INDUSTRIAL_IP1, INDUSTRIAL_IP2, INDUSTRIAL_IP3, TYPE_A, TYPE_B_M, TYPE_B_U, TYPE_C | Indicate the packaging type of the container used to package the radioactive materials.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.emergencyContactNumber -- Type: string | Example: 3268545905 | Indicate the emergency telephone/contact number.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.offeror -- Type: string | Example: Offeror Name | Indicate the Offeror's name or contract number, per DOT regulation.<br>Example: John Smith
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options -- Type: array | Example: ['BATTERY'] | Specify the special handling requested for the package.<br> Example: BATTERY
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options[] -- Type: string | Valid values: HAZARDOUS_MATERIALS, BATTERY, ORM_D, REPORTABLE_QUANTITIES, SMALL_QUANTITY_EXCEPTION, LIMITED_QUANTITIES_COMMODITIES
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.packaging -- Type: object | Identifies number and type of packaging units for hazardous commodities.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.packaging.count -- Type: integer | Format: int32 | Example: 20 | Indicate the number and type of packaging units for dangerous goods.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.packaging.units -- Type: string | Example: Liter | Specify the unit of the package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight -- Type: object | Example: {'units': 'LB', 'value': 10} | These are the weight details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.units -- Type: string | Valid values: KG, LB | Example: LB | Specifies the package weight unit. For Dry Ice the unit of measure is KG.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.value -- Type: number | Format: double | Example: 10 | Specifies the package weight.<br> Example: 68.25
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail -- Type: object | Indicates package COD Detail.  COD main information is set in shipment level.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount -- Type: object | Indicate the amount details. This is optional, but if indicated, amount and currency must be provided.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | Indicate the amount.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount.currency -- Type: string | Example: USD | Indicate the three-character ISO currency code. <br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency Codes</a>
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionType -- Type: string | Valid values: ANY, CASH, COMPANY_CHECK, GUARANTEED_FUNDS, PERSONAL_CHECK | Indicate the type of funds FedEx should collect upon shipment delivery. <br> Conditionally required for Ground COD rates
requestedShipment.requestedPackageLineItems[].packageSpecialServices.pieceCountVerificationBoxCount -- Type: integer | Format: int32 | Indicate the box count used for piece count verification.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionType -- Type: string | Valid values: SERVICE_DEFAULT, NO_SIGNATURE_REQUIRED, INDIRECT, DIRECT, ADULT | Example: ['NO_SIGNATURE_REQUIRED'] | Type of a Signature Option.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes -- Type: array | Example: ['DANGEROUS_GOODS'] | Indicate the special services  requested.<br><a onclick='loadDocReference("packagelevelspecialservicetypes")'>Click here to see Package level Special Service Types</a>
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes[] -- Type: string | Specifies the items.
requestedShipment.requestedPackageLineItems[].subPackagingType -- Type: string | Example: BAG | This is a physical packaging type used for the package. <br><a onclick='loadDocReference("subpackagetypes")'>Click here to see sub-packaging types</a><br>For more information on physical packaging ...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail -- Type: object | Indicate the details on how to calculate variable handling charges at the package level. If indicated, element rateLevelType is required.
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue -- Type: object | Example: {'amount': '100', 'currency': 'USD'} | Indicate the Fixed value. <br>If you choose FIXED_AMOUNT as the ChargeType, this element allows you to enter the fixed value of the handling charge. The element allows entry of 7 characters before ...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue.amount -- Type: number | Format: double | Example: 12.45 | Indicate the amount. Indicates the declared amount value for the shipment.
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue.currency -- Type: string | Example: USD | Indicate the three-character ISO currency code. <br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency Codes</a> Indicates the currency associated with the am...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.percentValue -- Type: number | Format: double | Indicate the variable handling percentage. Actual percentage (10 means 10%, which is a mutiplier of 0.1).
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateElementBasis -- Type: string | Valid values: NET_CHARGE, NET_FREIGHT, BASE_CHARGE, NET_CHARGE_EXCLUDING_TAXES | Indicate the rate charge on which, the variable handling amount is calculated.
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Specify the type of rate level is to be selected.
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateType -- Type: string | Valid values: ACCOUNT, ACTUAL, CURRENT, CUSTOM, LIST, INCENTIVE, PREFERRED, PREFERRED_INCENTIVE, PREFERRED_CURRENCY | Specify the rate type.
requestedShipment.requestedPackageLineItems[].weight -- Type: object | Example: {'units': 'LB', 'value': 10} | Indicate the total weight of the requested package line items. These are the weight details.
requestedShipment.requestedPackageLineItems[].weight.units -- Type: string | Valid values: KG, LB | Example: LB | Specifies the package weight unit. For Dry Ice the unit of measure is KG.
requestedShipment.requestedPackageLineItems[].weight.value -- Type: number | Format: double | Example: 10 | Specifies the package weight.<br> Example: 68.25
requestedShipment.serviceType -- Type: string | Example: STANDARD_OVERNIGHT | Indicate the FedEx service type used for this shipment. The results will be filtered by the service type value indicated. If no serviceType is indicated then all the applicable services and corresp...
requestedShipment.serviceTypeDetail -- Type: object | service type information details
requestedShipment.serviceTypeDetail.carrierCode -- Type: string | Valid values: FDXE, FDXG, FXSP, FXFR, FDXC, FXCC | Identifies which carrier is being described.
requestedShipment.serviceTypeDetail.description -- Type: string | Description
requestedShipment.serviceTypeDetail.serviceCategory -- Type: string | Service Category
requestedShipment.serviceTypeDetail.serviceName -- Type: string | Service Name
requestedShipment.shipDateStamp -- Type: string | Example: 2019-09-06 | Indicate the Shipment date. This is required for future ship date rates. Defaulted to current date in case if not provided or input date is a past date.<br>The format is YYYY-MM-DD<br> Example: 201...
requestedShipment.shipmentSpecialServices -- Type: object | Specify the special services requested at the shipment level.<br>This has to be specified if rate data needed for the special services. Indicate special services for which the rate data is being re...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail -- Type: object | Indicate the Delivery On Invoice Acceptance detail. Recipient is required for Delivery On Invoice Special service.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient -- Type: object | Example: {'accountNumber': {'value': 123456789}} | Indicate the party to a transaction including the physical address, contact information and account number information.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is the Account number details.<br><i>Note:<ul><li>If the paymentType is Sender, then the account number is optional in shippingChargesPayment.</li><li>In case if this is shipping account numbe...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.accountNumber.value -- Type: string | Example: Your account number | This is the account number. Maximum Length is 9. <br>Example: Your account number
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address -- Type: object | Example: {'streetLines': ['1550 Union Blvd', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'TN', 'postalCode': '38127', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.countryCode -- Type: string | Example: US | This is the two-letter country code. Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a> The two-letter country code. <br>Maximu...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.postalCode -- Type: string | Example: 65247 | Indicate the Postal code. This is optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.stateOrProvinceCode -- Type: string | Example: TN | This is a placeholder for State or Province code. <br> Example: CA <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State Or Province Code</a>
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.streetLines -- Type: array | Example: ['10 FedEx Parkway', 'Suite 30'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'parsedPersonName': {'firstName': 'firstName', 'lastName': 'lastName', 'middleName': 'middleName', 'suffix': 'suffix'}, 'phoneNumber': '1234567890', 'phoneExtension': '1234', 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. This is a placeholder for company name. Maximum length is 35.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.faxNumber -- Type: string | Example: 1234567890 | Specify contact fax number. Maximum length is 15. <br> Example: 1234567890 This is a placeholder for Fax number. Maximum length is 15.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.parsedPersonName -- Type: object | Example: {'firstName': 'John', 'lastName': 'Mayor', 'middleName': 'Redmond', 'suffix': 'Jr'} | This object is used to separate the person name into first and last name.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.parsedPersonName.firstName -- Type: string | Example: firstName | Specify the First Name. Maximum Length is 35. <br> Example: John
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.parsedPersonName.lastName -- Type: string | Example: lastName | Specify the Last Name. Maximum Length is 35. <br> Example: Mayor
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.parsedPersonName.middleName -- Type: string | Example: middleName | Specify the Middle Name.<br> Example: Redmond
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.parsedPersonName.suffix -- Type: string | Example: suffix | Specify the Suffix.<br> Example: Jr
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.personName -- Type: string | Example: John Taylor | Specify contact name.<br>Note: Recommended Length is 70. There's no specific validation for the length.<br> Example: John Taylor This is a placeholder for contact person's name. Maximum Length is 70.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.phoneExtension -- Type: string | Example: 1234 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. Maximum length is 15. <br> Example: 1234567890 This is a placeholder for phone number associated with this contact. Maximum length is 15.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail -- Type: object | Use this object to specify required information for a shipment to be held at destination FedEx location. <br><br><i>Note: This object HoldAtLocationDetail is <b>REQUIRED</b>, when HOLD_AT_LOCATION ...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'parsedPersonName': {'firstName': 'first name', 'lastName': 'last name', 'middleName': 'middle name', 'suffix': 'suffix'}, 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Specify the contact and address details of a location.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.city -- Type: string | Example: Beverly Hills | Specify name of city, town, etc.<br> Example: Beverly Hills
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.countryCode -- Type: string | Example: US | The two-letter country code. Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.postalCode -- Type: string | Example: 65247 | Specify the postal code. This is optional for non postal- aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | Specify State or province code. Maximum length is 2.<br> Example: CA <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State Or Province Codes</a>
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'parsedPersonName': {'firstName': 'firstName', 'lastName': 'lastName', 'middleName': 'middleName', 'suffix': 'suffix'}, 'phoneNumber': '1234567890', 'phoneExtension': '1234', 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.faxNumber -- Type: string | Example: 1234567890 | Specify contact fax number. Maximum length is 15. <br> Example: 1234567890
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.parsedPersonName -- Type: object | Example: {'firstName': 'John', 'lastName': 'Mayor', 'middleName': 'Redmond', 'suffix': 'Jr'} | This object is used to separate the person name into first and last name.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.parsedPersonName.firstName -- Type: string | Example: firstName | Specify the First Name. Maximum Length is 35. <br> Example: John
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.parsedPersonName.lastName -- Type: string | Example: lastName | Specify the Last Name. Maximum Length is 35. <br> Example: Mayor
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.parsedPersonName.middleName -- Type: string | Example: middleName | Specify the Middle Name.<br> Example: Redmond
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.parsedPersonName.suffix -- Type: string | Example: suffix | Specify the Suffix.<br> Example: Jr
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact name.<br>Note: Recommended Length is 70. There's no specific validation for the length.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneExtension -- Type: string | Example: 1234 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. Maximum length is 15. <br> Example: 1234567890
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationId -- Type: string | Example: YBZA | This is an alphanumeric identifier used for Location/Facility Identification.<br><br>Example: YBZA<br><br>Note: <i><ul><li>For HAL Shipment, Location ID is <b>REQUIRED</b> to ensure packages are de...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationType -- Type: string | Valid values: FEDEX_AUTHORIZED_SHIP_CENTER, FEDEX_OFFICE, FEDEX_SELF_SERVICE_LOCATION, FEDEX_STAFFED, RETAIL_ALLICANCE_LOCATION, FEDEX_GROUND_TERMINAL, FEDEX_ONSITE | Example: FEDEX_ONSITE | Specify the Location Type.<br> Example: FEDEX_ONSITE
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail -- Type: object | These are Special service elements for FedEx Ground Home Delivery shipments. If selected, element homedeliveryPremiumType is mandatory.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.homedeliveryPremiumType -- Type: string | Valid values: APPOINTMENT, DATE_CERTAIN, EVENING | 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 appointme...
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber -- Type: object | Example: {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'} | Indicate the phone number. Only numeric values allowed.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.areaCode -- Type: string | Indicate the area Code for the phone number.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.countryCode -- Type: string | Indicate the two-letter country code.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.extension -- Type: string | Indicate the extension for the phone number.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.localNumber -- Type: string | Example: 234123 | Indicate the local phone number for contacting in the event of an emergency.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.personalIdentificationNumber -- Type: string | Example: 3575012 | Indicate the Personal Identification Number associated with the phone number.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.shipTimestamp -- Type: string | Example: 2020-04-24 | This is shipment date. Both the date and time portions of the string are expected to be used. The date should not be a past date or a date more than 10 days in the future. The time is the local tim...
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail -- Type: object | Use this object to specify International Controlled Export shipment Details.
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.type -- Type: string | Valid values: DEA_036, DEA_236, DEA_486, DSP_05, DSP_61, DSP_73, DSP_85, DSP_94, DSP_LICENSE_AGREEMENT, FROM_FOREIGN_TRADE_ZONE, WAREHOUSE_WITHDRAWAL | Indicate International Controlled Export Type.<br>Example: WAREHOUSE_WITHDRAWAL
requestedShipment.shipmentSpecialServices.internationalTrafficInArmsRegulationsDetail -- Type: object | These are International Traffic In Arms Regulations shipment service Details.
requestedShipment.shipmentSpecialServices.internationalTrafficInArmsRegulationsDetail.licenseOrExemptionNumber -- Type: string | Example: 432345 | The export or license number for the ITAR shipment.<br>Example: 9871234
requestedShipment.shipmentSpecialServices.pendingShipmentDetail -- Type: object | This object is used to specify the Pending Shipment Type for Email label.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.documentReferences -- Type: array | These are Upload document details provided by the initiator of the shipment.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.documentReferences[] -- Type: object | Upload document details provided by the initator of the shipment.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.documentReferences[].customerReference -- Type: string | Customer Reference
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.documentReferences[].description -- Type: string | Example: ShippingDocumentSpecification | Indicate description of the shipping documents produced for the shipper by FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in the shipment result data.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.documentReferences[].documentId -- Type: string | Example: 98123 | Specify the document ID for the uploaded document.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.documentReferences[].documentType -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, ETD_LABEL, NAFTA_CERTIFICATE_OF_ORIGIN, NET_RATE_SHEET, OTHER, PRO_FORMA_INVOICE | These are the type of document specified in the PendingShipment request.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail -- Type: object | Describes specific information about the email label shipment.<ul><li>Message: Content of the email message</li><li>Recipients: EMailRecipient</li><li>emailAddress - email address of the recipient<...
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.message -- Type: string | customer specified message to be included in the email to the end-user.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients -- Type: array | Describes specific information about the list of email label shipment reipients.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[] -- Type: object | Use this object to specify the recipient email information.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].emailAddress -- Type: string | This is the placeholder for Email address of the end-user to be  notified of the return label. Maximum length is 200 characters.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].locale -- Type: object | These are Locale details.<br>Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].locale.country -- Type: string | This is country code.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].locale.language -- Type: string | This is language code.<br>Example: en<br><a onclick='loadDocReference("locales")'>Click here to see Locale</a>
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested -- Type: object | Indicates how the email notifications for the pending shipment need to be processed.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested.options -- Type: array | Specifies the options.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested.options[] -- Type: string | Valid values: PRODUCE_PAPERLESS_SHIPPING_FORMAT, SUPPRESS_ADDITIONAL_LANGUAGES, SUPPRESS_ACCESS_EMAILS
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].role -- Type: string | Valid values: SHIPMENT_COMPLETOR, SHIPMENT_INITIATOR | Specifies the role of the recipient to the pending shipment.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.expirationTimeStamp -- Type: string | Example: 2012-12-31 | Specify the Email Return Label expiration date. The Maximum expiration date for an Email Return Label must be greater or equal to the day of the label request and not greater than 2 years in the fu...
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.pendingShipmentType -- Type: string | Valid values: EMAIL | This is Pending Shipment Type. Must include the value EMAIL for email return shipments.<br>Not applicable for other types of shipments.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions -- Type: object | Use this object to specify the processing options associated with Pending Shipment request. This is useful for the Email Label originator to specify if the completer can make modifications to edita...
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions.options -- Type: array | These are Pending Shipment processing options.<br> Example: ["ALLOW_MODIFICATIONS"]
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions.options[] -- Type: string | Valid values: ALLOW_MODIFICATIONS
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification -- Type: object | These are recommended document specification which are recommended to be included with the shipment.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification.types -- Type: array | This is a document type.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification.types[] -- Type: string | Valid values: ANTIQUE_STATEMENT_EUROPEAN_UNION, ANTIQUE_STATEMENT_UNITED_STATES, ASSEMBLER_DECLARATION, BEARING_WORKSHEET, CERTIFICATE_OF_SHIPMENTS_TO_SYRIA, COMMERCIAL_INVOICE_FOR_THE_CARIBBEAN_COMMON_MARKET, CONIFEROUS_SOLID_WOOD_PACKAGING_MATERIAL_TO_THE_PEOPLES_REPUBLIC_OF_CHINA, DECLARATION_FOR_FREE_ENTRY_OF_RETURNED_AMERICAN_PRODUCTS, DECLARATION_OF_BIOLOGICAL_STANDARDS, DECLARATION_OF_IMPORTED_ELECTRONIC_PRODUCTS_SUBJECT_TO_RADIATION_CONTROL_STANDARD, ELECTRONIC_INTEGRATED_CIRCUIT_WORKSHEET, FILM_AND_VIDEO_CERTIFICATE, INTERIM_FOOTWEAR_INVOICE, NAFTA_CERTIFICATE_OF_ORIGIN_CANADA_ENGLISH, NAFTA_CERTIFICATE_OF_ORIGIN_CANADA_FRENCH, NAFTA_CERTIFICATE_OF_ORIGIN_SPANISH, NAFTA_CERTIFICATE_OF_ORIGIN_UNITED_STATES, PACKING_LIST, PRINTED_CIRCUIT_BOARD_WORKSHEET, REPAIRED_WATCH_BREAKOUT_WORKSHEET, STATEMENT_REGARDING_THE_IMPORT_OF_RADIO_FREQUENCY_DEVICES, TOXIC_SUBSTANCES_CONTROL_ACT, UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERSHIP_ACT_CERTIFICATE_OF_ORIGIN_TEXTILES, UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERSHIP_ACT_CERTIFICATE_OF_ORIGIN_NON_TEXTILES, UNITED_STATES_NEW_WATCH_WORKSHEET, UNITED_STATES_WATCH_REPAIR_DECLARATION
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.shipmentDryIceDetail -- Type: object | Use this object to indicate package count with weight for this shipment containing dry ice. Dry ice is supported in both shipment level and package level services.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.shipmentDryIceDetail.packageCount -- Type: integer | Format: int32 | Example: 12 | This is package count.<br>Example: 12
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.shipmentDryIceDetail.totalWeight -- Type: object | Example: {'units': 'LB', 'value': 10} | These are the weight details.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.shipmentDryIceDetail.totalWeight.units -- Type: string | Valid values: KG, LB | Example: LB | Specifies the package weight unit. For Dry Ice the unit of measure is KG.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.shipmentDryIceDetail.totalWeight.value -- Type: number | Format: double | Example: 10 | Specifies the package weight.<br> Example: 68.25
requestedShipment.shipmentSpecialServices.returnShipmentDetail -- Type: object | Details for the Return Shipment.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnType -- Type: string | Example: PRINT_RETURN_LABEL | The type of return shipment being requested.
requestedShipment.shipmentSpecialServices.shipmentCODDetail -- Type: object | Use this object to specify Collect On Delivery (COD) shipment details. Specifies Shipment COD Detail
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail -- Type: object | These are COD Transportation Charges Detail.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.chargeLevelType -- Type: string | Valid values: CURRENT_PACKAGE, SUM_OF_PACKAGES | Specify whether the charges applied on current or all packages.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.chargeType -- Type: string | Valid values: COD_SURCHARGE, NET_CHARGE, NET_FREIGHT, TOTAL_CUSTOMER_CHARGE | Specify the Charges Type.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Specify whether the rate applied on bundle or indiividual package.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.rateType -- Type: string | Valid values: ACCOUNT, ACTUAL, CURRENT, CUSTOM, LIST, INCENTIVE, PREFERRED, PREFERRED_INCENTIVE, PREFERRED_CURRENCY | Specify COD Rate Type.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionType -- Type: string | Valid values: ANY, CASH, COMPANY_CHECK, GUARANTEED_FUNDS, PERSONAL_CHECK | Indicate the type of funds FedEx should collect upon shipment delivery.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient -- Type: object | Example: {'accountNumber': {'value': 123456789}} | Indicate the party to a transaction including the physical address, contact information and account number information.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is the Account number details.<br><i>Note:<ul><li>If the paymentType is Sender, then the account number is optional in shippingChargesPayment.</li><li>In case if this is shipping account numbe...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.accountNumber.value -- Type: string | Example: Your account number | This is the account number. Maximum Length is 9. <br>Example: Your account number
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address -- Type: object | Example: {'streetLines': ['1550 Union Blvd', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'TN', 'postalCode': '38127', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.countryCode -- Type: string | Example: US | This is the two-letter country code. Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.postalCode -- Type: string | Example: 65247 | Indicate the Postal code. This is optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.stateOrProvinceCode -- Type: string | Example: TN | This is a placeholder for State or Province code. <br> Example: CA <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State Or Province Code</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'parsedPersonName': {'firstName': 'firstName', 'lastName': 'lastName', 'middleName': 'middleName', 'suffix': 'suffix'}, 'phoneNumber': '1234567890', 'phoneExtension': '1234', 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.faxNumber -- Type: string | Example: 1234567890 | Specify contact fax number. Maximum length is 15. <br> Example: 1234567890
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.parsedPersonName -- Type: object | Example: {'firstName': 'John', 'lastName': 'Mayor', 'middleName': 'Redmond', 'suffix': 'Jr'} | This object is used to separate the person name into first and last name.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.parsedPersonName.firstName -- Type: string | Example: firstName | Specify the First Name. Maximum Length is 35. <br> Example: John
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.parsedPersonName.lastName -- Type: string | Example: lastName | Specify the Last Name. Maximum Length is 35. <br> Example: Mayor
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.parsedPersonName.middleName -- Type: string | Example: middleName | Specify the Middle Name.<br> Example: Redmond
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.parsedPersonName.suffix -- Type: string | Example: suffix | Specify the Suffix.<br> Example: Jr
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.personName -- Type: string | Example: John Taylor | Specify contact name.<br>Note: Recommended Length is 70. There's no specific validation for the length.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.phoneExtension -- Type: string | Example: 1234 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. Maximum length is 15. <br> Example: 1234567890
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'parsedPersonName': {'firstName': 'first name', 'lastName': 'last name', 'middleName': 'middle name', 'suffix': 'suffix'}, 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Specify the contact and address details of a location.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.city -- Type: string | Example: Beverly Hills | Specify name of city, town, etc.<br> Example: Beverly Hills
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.countryCode -- Type: string | Example: US | The two-letter country code. Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.postalCode -- Type: string | Example: 65247 | Specify the postal code. This is optional for non postal- aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | Specify State or province code. Maximum length is 2.<br> Example: CA <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State Or Province Codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'parsedPersonName': {'firstName': 'firstName', 'lastName': 'lastName', 'middleName': 'middleName', 'suffix': 'suffix'}, 'phoneNumber': '1234567890', 'phoneExtension': '1234', 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.faxNumber -- Type: string | Example: 1234567890 | Specify contact fax number. Maximum length is 15. <br> Example: 1234567890
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.parsedPersonName -- Type: object | Example: {'firstName': 'John', 'lastName': 'Mayor', 'middleName': 'Redmond', 'suffix': 'Jr'} | This object is used to separate the person name into first and last name.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.parsedPersonName.firstName -- Type: string | Example: firstName | Specify the First Name. Maximum Length is 35. <br> Example: John
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.parsedPersonName.lastName -- Type: string | Example: lastName | Specify the Last Name. Maximum Length is 35. <br> Example: Mayor
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.parsedPersonName.middleName -- Type: string | Example: middleName | Specify the Middle Name.<br> Example: Redmond
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.parsedPersonName.suffix -- Type: string | Example: suffix | Specify the Suffix.<br> Example: Jr
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact name.<br>Note: Recommended Length is 70. There's no specific validation for the length.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.phoneExtension -- Type: string | Example: 1234 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. Maximum length is 15. <br> Example: 1234567890
requestedShipment.shipmentSpecialServices.shipmentCODDetail.remitToName -- Type: string | Example: FedEx | Specifies the name of person or company receiving the secured or unsecured payment.<br>Example: FedEx
requestedShipment.shipmentSpecialServices.shipmentCODDetail.returnReferenceIndicatorType -- Type: string | Valid values: INVOICE, PO, REFERENCE, TRACKING | Indicate the type of reference information to include on the COD return shipping label.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail -- Type: object | Use this object to indicate package count with weight for this shipment containing dry ice. Dry ice is supported in both shipment level and package level services.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.packageCount -- Type: integer | Format: int32 | Example: 12 | This is package count.<br>Example: 12
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight -- Type: object | Example: {'units': 'LB', 'value': 10} | These are the weight details.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.units -- Type: string | Valid values: KG, LB | Example: LB | Specifies the package weight unit. For Dry Ice the unit of measure is KG.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.value -- Type: number | Format: double | Example: 10 | Specifies the package weight.<br> Example: 68.25
requestedShipment.shipmentSpecialServices.specialServiceTypes -- Type: array | Example: ['BROKER_SELECT_OPTION'] | Indicate special services for which the rate data is being requested. Special Services are available at the shipment level for some or all service types.<br>Example: BROKER_SELECT_OPTION <br><a onc...
requestedShipment.shipmentSpecialServices.specialServiceTypes[] -- Type: string
requestedShipment.shipper -- Type: object | The descriptive data for the physical shipper location from which the shipment originates. Specify the shipper address details.
requestedShipment.shipper.address -- Type: object | Example: {'streetLines': ['1550 Union Blvd', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'TN', 'postalCode': '38127', 'countryCode': 'US', 'residential': False} | Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (such as a ci...
requestedShipment.shipper.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.shipper.address.countryCode -- Type: string | Example: US | This is the two-letter country code. Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.shipper.address.postalCode -- Type: string | Example: 65247 | Indicate the Postal code. This is optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal...
requestedShipment.shipper.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipper.address.stateOrProvinceCode -- Type: string | Example: TN | This is a placeholder for State or Province code. <br> Example: CA <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State Or Province Code</a>
requestedShipment.smartPostInfoDetail -- Type: object | Indicate the FedEx Smartpost shipment details. Required for Smartpost shipments only. Use this object to specify the smartpost shipment details. <br>Required for SMARTPOST service. If SmartPostInfo...
requestedShipment.smartPostInfoDetail.ancillaryEndorsement -- Type: string | Valid values: ADDRESS_CORRECTION, CARRIER_LEAVE_IF_NO_RESPONSE, CHANGE_SERVICE, FORWARDING_SERVICE, RETURN_SERVICE | 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.<br>For more information,...
requestedShipment.smartPostInfoDetail.hubId -- Type: string | Example: 5531 | Specify the four-digit numeric Hub ID value used during rate quote for smartport shipments.<br><a onclick='loadDocReference("smartposthubids")'>Click here to see Hub Ids</a>
requestedShipment.smartPostInfoDetail.indicia -- Type: string | Valid values: MEDIA_MAIL, PARCEL_RETURN, PARCEL_SELECT, PRESORTED_BOUND_PRINTED_MATTER, PRESORTED_STANDARD | Specify the indicia type.<br>Available options include:<ul><li>MEDIA_MAIL</li><li>PARCEL_SELECT (1 LB through 70 LB)</li><li>PRESORTED_BOUND_PRINTED_MATTER</li><li>PRESORTED_STANDARD (less than 1 L...
requestedShipment.smartPostInfoDetail.specialServices -- Type: string | Valid values: USPS_DELIVERY_CONFIRMATION | Specify the special handling associated with Smartpost Shipment.<br><a onclick='loadDocReference("shipmentlevelspecialservicetypes")'>Click here to see Shipment Level Special Service Types</a>
requestedShipment.totalPackageCount -- Type: integer | Format: int32 | Example: 3 | Indicate the total number of packages in the shipment. <br>The Maximum number of packages in a rate request is 100.
requestedShipment.totalWeight -- Type: number | Format: double | Example: 87.5 | Specify the total weight of the shipment. <br>This is only applies to International shipments and should be used on the first package of a multiple piece shipment. This value contains 1 explicit de...
requestedShipment.variableHandlingChargeDetail -- Type: object | Specify details on how to calculate variable handling charges at the shipment level. Indicate the details on how to calculate variable handling charges at the package level. If indicated, element r...
requestedShipment.variableHandlingChargeDetail.fixedValue -- Type: object | Example: {'amount': '100', 'currency': 'USD'} | Indicate the Fixed value. <br>If you choose FIXED_AMOUNT as the ChargeType, this element allows you to enter the fixed value of the handling charge. The element allows entry of 7 characters before ...
requestedShipment.variableHandlingChargeDetail.fixedValue.amount -- Type: number | Format: double | Example: 12.45 | Indicate the amount. Indicates the declared amount value for the shipment.
requestedShipment.variableHandlingChargeDetail.fixedValue.currency -- Type: string | Example: USD | Indicate the three-character ISO currency code. <br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency Codes</a> Indicates the currency associated with the am...
requestedShipment.variableHandlingChargeDetail.percentValue -- Type: number | Format: double | Indicate the variable handling percentage. Actual percentage (10 means 10%, which is a mutiplier of 0.1).
requestedShipment.variableHandlingChargeDetail.rateElementBasis -- Type: string | Valid values: NET_CHARGE, NET_FREIGHT, BASE_CHARGE, NET_CHARGE_EXCLUDING_TAXES | Indicate the rate charge on which, the variable handling amount is calculated.
requestedShipment.variableHandlingChargeDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Specify the type of rate level is to be selected.
requestedShipment.variableHandlingChargeDetail.rateType -- Type: string | Valid values: ACCOUNT, ACTUAL, CURRENT, CUSTOM, LIST, INCENTIVE, PREFERRED, PREFERRED_INCENTIVE, PREFERRED_CURRENCY | Specify the rate type.

Shipment

Create Shipment

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
accountNumber -- Type: object | Example: {'value': 'Your account number'} | The account number associated with the shipment.
accountNumber.value -- Type: string | The account number value. Maximum length is 9 .<br>Example: Your account number
labelResponseOptions -- Type: string | Valid values: URL_ONLY, LABEL | Example: LABEL | This is to specify whether the encoded bytecode or  the Label URL to be returned in the response.<p>Valid values:<ul><li>LABEL &ndash; Indicates request is for encoded bytecode.</li><li>URL_ONLY &n...
mergeLabelDocOption -- Type: string | Valid values: NONE, LABELS_AND_DOCS, LABELS_ONLY | Example: LABELS_AND_DOCS | It specifies the content of the merged pdf URL in the response. The merged pdf URL is generated only if the labelResponseOption is indicated as URL_ONLY.<ul><li>If the value is 'LABELS_AND_DOCS', t...
oneLabelAtATime -- Type: boolean | Valid values: True, False | Example: True | This flag is used to specify if the shipment is singleshot mps or one Label at a time, piece by piece shipment. Default is false. If true, one label at a time is processed.
processingOptionType -- Type: string | Valid values: SYNCHRONOUS_ONLY, ALLOW_ASYNCHRONOUS | Example: ALLOW_ASYNCHRONOUS | Indicate the processing option for submitting a Single shot MPS shipment. The value indicates if the MPS to be processed synchronously or asynchronously.<br>Note: <ul><li>Default value is SYNCHRONO...
requestedShipment -- Type: object | The descriptive data of the requested shipment.
requestedShipment.blockInsightVisibility -- Type: boolean | Example: True | Indicate if the shipment be available to be visible/tracked using FedEx InSight<sup>®</sup> tool. If value indicated as true, only the shipper/payer will have visibility of this shipment in the Fed...
requestedShipment.customsClearanceDetail -- Type: object | These are customs clearance details. Required for International and intra-country Shipments.
requestedShipment.customsClearanceDetail.brokers -- Type: array | 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 ...
requestedShipment.customsClearanceDetail.brokers[] -- Type: object | Example: {'broker': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 91, 'companyName': 'Fedex', 'faxNumber': 1234567}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}], 'deliveryInstructions': 'deliveryInstructions'}, 'type': 'IMPORT'} | These are broker details for the shipment.
requestedShipment.customsClearanceDetail.brokers[].broker -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | These are broker details for the shipment with physical address, contact and account number information.
requestedShipment.customsClearanceDetail.brokers[].broker.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.customsClearanceDetail.brokers[].broker.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.customsClearanceDetail.brokers[].broker.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.customsClearanceDetail.brokers[].broker.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.customsClearanceDetail.brokers[].broker.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.customsClearanceDetail.brokers[].broker.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.customsClearanceDetail.brokers[].broker.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.customsClearanceDetail.brokers[].broker.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.customsClearanceDetail.brokers[].broker.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.customsClearanceDetail.brokers[].broker.address.streetLines[] -- Type: string
requestedShipment.customsClearanceDetail.brokers[].broker.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment. Specifies broker contact details.
requestedShipment.customsClearanceDetail.brokers[].broker.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.customsClearanceDetail.brokers[].broker.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.customsClearanceDetail.brokers[].broker.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.customsClearanceDetail.brokers[].broker.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.customsClearanceDetail.brokers[].broker.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.customsClearanceDetail.brokers[].broker.tins -- Type: array | This is the tax identification number details.
requestedShipment.customsClearanceDetail.brokers[].broker.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.customsClearanceDetail.brokers[].type -- Type: string | Valid values: IMPORT | Example: IMPORT | Identifies the type of broker.
requestedShipment.customsClearanceDetail.commercialInvoice -- Type: object | Use this object to provide Commercial Invoice details. This element is required for electronic upload of CI data. It will serve to create/transmit an electronic Commercial Invoice through the FedEx...
requestedShipment.customsClearanceDetail.commercialInvoice.comments -- Type: array | Example: ['optional comments for the commercial invoice'] | 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 i...
requestedShipment.customsClearanceDetail.commercialInvoice.comments[] -- Type: string
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences -- Type: array | These are additional customer reference data for commercial invoice.
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences[] -- Type: object
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences[].customerReferenceType -- Type: string | Valid values: INVOICE_NUMBER, P_O_NUMBER | Example: INVOICE_NUMBER | This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information.<p>Note: <ul><li>The P_O_NUMBER value must b...
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences[].value -- Type: string | Example: 3686 | This is a customer reference type value.<br>Example: 3686<br>Note: Maximum length for all customer references is 40 characters.
requestedShipment.customsClearanceDetail.commercialInvoice.declarationStatement -- Type: string | Example: declarationStatement | This is the declaration statement which will populate the Commercial Invoice (or Pro Forma).<br>Maximum length is 554.<br>Example: declarationStatement
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail -- Type: object | These are email disposition details. Provides the type and email addresses of e-mail recipients. If returnedDispositionDetail in labelSpecification is set as true then email will be send with label...
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.emailAddress -- Type: string | Example: neena@fedex.com | This is email Address.<br>Example: xxxx@xxx.com
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.recipientType -- Type: string | Example: SHIPPER | Specify the recipient Type.<br>Example: SHIPPER/BROKER
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.type -- Type: string | Example: EMAILED | Specify the email status.<br>Example: EMAILED
requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge -- Type: object | Indicate the freight charge. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts -- Type: object | Indicate the handling cost. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.originatorName -- Type: string | Example: originator Name | The originator name that will populate the Commercial Invoice (or Pro Forma).
requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts -- Type: object | Indicate the packing cost. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.shipmentPurpose -- Type: string | Valid values: GIFT, NOT_SOLD, PERSONAL_EFFECTS, REPAIR_AND_RETURN, SAMPLE, SOLD | Example: REPAIR_AND_RETURN | This is the reason for the shipment. <br>Note: SOLD is not a valid purpose for a Proforma Invoice.
requestedShipment.customsClearanceDetail.commercialInvoice.specialInstructions -- Type: string | Example: specialInstructions" | These are special instructions that will be populated on the Commercial Invoice (or Pro Forma).<br>Example: specialInstructions
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge -- Type: object | Indicate the taxes or miscellaneous charges(other than freight charges or insurance charges) that are associated with the shipment. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousChargeType -- Type: string | Valid values: COMMISSIONS, DISCOUNTS, HANDLING_FEES, OTHER, ROYALTIES_AND_LICENSE_FEES, TAXES | Example: COMMISSIONS | Indicate the type of taxes Or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.termsOfSale -- Type: string | Example: FCA | Specify terms Of Sale that will be populated on the Commercial Invoice (or Pro Forma). Maximum length is 3<br>Valid values are:<ul><li>FCA/FOB (Free Carrier/Free On Board): Seller is responsible fo...
requestedShipment.customsClearanceDetail.commodities -- Type: array | Indicates the details about the dutiable packages. Maximum upto 999 commodities per shipment.
requestedShipment.customsClearanceDetail.commodities[] -- Type: object
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures -- Type: array | This object contains additional quantitative information other than weight and quantity to calculate duties and taxes.
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures[] -- Type: object
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures[].quantity -- Type: number | Format: double | Example: 12.45 | Specify commodity quantity.
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures[].units -- Type: string | Example: KG | Unit of measure used to express the quantity of this commodity line item.
requestedShipment.customsClearanceDetail.commodities[].cIMarksAndNumbers -- Type: string | Example: 87123 | This is an identifying mark or number used on the packaging of a shipment to help customers identify a particular shipment<br>Example: 87123
requestedShipment.customsClearanceDetail.commodities[].countryOfManufacture -- Type: string | Example: US | This is commodity country of manufacture. This is required for International shipments. Maximum allowed length is 4.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to se...
requestedShipment.customsClearanceDetail.commodities[].customsValue -- Type: object | This is the customs value. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commodities[].customsValue.amount -- Type: number | Format: double | Example: 1556.25 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example:  1556.25
requestedShipment.customsClearanceDetail.commodities[].customsValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commodities[].description -- Type: string | Example: description | This is the commodity description. Maximum allowed 450 characters.<br><a onclick='loadDocReference("vaguecommoditydescriptions")'>click here to see Vague commodity descriptions</a>
requestedShipment.customsClearanceDetail.commodities[].exportLicenseExpirationDate -- Type: string | Format: date-time | Specify the export license expiration date for the shipment.<br>Format YYYY-MM-DD<br>Example : 2009-04-12
requestedShipment.customsClearanceDetail.commodities[].exportLicenseNumber -- Type: string | Example: 26456 | This is the export license number for the shipment.<br>Example: 26456
requestedShipment.customsClearanceDetail.commodities[].harmonizedCode -- Type: string | Example: 0613 | This is to specify the Harmonized Tariff System (HTS) code to meet U.S. and foreign governments' customs requirements. These are mainly used to estimate the duties and taxes.<br>Example: 0613<br>To...
requestedShipment.customsClearanceDetail.commodities[].name -- Type: string | Example: non-threaded rivets | This is Commodity name.<br>Example: Non-Threaded Rivets
requestedShipment.customsClearanceDetail.commodities[].numberOfPieces -- Type: integer | Format: int32 | Example: 12 | Indicate the number of pieces associated with the commodity. The value can neither be negative nor exceed 9,999.<br>Example: 12
requestedShipment.customsClearanceDetail.commodities[].partNumber -- Type: string | Example: 167 | This is a part number.<br>Example: 167
requestedShipment.customsClearanceDetail.commodities[].purpose -- Type: string | Valid values: BUSINESS, CONSUMER | Example: BUSINESS | This is the purpose of this shipment. This is used for calculation of duties and taxes.
requestedShipment.customsClearanceDetail.commodities[].quantity -- Type: integer | Format: int32 | Example: 125 | This is the units quantity (using quantityUnits as the unit of measure) per commodity. This is used to estimate duties and taxes.<br> Example: 125
requestedShipment.customsClearanceDetail.commodities[].quantityUnits -- Type: string | Example: Ea | This is the unit of measure for the units quantity. This is used to estimate duties and taxes.<br>Example: EA<br><a onclick='loadDocReference("harmonizedsystemcodeunitofmeasure-table1")'>click here...
requestedShipment.customsClearanceDetail.commodities[].unitPrice -- Type: object | This is the unit price. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commodities[].unitPrice.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commodities[].unitPrice.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commodities[].usmcaDetail -- Type: object | Indicates the USMCA detail
requestedShipment.customsClearanceDetail.commodities[].usmcaDetail.originCriterion -- Type: string | Valid values: A, B, C, D, E | Specify the origin criterion.
requestedShipment.customsClearanceDetail.commodities[].weight -- Type: object | Example: {'units': 'KG', 'value': 68} | These are the package weight details.<br>Note: Weight is not required for One rate shipments
requestedShipment.customsClearanceDetail.commodities[].weight.units -- Type: string | Valid values: KG | Example: KG | Indicate the weight unit type. The package and commodity weight unit should be the same else the request will result in an error.
requestedShipment.customsClearanceDetail.commodities[].weight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.customsClearanceDetail.customsOption -- Type: object | Example: {'description': 'Description', 'type': 'COURTESY_RETURN_LABEL'} | These are customs Option Detail, type must be indicated for each occurrence.
requestedShipment.customsClearanceDetail.customsOption.description -- Type: string | Example: Description | Specify additional description about customs options. This is a required field when the Type is OTHER.
requestedShipment.customsClearanceDetail.customsOption.type -- Type: string | Valid values: COURTESY_RETURN_LABEL, EXHIBITION_TRADE_SHOW, FAULTY_ITEM, FOLLOWING_REPAIR, FOR_REPAIR, ITEM_FOR_LOAN, OTHER, REJECTED, REPLACEMENT, TRIAL | Example: COURTESY_RETURN_LABEL | Specify the reason for a global return, as recognized by Customs. Valid values:<ul><li>COURTESY_RETURN_LABEL: Applicable for Outbound shipments.</li><li>EXHIBITION_TRADE_SHOW: For exhibition or tra...
requestedShipment.customsClearanceDetail.declarationStatementDetail -- Type: object | Specifies about the statements to be declared for Customs.
requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail -- Type: object | Specify the low Value statement necessary for printing the USMCA for Customs documentation.
requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail.countryOfOriginLowValueDocumentRequested -- Type: boolean | Example: True | Specify the country Of Origin of Low Value Document for Customs declaration.
requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail.customsRole -- Type: string | Valid values: EXPORTER, IMPORTER | Example: EXPORTER | Specify the shipper role for Customs declaration.
requestedShipment.customsClearanceDetail.dutiesPayment -- Type: object | Example: {'payor': {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}, {'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}}, 'billingDetails': {'billingCode': 'billingCode', 'billingType': 'billingType', 'aliasId': 'aliasId', 'accountNickname': 'accountNickname', 'accountNumber': 'Your account number', 'accountNumberCountryCode': 'US'}, 'paymentType': 'SENDER'} | This is a payment type, basically indicates who is the payor for the shipment.Conditional required for International Shipments
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails -- Type: object | Example: {'billingCode': '128345', 'billingType': 'billingType', 'aliasId': 'alias identifier', 'accountNickname': 'accountNickname', 'accountNumber': 'Your account number', 'accountNumberCountryCode': 'CA'} | These are billing details.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNickname -- Type: string | This is account nick name.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNumber -- Type: string | This is bill to account number.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNumberCountryCode -- Type: string | This is the country code of the account number.<br>Example: CA
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.aliasId -- Type: string | This is bill to alias identifier.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.billingCode -- Type: string | Indicates a billing code.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.billingType -- Type: string | These are duties and taxes billing type.
requestedShipment.customsClearanceDetail.dutiesPayment.paymentType -- Type: string | Valid values: SENDER, RECIPIENT, THIRD_PARTY, COLLECT | This is a payment type, basically indicates who is the payor for the shipment.<br>Required for Express and Ground.<br>The payment type COLLECT is applicable only for Ground shipments.
requestedShipment.customsClearanceDetail.dutiesPayment.payor -- Type: object | Example: {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}, {'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}} | Information about the person who is paying for the shipment. Not applicable for credit card payment.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}, {'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | Use this object to provide the attributes such as physical address, contact information and account number information.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.streetLines[] -- Type: string
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins -- Type: array | This is the tax identification number details.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.customsClearanceDetail.exportDetail -- Type: object | These are export Detail used for US or CA exports.
requestedShipment.customsClearanceDetail.exportDetail.b13AFilingOption -- Type: string | Valid values: NOT_REQUIRED, MANUALLY_ATTACHED, FILED_ELECTRONICALLY, SUMMARY_REPORTING, FEDEX_TO_STAMP | Example: NOT_REQUIRED | 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. Virgi...
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail -- Type: object | Use this object to specify the appropriate destination control statement type(s). Also make sure to specify destination country and end user.
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.destinationCountries -- Type: array | Example: ['USA', 'India'] | Specify DCS shipment destination country. You may enter up to four country codes in this element. Up to 11 alphanumeric characters are allowed.<br>Example: US<br><a onclick='loadDocReference("count...
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.destinationCountries[] -- Type: string
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.endUser -- Type: string | Example: dest country user | Specify End User name. Its is required if StatementTypes is entered as DEPARTMENT_OF_STATE. <br>Example: John Wick
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.statementTypes -- Type: string | Valid values: DEPARTMENT_OF_COMMERCE, DEPARTMENT_OF_STATE, DEPARTMENT_OF_COMMERCE_AND_DEPARTMENT_OF_STATE | Example: DEPARTMENT_OF_COMMERCE | Specify appropriate destination control statement type(s), Also make sure to specify destination country and end user.
requestedShipment.customsClearanceDetail.exportDetail.exportComplianceStatement -- Type: string | Example: 12345678901234567 | 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 nu...
requestedShipment.customsClearanceDetail.exportDetail.permitNumber -- Type: string | Example: 12345 | 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.<br> Example: 12345
requestedShipment.customsClearanceDetail.freightOnValue -- Type: string | Valid values: CARRIER_RISK, OWN_RISK | Example: OWN_RISK | Specify the risk owner for the Freight shipment.This element is only mandatory or valid for Intra India shipments.
requestedShipment.customsClearanceDetail.generatedDocumentLocale -- Type: string | Example: en_US | This is the locale for generated document.<br>Example: en_US<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is e...
requestedShipment.customsClearanceDetail.importerOfRecord -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | The descriptive data for the importer of Record for the shipment and their physical address, contact and account number information.
requestedShipment.customsClearanceDetail.importerOfRecord.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.customsClearanceDetail.importerOfRecord.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.customsClearanceDetail.importerOfRecord.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.customsClearanceDetail.importerOfRecord.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.customsClearanceDetail.importerOfRecord.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.customsClearanceDetail.importerOfRecord.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.customsClearanceDetail.importerOfRecord.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.customsClearanceDetail.importerOfRecord.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.customsClearanceDetail.importerOfRecord.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.customsClearanceDetail.importerOfRecord.address.streetLines[] -- Type: string
requestedShipment.customsClearanceDetail.importerOfRecord.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.customsClearanceDetail.importerOfRecord.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.customsClearanceDetail.importerOfRecord.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.customsClearanceDetail.importerOfRecord.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.customsClearanceDetail.importerOfRecord.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.customsClearanceDetail.importerOfRecord.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.customsClearanceDetail.importerOfRecord.tins -- Type: array | This is the tax identification number details.
requestedShipment.customsClearanceDetail.importerOfRecord.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.customsClearanceDetail.insuranceCharge -- Type: object | Specify insurance charges if applicable. <br><i>Note: FedEx does not provide insurance of any kind.</i> Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.insuranceCharge.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.insuranceCharge.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.isDocumentOnly -- Type: boolean | Example: True | 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 -- Type: boolean | Specify if the transacting parties are related.
requestedShipment.customsClearanceDetail.recipientCustomsId -- Type: object | Use this element to provide valid identification details. Used for populating brazil tax id.
requestedShipment.customsClearanceDetail.recipientCustomsId.type -- Type: string | Valid values: COMPANY, INDIVIDUAL, PASSPORT | Example: PASSPORT | This is ID Type.
requestedShipment.customsClearanceDetail.recipientCustomsId.value -- Type: string | Example: 123 | This is the ID number.
requestedShipment.customsClearanceDetail.regulatoryControls -- Type: array | Example: NOT_IN_FREE_CIRCULATION | These are the regulatory controls applicable to the shipment.
requestedShipment.customsClearanceDetail.regulatoryControls[] -- Type: string | Valid values: FOOD_OR_PERISHABLE, USMCA, NOT_APPLICABLE_FOR_LOW_VALUE_CUSTOMS_EXCEPTIONS, NOT_IN_FREE_CIRCULATION
requestedShipment.customsClearanceDetail.totalCustomsValue -- Type: object | This is the total customs value. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.totalCustomsValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.totalCustomsValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.emailNotificationDetail -- Type: object | This is used to provide eMail notification information..
requestedShipment.emailNotificationDetail.aggregationType -- Type: string | Valid values: PER_PACKAGE, PER_SHIPMENT | Example: PER_PACKAGE | This is the shipment Notification Aggregation Type.
requestedShipment.emailNotificationDetail.emailNotificationRecipients -- Type: array | These are email notification recipient details.
requestedShipment.emailNotificationDetail.emailNotificationRecipients[] -- Type: object | These are recipient details for receiving email notification.
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].emailAddress -- Type: string | Example: jsmith3@aol.com | Specify the recipient email address.<br>Example: xyz@aol.com
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].emailNotificationRecipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: SHIPPER | Specify the recipient type for email notification.
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].locale -- Type: string | Example: en_US | These are the locale details for email.<br>Example: en_US, fr_CA, es_MX,.etc.<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an in...
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].name -- Type: string | Example: Joe Smith | Specify the recipient name.<br>Example: Joe Smith
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationEventType -- Type: array | Example: ['ON_PICKUP_DRIVER_ARRIVED', 'ON_SHIPMENT'] | These are to specify the notification event types.<br> Example: [ON_PICKUP_DRIVER_ARRIVED, ON_SHIPMENT]<br><a onclick='loadDocReference("notificationeventtypes")'>Click here for more information on...
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationEventType[] -- Type: string | Valid values: ON_DELIVERY, ON_EXCEPTION, ON_SHIPMENT, ON_TENDER, ON_ESTIMATED_DELIVERY, ON_PICKUP, ON_LABEL, ON_PICKUP_DRIVER_ARRIVED, ON_PICKUP_DRIVER_ASSIGNED, ON_PICKUP_DRIVER_DEPARTED, ON_PICKUP_DRIVER_EN_ROUTE
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationFormatType -- Type: string | Valid values: HTML, TEXT | Example: TEXT | This is the format for the email notification. Either HTML or plain text can be provided.<br>Example: TEXT
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationType -- Type: string | Valid values: EMAIL | Example: EMAIL | Indicate the type of notification that will be sent as an email<br>Example: EMAIL
requestedShipment.emailNotificationDetail.personalMessage -- Type: string | Example: your personal message here | This is your personal message for the email.<br>Note: The maximum personal message character limit depends on the element notificationFormatType values:<ul><li>If notificationFormatType is TEXT, th...
requestedShipment.expressFreightDetail -- Type: object | Indicates the advance booking number, shipper load /count and packing list details. This details must be provided by the user during freight shipment.
requestedShipment.expressFreightDetail.bookingConfirmationNumber -- Type: string | Example: 123456789812 | 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 Freig...
requestedShipment.expressFreightDetail.packingListEnclosed -- Type: boolean | Example: True | 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. <br> Example: true
requestedShipment.expressFreightDetail.shippersLoadAndCount -- Type: integer | Format: int32 | Example: 123 | Indicates the content of a container were loaded and counted by the shipper.<br>Minimum length: 1 digits <br> Maximum length: 5 digits <br>Example:  If a skid has 32 small boxes on it that are shri...
requestedShipment.labelSpecification -- Type: object | These are label specification details includes the image type, printer format, and label stock for label. Can also specify specific details such as doc-tab content, regulatory labels, and masking d...
requestedShipment.labelSpecification.customerSpecifiedDetail -- Type: object | This object allows the control of label content for customization.
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels -- Type: array | Specify how the additional details to be provided on the labels.
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels[] -- Type: object
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels[].count -- Type: integer | Example: 1 | Specifies the count of label to return.
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels[].type -- Type: string | Valid values: BROKER, CONSIGNEE, CUSTOMS, DESTINATION, DESTINATION_CONTROL_STATEMENT, FREIGHT_REFERENCE, MANIFEST, ORIGIN, RECIPIENT, SECOND_ADDRESS, SHIPPER | Example: CONSIGNEE | Specify the type of additional  details to be added on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent -- Type: object | Specifies details of doc tab content.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded -- Type: object | It is a doc tab content type which is in barcoded format.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification -- Type: object | Indicates the doc tab zone specification.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.dataField -- Type: string | Indicate the path request/reply element to be printed on doc tab.<br>Example:<ul><li>REQUEST/SHIPMENT/ShipTimestamp</li><li>REQUEST/PACKAGE/weight/Value</li><li>REQUEST/PACKAGE/InsuredValue/Amount<...
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.header -- Type: string | Indicates the parameter name in the header for the doc tab zone.<br>Example:  WHT
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.justification -- Type: string | Valid values: LEFT, RIGHT | Example: RIGHT | Indicates the justification format for the string.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.literalValue -- Type: string | Indicates the actual data to be printed in the label<br>
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.zoneNumber -- Type: integer | Format: int32 | It is a non-negative integer that represents the portion of doc-tab in a label.<br>Example: 1
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.symbology -- Type: string | Valid values: CODABAR, CODE128, CODE128_WIDEBAR, CODE128B, CODE128C, CODE39, CODE93, I2OF5, MANUAL, PDF417, POSTNET, QR_CODE, UCC128 | Example: UCC128 | Indicates the type of barcode symbology used on FedEx documents and labels.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.docTabContentType -- Type: string | Valid values: BARCODED, CUSTOM, MINIMUM, STANDARD, ZONE001 | Example: BARCODED | Indicates the content type of the doc tab.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001 -- Type: object | Indicate the doc tab specification for different zones on the label. The specification includes zone number, header and data field to be displayed on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications -- Type: array | Indicate the doc tab specifications for the individual doc tab zone on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[] -- Type: object | Indicates the doc tab zone specification.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].dataField -- Type: string | Indicate the path request/reply element to be printed on doc tab.<br>Example:<ul><li>REQUEST/SHIPMENT/ShipTimestamp</li><li>REQUEST/PACKAGE/weight/Value</li><li>REQUEST/PACKAGE/InsuredValue/Amount<...
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].header -- Type: string | Indicates the parameter name in the header for the doc tab zone.<br>Example:  WHT
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].justification -- Type: string | Valid values: LEFT, RIGHT | Example: RIGHT | Indicates the justification format for the string.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].literalValue -- Type: string | Indicates the actual data to be printed in the label<br>
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].zoneNumber -- Type: integer | Format: int32 | It is a non-negative integer that represents the portion of doc-tab in a label.<br>Example: 1
requestedShipment.labelSpecification.customerSpecifiedDetail.maskedData -- Type: array | Example: ['CUSTOMS_VALUE', 'TOTAL_WEIGHT'] | Specify which data/sections on the label to be masked.<br>Note: <ul><li>SECONDARY_BARCODE &ndash; This is used for Smartpost shipment labels.</li><li>SHIPPER_INFORMATION &ndash; This is used for Th...
requestedShipment.labelSpecification.customerSpecifiedDetail.maskedData[] -- Type: string | Valid values: CUSTOMS_VALUE, DIMENSIONS, DUTIES_AND_TAXES_PAYOR_ACCOUNT_NUMBER, INSURED_VALUE, SECONDARY_BARCODE, SHIPPER_INFORMATION, TERMS_AND_CONDITIONS, TOTAL_WEIGHT, TRANSPORTATION_CHARGES_PAYOR_ACCOUNT_NUMBER
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels -- Type: array | Specify how the regulatory details to be provided on the labels.
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels[] -- Type: object
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels[].generationOptions -- Type: string | Valid values: CONTENT_ON_SHIPPING_LABEL_PREFERRED, CONTENT_ON_SUPPLEMENTAL_LABEL_ONLY, CONTENT_ON_SHIPPING_LABEL_ONLY | Example: CONTENT_ON_SHIPPING_LABEL_ONLY | Specify the regulatory content preference to be displayed on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels[].type -- Type: string | Valid values: ALCOHOL_SHIPMENT_LABEL | Example: ALCOHOL_SHIPMENT_LABEL | Specify the type of regulatory content to be added on the label.
requestedShipment.labelSpecification.imageType -- Type: string | Valid values: ZPLII, EPL2, PDF, PNG | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.labelSpecification.labelFormatType -- Type: string | Valid values: COMMON2D, LABEL_DATA_ONLY | Example: COMMON2D | Specify the label Format Type.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.labelSpecification.labelOrder -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST | Example: SHIPPING_LABEL_FIRST | This is the order of the Shipping label/documents to be generated.
requestedShipment.labelSpecification.labelPrintingOrientation -- Type: string | Valid values: BOTTOM_EDGE_OF_TEXT_FIRST, TOP_EDGE_OF_TEXT_FIRST | Example: TOP_EDGE_OF_TEXT_FIRST | This is applicable only to documents produced on thermal printers with roll stock.
requestedShipment.labelSpecification.labelRotation -- Type: string | Valid values: LEFT, RIGHT, UPSIDE_DOWN, NONE | Example: UPSIDE_DOWN | This is applicable only to documents produced on thermal printers with roll stock.
requestedShipment.labelSpecification.labelStockType -- Type: string | Valid values: PAPER_4X6, PAPER_4X675, PAPER_4X8, PAPER_4X9, PAPER_7X475, PAPER_85X11_BOTTOM_HALF_LABEL, PAPER_85X11_TOP_HALF_LABEL, PAPER_LETTER, STOCK_4X675_LEADING_DOC_TAB, STOCK_4X8, STOCK_4X9_LEADING_DOC_TAB, STOCK_4X6, STOCK_4X675_TRAILING_DOC_TAB, STOCK_4X9_TRAILING_DOC_TAB, STOCK_4X9, STOCK_4X85_TRAILING_DOC_TAB, STOCK_4X105_TRAILING_DOC_TAB | Example: PAPER_85X11_TOP_HALF_LABEL | Indicate the label stock type used. <br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.labelSpecification.printedLabelOrigin -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Specifies the contact and address details of a location.
requestedShipment.labelSpecification.printedLabelOrigin.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.labelSpecification.printedLabelOrigin.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.labelSpecification.printedLabelOrigin.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.labelSpecification.printedLabelOrigin.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.labelSpecification.printedLabelOrigin.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.labelSpecification.printedLabelOrigin.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.labelSpecification.printedLabelOrigin.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.labelSpecification.printedLabelOrigin.address.streetLines[] -- Type: string
requestedShipment.labelSpecification.printedLabelOrigin.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.labelSpecification.printedLabelOrigin.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.labelSpecification.printedLabelOrigin.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.labelSpecification.printedLabelOrigin.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.labelSpecification.printedLabelOrigin.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.labelSpecification.printedLabelOrigin.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.labelSpecification.printedLabelOrigin.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.labelSpecification.returnedDispositionDetail -- Type: boolean | Valid values: True, False | Example: True | Specify whether or not the return deposition is needed.
requestedShipment.masterTrackingId -- Type: object | Indicates the tracking details of the package.Required for child shipments of an oneLabelAtATime shipments
requestedShipment.masterTrackingId.formId -- Type: string | Example: 0201 | This is FedEx tracking Identifier associated with the package.<br>Example: 8600
requestedShipment.masterTrackingId.trackingIdType -- Type: string | Example: EXPRESS | Specify the FedEx transportation type. <br>Example: EXPRESS
requestedShipment.masterTrackingId.trackingNumber -- Type: string | Example: 49092000070120032835 | 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. <b...
requestedShipment.masterTrackingId.uspsApplicationId -- Type: string | Example: 92 | Specify the USPS tracking Identifier associated with FedEx SmartPost shipment.<br>Example: 92
requestedShipment.origin -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Indicate shipment origin address information, if it is different from the shipper address. Specifies the contact and address details of a location.
requestedShipment.origin.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.origin.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.origin.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.origin.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.origin.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.origin.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.origin.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.origin.address.streetLines[] -- Type: string
requestedShipment.origin.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.origin.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.origin.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.origin.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.origin.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.origin.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.origin.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers. <br>Note: Recommended Maximum length is 15 and there's no specifi...
requestedShipment.packagingType -- Type: string | Example: YOUR_PACKAGING | Specify the packaging used.<br>Note: For Express Freight shipments, the packaging will default to YOUR_PACKAGING irrespective of the user provided package type in the request.<br>Example: FEDEX_PAK...
requestedShipment.pickupType -- Type: string | Valid values: CONTACT_FEDEX_TO_SCHEDULE, DROPOFF_AT_FEDEX_LOCATION, USE_SCHEDULED_PICKUP | Example: USE_SCHEDULED_PICKUP | Indicate the pickup type method by which the shipment to be tendered to FedEx.<br><a onclick='loadDocReference("pickuptypes")'>Click here for more information on Pickup Types.</a>
requestedShipment.preferredCurrency -- Type: string | Example: USD | Indicate the currency the caller requests to have used in all returned monetary values. Should be Used in conjunction with the element RateRequestType.<br>Example: USD<br><a onclick='loadDocReferen...
requestedShipment.rateRequestType -- Type: array | Example: ['LIST', 'PREFERRED'] | 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.<br>Following are values:<ul><li>LIST - Returns FedEx...
requestedShipment.rateRequestType[] -- Type: string | Valid values: LIST, NONE, PREFERRED, ACCOUNT, INCENTIVE, RETAIL
requestedShipment.recipientLocationNumber -- Type: string | Example: 1234567 | A unique identifier for a recipient location.
requestedShipment.recipients -- Type: array | Indicate the descriptive data for the recipient location to which the shipment is to be received.
requestedShipment.recipients[] -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'FedEx'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}], 'deliveryInstructions': 'Delivery Instructions'} | The descriptive information of the recipient for the shipment and the physical location for the package destination.
requestedShipment.recipients[].address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.recipients[].address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.recipients[].address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.recipients[].address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.recipients[].address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.recipients[].address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.recipients[].address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.recipients[].address.streetLines[] -- Type: string
requestedShipment.recipients[].contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.recipients[].contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.recipients[].contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.recipients[].contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.recipients[].contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.recipients[].contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.recipients[].deliveryInstructions -- Type: string | Example: Instruction 1 | Specify the delivery instructions to be added with the shipment. Use with Ground Home Delivery.<br>Example: Delivery Instructions
requestedShipment.recipients[].tins -- Type: array | This is the tax identification number details.
requestedShipment.recipients[].tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.recipients[].tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.recipients[].tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.recipients[].tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.recipients[].tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.recipients[].tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.requestedPackageLineItems -- Type: array | 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...
requestedShipment.requestedPackageLineItems[] -- Type: object | 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...
requestedShipment.requestedPackageLineItems[].contentRecord -- Type: array | Use this object to specify package content details.
requestedShipment.requestedPackageLineItems[].contentRecord[] -- Type: object | Use this object to specify package content details.
requestedShipment.requestedPackageLineItems[].contentRecord[].description -- Type: string | Example: Description | This is the description of the package item.
requestedShipment.requestedPackageLineItems[].contentRecord[].itemNumber -- Type: string | Example: 2876 | This is a package item number.
requestedShipment.requestedPackageLineItems[].contentRecord[].partNumber -- Type: string | Example: 456 | This is the part number.
requestedShipment.requestedPackageLineItems[].contentRecord[].receivedQuantity -- Type: integer | Format: int32 | Example: 256 | This is the package item quantity.
requestedShipment.requestedPackageLineItems[].customerReferences -- Type: array | This object lists the customer references provided with the package.
requestedShipment.requestedPackageLineItems[].customerReferences[] -- Type: object
requestedShipment.requestedPackageLineItems[].customerReferences[].customerReferenceType -- Type: string | Valid values: CUSTOMER_REFERENCE, DEPARTMENT_NUMBER, INVOICE_NUMBER, P_O_NUMBER, INTRACOUNTRY_REGULATORY_REFERENCE, RMA_ASSOCIATION | Example: INVOICE_NUMBER | This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information.<p>Note: <ul><li>The P_O_NUMBER value must b...
requestedShipment.requestedPackageLineItems[].customerReferences[].value -- Type: string | Example: 3686 | This is a customer reference type value.<br>Example: 3686<br>Note: Maximum length for all customer references is 40 characters excluding customer reference type for 'RMA_ASSCOATION' where maximum c...
requestedShipment.requestedPackageLineItems[].declaredValue -- Type: object | This is the Declared Value of any shipment which represents FedEx maximum liability associated with a shipment. This is including, but not limited to any loss, damage, delay, misdelivery, any failu...
requestedShipment.requestedPackageLineItems[].declaredValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].declaredValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.requestedPackageLineItems[].dimensions -- Type: object | Example: {'length': 100, 'width': 50, 'height': 30, 'units': 'CM'} | Indicate the dimensions of the package.<br> Following conditions will apply: <ul><li>Dimensions are optional but when added, then all three dimensions must be indicated.</li><li>Dimensions are requ...
requestedShipment.requestedPackageLineItems[].dimensions.height -- Type: integer | Format: int32 | Example: 1 | Indicate the height of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].dimensions.length -- Type: integer | Format: int32 | Example: 3 | Indicate the length of the package. No implied decimal places. Maximum value: 999 <br> Example: 20
requestedShipment.requestedPackageLineItems[].dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Indicate the Unit of measure for the provided dimensions.<br>Valid Values are:<li>IN - inches</li><li>CM - centimeters</li>Note: Any value other than CM including blank/null will default to IN.
requestedShipment.requestedPackageLineItems[].dimensions.width -- Type: integer | Format: int32 | Example: 2 | Indicate the width of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].groupPackageCount -- Type: integer | Format: int32 | Example: 2 | Indicate the grouped package count. These are number of identical package(s) each with one or more commodities. <br> Example: 2
requestedShipment.requestedPackageLineItems[].itemDescription -- Type: string | Example: item description for the package | This the item description for the package.<br>Note: Item description is required for Email Label return shipments and ground Create tag.<br>Example: Item description<br> Maximum limit is 50 characters
requestedShipment.requestedPackageLineItems[].itemDescriptionForClearance -- Type: string | Example: description | Describe the content of the package for customs clearance purposes. This applies to intra-UAE, intra-Columbia and intra-Brazil shipments.
requestedShipment.requestedPackageLineItems[].packageSpecialServices -- Type: object | These are special services that are available at the package level for some or all service types.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail -- Type: object | These are detcontentails for the package containing alcohol. This is required for alcohol special service. The alcoholRecipientType is required.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.alcoholRecipientType -- Type: string | Valid values: LICENSEE, CONSUMER | Example: LICENSEE | Specify the Alcohol Recipient Type of the shipment. <br> Example: LICENSEE
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.shipperAgreementType -- Type: string | Example: Retailer | Specify the type of entity, the shipper for alcohol shipment is registered such as fulfillment house, retailer or a winery.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails -- Type: array | Provide details about the batteries or cells that are contained within this specific package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[] -- Type: object
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryMaterialType -- Type: string | Valid values: LITHIUM_METAL, LITHIUM_ION | Indicate the material composition of the battery or cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryPackingType -- Type: string | Valid values: CONTAINED_IN_EQUIPMENT, PACKED_WITH_EQUIPMENT | Describe the packing arrangement of the battery or cell with respect to other items within the same package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryRegulatoryType -- Type: string | Valid values: IATA_SECTION_II | This is a regulation specific classification for the battery or the cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail -- Type: object | Provide dangerous goods shipment details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.accessibility -- Type: string | Valid values: ACCESSIBLE, INACCESSIBLE | Example: INACCESSIBLE | Specify Dangerous Goods Accessibility Type. <ul><li>Inaccessible &ndash; it does not have to be accessable on the aircraft.</li><li>Accessible &ndash; it must be fully accessible on the aircraft, a...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.cargoAircraftOnly -- Type: boolean | Valid values: True, False | A Boolean value that, when True, specifies the mode of shipment transportation should be Cargo Aircraft for Dangerous Goods. Its default value is set as False.<br>Note: An identifier DGD-CAO is add...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options -- Type: array | Example: ['LIMITED_QUANTITIES_COMMODITIES', 'ORM_D'] | Indicate type of DG being reported.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options[] -- Type: string | Valid values: HAZARDOUS_MATERIALS, BATTERY, ORM_D, REPORTABLE_QUANTITIES, SMALL_QUANTITY_EXCEPTION, LIMITED_QUANTITIES_COMMODITIES
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight -- Type: object | Example: {'units': 'KG', 'value': 68} | These are the package weight details.<br>Note: Weight is not required for One rate shipments
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.units -- Type: string | Valid values: KG | Example: KG | Indicate the weight unit type. The package and commodity weight unit should be the same else the request will result in an error.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail -- Type: object | These are COD package details. For use with FedEx Ground services only; COD must be present in shipments special services.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount -- Type: object | Indicate the COD collection amount. Specifies taxes or miscellaneous charge.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.requestedPackageLineItems[].packageSpecialServices.pieceCountVerificationBoxCount -- Type: integer | Format: int32 | Specify the count.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail -- Type: object | Specifies the Priority Alert Detail.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.content -- Type: array | Example: ['string'] | Specifies Content for the Priority Alert Detail.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.content[] -- Type: string
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.enhancementTypes -- Type: array | Example: ['PRIORITY_ALERT_PLUS'] | The types of all enhancement for the Priority Alert.<br>Example: PRIORITY_ALERT_PLUS
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.enhancementTypes[] -- Type: string
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionDetail -- Type: object | This element specifies Signature option details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionDetail.signatureReleaseNumber -- Type: string | Example: 23456 | This is release number.<br>Example: 23456
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionType -- Type: string | Valid values: SERVICE_DEFAULT, NO_SIGNATURE_REQUIRED, INDIRECT, DIRECT, ADULT | Example: ADULT | Indicate the Signature Type. <br>Valid Values: <ul><li>ADULT - Adult signature required, at recipient address.</li><li>DIRECT - Signature required, at recipient address.</li><li>INDIRECT - Signatur...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes -- Type: array | Example: ['ALCOHOL', 'NON_STANDARD_CONTAINER'] | Indicate the types of special services requested for the shipment.<br><a onclick='loadDocReference("packagelevelspecialservicetypes")'>click here to see Package Special Service Types</a>
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes[] -- Type: string
requestedShipment.requestedPackageLineItems[].sequenceNumber -- Type: integer | Example: 1 | Optional. <br>Used only with individual packages as a unique identifier of each requested package. Will be adjusted at the shipment level as pieces are added.
requestedShipment.requestedPackageLineItems[].subPackagingType -- Type: string | Example: BUCKET | Indicate the subPackagingType, if you are using your own packaging for the shipment. Use it for all shipments inbound to Canada (CA) and inbound shipments to the U.S. and Puerto Rico (PR) from Cana...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail -- Type: object | Indicate the details about how to calculate variable handling charges at the shipment level. They can be based on a percentage of the shipping charges or a fixed amount. If indicated, element rateL...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue -- Type: object | Example: {'amount': 24.45, 'currency': 'USD'} | 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. <br>Example: 5.00. Specifies taxes or...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45 fixed variable handling charge amount
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a> fixed variable handling charge currency type<br><a o...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.percentValue -- Type: number | Format: double | Example: 12.45 | This is the variable handling percentage. If the percent value is mentioned as 10, it means 10%(multiplier of 0.1).<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateElementBasis -- Type: string | Valid values: NET_CHARGE, NET_FREIGHT, BASE_CHARGE, NET_CHARGE_EXCLUDING_TAXES | Example: NET_CHARGE_EXCLUDING_TAXES | Specify the charge type upon which the variable handling percentage amount is calculated.
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Example: INDIVIDUAL_PACKAGE_RATE | Specifies if the rate level type is either Individual or Bundled.
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateType -- Type: string | Valid values: ACCOUNT, ACTUAL, CURRENT, CUSTOM, LIST, INCENTIVE, PREFERRED, PREFERRED_INCENTIVE, PREFERRED_CURRENCY | Example: PREFERRED_CURRENCY | This is the rate type used for this package.
requestedShipment.requestedPackageLineItems[].weight -- Type: object | Example: {'units': 'KG', 'value': 68} | These are the package weight details.<br>Note: Weight is not required for One rate shipments
requestedShipment.requestedPackageLineItems[].weight.units -- Type: string | Valid values: KG | Example: KG | Indicate the weight unit type. The package and commodity weight unit should be the same else the request will result in an error.
requestedShipment.requestedPackageLineItems[].weight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.serviceType -- Type: string | Example: PRIORITY_OVERNIGHT | Indicate the FedEx service type used for this shipment.<br>Example: STANDARD_OVERNIGHT<br><a onclick='loadDocReference("servicetypes")'>click here to see Service Types</a>
requestedShipment.shipDatestamp -- Type: string | Example: 2019-10-14 | This is the shipment date. Default value is current date in case the date is not provided or a past date is provided.<br>Format [YYYY-MM-DD].<br>Example: 2019-10-14
requestedShipment.shipmentSpecialServices -- Type: object | Specify the special services requested at the shipment level.<br>If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail -- Type: object | Indicate the Delivery On Invoice Acceptance detail. Recipient is required for Delivery On Invoice Special service.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'FedEx'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}], 'deliveryInstructions': 'Delivery Instructions'} | The descriptive data for the recipient of the shipment and the physical location for the shipment destination. The descriptive information of the recipient for the shipment and the physical locatio...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a> The two-letter code used to identify...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory. Identifies the company this contact is associated with. Maximum length is 35.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor Identifies the contact person's name. Maximum length is 70.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.deliveryInstructions -- Type: string | Example: Instruction 1 | Specify the delivery instructions to be added with the shipment. Use with Ground Home Delivery.<br>Example: Delivery Instructions
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins -- Type: array | This is the tax identification number details.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shipmentSpecialServices.etdDetail -- Type: object | Use this object to specify all information on how the electronic Trade document references used with the shipment.
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments -- Type: array | 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 val...
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[] -- Type: object | Specify the document upload reference details.
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].description -- Type: string | Example: PRO FORMA INVOICE | Specify additional information about the uploaded document for better understanding.<br>Example: Certificate of Origin is uploaded for country of manufacturing verification.
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].documentId -- Type: string | Example: 090927d680038c61 | This is the uploaded document ID value.<br>Example: 090927d680038c61
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].documentReference -- Type: string | Example: DocumentReference | Specify the reference for the uploaded document.This is for the customer to reference their uploaded docs when they retrieve them. Could be anything, order number, po number, whatever the customer ...
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].documentType -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, ETD_LABEL, USMCA_CERTIFICATION_OF_ORIGIN, OTHER, PRO_FORMA_INVOICE, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN | Example: PRO_FORMA_INVOICE | Specify document type for the uploaded document. It should match with the type of uploaded document associated with documentId.
requestedShipment.shipmentSpecialServices.etdDetail.attributes -- Type: array | Use this attribute to specify if the Trade documents will be uploaded post the shipment.
requestedShipment.shipmentSpecialServices.etdDetail.attributes[] -- Type: string | Valid values: POST_SHIPMENT_UPLOAD_REQUESTED
requestedShipment.shipmentSpecialServices.etdDetail.requestedDocumentTypes -- Type: array | Example: ['VICS_BILL_OF_LADING', 'GENERAL_AGENCY_AGREEMENT'] | 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.<br>Note: For more information...
requestedShipment.shipmentSpecialServices.etdDetail.requestedDocumentTypes[] -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, CUSTOM_PACKAGE_DOCUMENT, CUSTOM_SHIPMENT_DOCUMENT, CUSTOMER_SPECIFIED_LABELS, EXPORT_DECLARATION, DANGEROUS_GOODS_SHIPPERS_DECLARATION, GENERAL_AGENCY_AGREEMENT, LABEL, USMCA_CERTIFICATION_OF_ORIGIN, OP_900, PENDING_SHIPMENT_EMAIL_NOTIFICATION, PRO_FORMA_INVOICE, RETURN_INSTRUCTIONS, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN
requestedShipment.shipmentSpecialServices.holdAtLocationDetail -- Type: object | Use this object to specify required information for a shipment to be held at destination FedEx location.<br><i>Note: This object HoldAtLocationDetail is Required, when HOLD_AT_LOCATION is chosen in...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Specifies the contact and address details of a location.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationId -- Type: string | Example: YBZA | This is an alphanumeric identifier used for Location/Facility Identification.<br>Example: YBZA<br>Note: <ul><li>For HAL Shipment, Location ID is <b>REQUIRED</b> to ensure packages are delivered to ...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationType -- Type: string | Valid values: FEDEX_AUTHORIZED_SHIP_CENTER, FEDEX_OFFICE, FEDEX_SELF_SERVICE_LOCATION, FEDEX_STAFFED, RETAIL_ALLICANCE_LOCATION, FEDEX_GROUND_TERMINAL, FEDEX_ONSITE | Example: FEDEX_ONSITE | Specifies the type of facility at which package/shipment is to be held.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail -- Type: object | These are Special service elements for FedEx Ground Home Delivery shipments. If selected, element homedeliveryPremiumType is mandatory.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.deliveryDate -- Type: string | Example: 2019-06-26 | This is delivery date. Required for FedEx Date Certain Home Delivery. Valid dates are Monday to Sunday. <br>There may be a delay in delivery on Sundays to locations that are geographically difficul...
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.homedeliveryPremiumType -- Type: string | Valid values: APPOINTMENT, DATE_CERTAIN, EVENING | Example: APPOINTMENT | 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 appointme...
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber -- Type: object | Example: {'areaCode': '901', 'localNumber': '3575012', 'extension': '200', 'personalIdentificationNumber': '98712345'} | Indicate the phone number. Only numeric values allowed.<br> Note that phoneNumber is mandatory when homedeliveryPremiumType is DATE_CERTAIN or EVENING.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.areaCode -- Type: string | Indicate the area code for the phone number.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.extension -- Type: string | Indicate the extension for the phone number.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.localNumber -- Type: string | Indicate the local phone number for contacting in the event of an emergency. Maximum length  is 10.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.personalIdentificationNumber -- Type: string | Indicate the Personal Identification Number associated with the phone number.
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail -- Type: object | Use this object to specify International Controlled Export shipment Details.<br>Note: licenseOrPermitExpirationDate and licenseOrPermitNumber are not required when type is WAREHOUSE_WITHDRAWAL.
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.entryNumber -- Type: string | Example: 125 | Indicate Entry Number for the export.<br>Example: 125
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.foreignTradeZoneCode -- Type: string | Example: US | Indicate the Foreign Trade Zone Code.<br>Example: US
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.licenseOrPermitExpirationDate -- Type: string | Example: 2019-12-03 | Indicate the expiration date for the license or permit. The format is YYYY-MM-DD.<br>Example: "2019-12-03"
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.licenseOrPermitNumber -- Type: string | Example: 11 | Indicate License Or Permit Number for the commodity being exported.<br>Example: 11
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.type -- Type: string | Valid values: DEA_036, DEA_236, DSP_05, DSP_61, DSP_73, DSP_85, DSP_LICENSE_AGREEMENT, WAREHOUSE_WITHDRAWAL | Example: WAREHOUSE_WITHDRAWAL | Indicate International Controlled Export Type.
requestedShipment.shipmentSpecialServices.internationalTrafficInArmsRegulationsDetail -- Type: object | These are International Traffic In Arms Regulations shipment service details.
requestedShipment.shipmentSpecialServices.internationalTrafficInArmsRegulationsDetail.licenseOrExemptionNumber -- Type: string | Example: 9871234 | The export or license number for the ITAR shipment.<br>Minimum length is 5 characters.<br>Maximum length is 21 characters.<br>Example: 9871234
requestedShipment.shipmentSpecialServices.pendingShipmentDetail -- Type: object | This object is used to specify the Pending Shipment Type for Email label.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments -- Type: array | These are the reference document details with the shipment.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[] -- Type: object | Specify the document upload reference details.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].description -- Type: string | Example: PRO FORMA INVOICE | This is the document description of the attached document.<br>Example: PRO FORMA INVOICE
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].documentId -- Type: string | Example: 090927d680038c61 | This is the uploaded document ID value.<br>Example: 090927d680038c61
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].documentReference -- Type: string | Example: DocumentReference | Specify the reference for the uploaded document.<br>Example: Reference
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].documentType -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, ETD_LABEL, USMCA_CERTIFICATION_OF_ORIGIN, NET_RATE_SHEET, OTHER, PRO_FORMA_INVOICE, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN | Example: PRO_FORMA_INVOICE | This is the uploaded document type.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail -- Type: object | These are specific information about the pending email label.<br>Required when PendingShipmentType is EMAIL.<br>Not applicable for CreateTag.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.message -- Type: string | Example: your optional message | This is an optional personalized message to be included in the email to the recipient.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients -- Type: array | This is Email label recipient email address, shipment role, & language locale details. Atleast one entry must be specified.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[] -- Type: object | These are the recipient details for the online email return label.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].emailAddress -- Type: string | Example: neena@fedex.com | This is recipient email address for notifying the return label. Maximum length 200 characters.<br> Example: neena@abc.com
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested -- Type: object | These are to indicate how the email notifications for the pending shipment to be processed.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested.options -- Type: array | Example: ['PRODUCE_PAPERLESS_SHIPPING_FORMAT', 'SUPPRESS_ACCESS_EMAILS'] | These are the processing options.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested.options[] -- Type: string | Valid values: PRODUCE_PAPERLESS_SHIPPING_FORMAT, SUPPRESS_ADDITIONAL_LANGUAGES, SUPPRESS_ACCESS_EMAILS
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].role -- Type: string | Valid values: SHIPMENT_COMPLETOR, SHIPMENT_INITIATOR | This is to specify Recipient role in the shipment.Shipment completor role is needed when we pass shipment initiator. We cannot use shipment initiator alone.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.expirationTimeStamp -- Type: string | Example: 2020-01-01 | 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.<b...
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.pendingShipmentType -- Type: string | Valid values: EMAIL | Example: EMAIL | This is Pending Shipment Type. Must include the value 'EMAIL' for email return shipments.<br>Not applicable for other types of shipments.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions -- Type: object | Use this object to allow the Email Label shipment originator,  specify if the Email label shipment completer can make modifications to editable shipment data.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions.options -- Type: array | Example: ['ALLOW_MODIFICATIONS'] | These are processing options.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions.options[] -- Type: string | Valid values: ALLOW_MODIFICATIONS
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification -- Type: object | These are documents that are recommended to be included with the shipment.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification.types -- Type: array | Example: ANTIQUE_STATEMENT_EUROPEAN_UNION | This is the recommended document Type.<br><a onclick='loadDocReference("shipmentdocumenttype")'>click here to see shipment document type</a>
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification.types[] -- Type: string | Valid values: ANTIQUE_STATEMENT_EUROPEAN_UNION, ANTIQUE_STATEMENT_UNITED_STATES, ASSEMBLER_DECLARATION, BEARING_WORKSHEET, CERTIFICATE_OF_SHIPMENTS_TO_SYRIA, COMMERCIAL_INVOICE_FOR_THE_CARIBBEAN_COMMON_MARKET, CONIFEROUS_SOLID_WOOD_PACKAGING_MATERIAL_TO_THE_PEOPLES_REPUBLIC_OF_CHINA, DECLARATION_FOR_FREE_ENTRY_OF_RETURNED_AMERICAN_PRODUCTS, DECLARATION_OF_BIOLOGICAL_STANDARDS, DECLARATION_OF_IMPORTED_ELECTRONIC_PRODUCTS_SUBJECT_TO_RADIATION_CONTROL_STANDARD, ELECTRONIC_INTEGRATED_CIRCUIT_WORKSHEET, FILM_AND_VIDEO_CERTIFICATE, INTERIM_FOOTWEAR_INVOICE, USMCA_CERTIFICATION_OF_ORIGIN_CANADA_ENGLISH, USMCA_CERTIFICATION_OF_ORIGIN_CANADA_FRENCH, USMCA_CERTIFICATION_OF_ORIGIN_SPANISH, USMCA_CERTIFICATION_OF_ORIGIN_UNITED_STATES, PACKING_LIST, PRINTED_CIRCUIT_BOARD_WORKSHEET, REPAIRED_WATCH_BREAKOUT_WORKSHEET, STATEMENT_REGARDING_THE_IMPORT_OF_RADIO_FREQUENCY_DEVICES, TOXIC_SUBSTANCES_CONTROL_ACT, UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERSHIP_ACT_CERTIFICATE_OF_ORIGIN_TEXTILES, UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERSHIP_ACT_CERTIFICATE_OF_ORIGIN_NON_TEXTILES, UNITED_STATES_NEW_WATCH_WORKSHEET, UNITED_STATES_WATCH_REPAIR_DECLARATION
requestedShipment.shipmentSpecialServices.returnShipmentDetail -- Type: object | Use this object for specifying return shipment details.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail -- Type: object | Specifies the details of an outbound shipment in order to associate the return shipment to it.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail.shipDatestamp -- Type: string | Example: 2019-10-01 | This is the ship date for the outbound shipment associated with a return shipment. The format is YYYY-MM-DD.<br> Example: 2019-10-01
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail.trackingNumber -- Type: string | Example: 123456789 | This is the tracking number associated with this package.<br>Example: 49XXX0000XXX20032835
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail -- Type: object | These are email details for the return shipment.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail.allowedSpecialService -- Type: array | Indicate the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created.<br>Only services represented in EmailLabelAllowedSpecialServiceType will b...
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail.allowedSpecialService[] -- Type: string | Valid values: SATURDAY_DELIVERY, SATURDAY_PICKUP | Example: SATURDAY_DELIVERY
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail.merchantPhoneNumber -- Type: string | Example: 19012635656 | This is the merchant phone number and required for Email Return Labels.<br>Example: 19012635656
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnType -- Type: string | Valid values: PENDING, PRINT_RETURN_LABEL | Example: PRINT_RETURN_LABEL | 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 mu...
requestedShipment.shipmentSpecialServices.returnShipmentDetail.rma -- Type: object | This is a Return Merchant Authorization (RMA) for the return shipment.<br> Reason for the requirement is mandatory.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.rma.reason -- Type: string | Example: Wrong Size or Color | Specify the reason for the return.<br> Note: There is no validation for reason. Recommended length is 60 alpha-numeric characters<br>Example: Wrong color or size.
requestedShipment.shipmentSpecialServices.shipmentCODDetail -- Type: object | This is the shipment level COD detail.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail -- Type: object | Use this object to specify C.O.D. transportation charges.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.chargeLevelType -- Type: string | Valid values: CURRENT_PACKAGE, SUM_OF_PACKAGES | Specify which level the charges to be applied.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.chargeType -- Type: string | Valid values: COD_SURCHARGE, NET_CHARGE, NET_FREIGHT, TOTAL_CUSTOMER_CHARGE | Specify Charge type.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Specify which level the rate to be applied.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.rateType -- Type: string | Valid values: ACCOUNT, CURRENT, CUSTOM | Specify the Rate Type used.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount -- Type: object | Indicate the COD collection amount. Specifies taxes or miscellaneous charge.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionType -- Type: string | Valid values: ANY, CASH, GUARANTEED_FUNDS, COMPANY_CHECK, PERSONAL_CHECK | Identifies the type of funds FedEx should collect upon shipment delivery
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | Descriptive data of the Cash On Delivery along with their details of the physical location.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins -- Type: array | This is the tax identification number details.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Specifies the contact and address details of a location.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.remitToName -- Type: string | Example: remitToName | Specify the name of the person or company receiving the secured/unsecured funds payment.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.returnReferenceIndicatorType -- Type: string | Valid values: INVOICE, PO, REFERENCE, TRACKING | Indicate return reference type information to include on the COD return shipping label.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount -- Type: object | Indicate the COD amount for this shipment. Specifies taxes or miscellaneous charge.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail -- Type: object | This is the descriptive data required for a FedEx shipment containing dangerous materials. This element is required when SpecialServiceType DRY_ICE is selected.<p><i>Note:<ul><li>Dry Ice is a Packa...
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.packageCount -- Type: integer | Format: int32 | Example: 12 | Indicates the total number of packages in the shipment that contain dry ice.<br>Example: 12
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight -- Type: object | Example: {'units': 'LB', 'value': 10} | These are the package weight details.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.units -- Type: string | Valid values: KG, LB | Example: LB | This is the package weight unit. For Dry Ice the unit of measure is KG.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.shipmentSpecialServices.specialServiceTypes -- Type: array | Example: ['THIRD_PARTY_CONSIGNEE', 'PROTECTION_FROM_FREEZING'] | Special services requested for the shipment.<br>Example: <ul><li>HOLD_AT_LOCATION</li><li>RETURN_SHIPMENT</li><li>BROKER_SELECT_OPTION</li><li>CALL_BEFORE_DELIVERY</li><li>COD</li><li>CUSTOM_DELIVE...
requestedShipment.shipmentSpecialServices.specialServiceTypes[] -- Type: string
requestedShipment.shipper -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': 'XXXX567890', 'companyName': 'Fedex'}, 'tins': [{'number': 'XXX567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | Indicate the Shipper contact details for this shipment.
requestedShipment.shipper.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipper.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shipper.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipper.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shipper.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipper.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipper.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shipper.address.streetLines[] -- Type: string
requestedShipment.shipper.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shipper.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.shipper.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipper.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.shipper.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipper.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shipper.tins -- Type: array | This is the tax identification number details.
requestedShipment.shipper.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shipper.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipper.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipper.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shipper.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shipper.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shippingChargesPayment -- Type: object | Example: {'paymentType': 'SENDER', 'payor': {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': 'XXXX567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}}}} | Specifies the payment details specifying the method and means of payment to FedEx for providing shipping services.
requestedShipment.shippingChargesPayment.paymentType -- Type: string | Valid values: SENDER, RECIPIENT, THIRD_PARTY, COLLECT | Specifies the payment Type. <br>Note: This is required for Express, Ground and SmartPost shipments.<br> The payment type COLLECT is applicable only for Ground shipments.
requestedShipment.shippingChargesPayment.payor -- Type: object | Example: {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': 'XXXX567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}}} | Payor is mandatory when the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.shippingChargesPayment.payor.responsibleParty -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'FedEx'}, 'accountNumber': {'value': 'Your account number'}} | Indicate the payer Information responsible for paying for the shipment. <br>Note: ResponsibleParty accountNumber is required for ACCOUNT based services.
requestedShipment.shippingChargesPayment.payor.responsibleParty.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.shippingChargesPayment.payor.responsibleParty.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.shippingChargesPayment.payor.responsibleParty.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.streetLines[] -- Type: string
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shippingDocumentSpecification -- Type: object | Use this object to provide all data required for additional (non-label) shipping documents to be produced.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin -- Type: object | The instructions indicating how to print the Certificate of Origin ( e.g. whether or not to include the instructions, image type, etc ...)
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail -- Type: object | The instructions indicating how to print the Commercial Invoice( e.g. image type) Specifies characteristics of a shipping document to be produced.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail -- Type: object | Use this object to specify details to generate general agency agreement detail.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.op900Detail -- Type: object | Use this object to specify details to generate the OP-900 document for hazardous material packages.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages -- Type: array | Specify the use and identification of supplied images to be used on document.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.op900Detail.signatureName -- Type: string | Example: Signature Name | Indicates the name to be printed as signature on the document instead of (or in addition to) a signature image.<br>Example: John Hill
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail -- Type: object | These are return instruction details which will be returned in the transaction to be printed on Return Label.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.customText -- Type: string | Example: This is additional text printed on Return instr | Specify additional information (text) to be inserted into the return document.<br>Example: This is additional text printed on Return Label
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat -- Type: object | These are characteristics of a shipping document to be produced.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions -- Type: array | Details on creating, organizing, and returning the document.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.docType -- Type: string | Valid values: PNG, PDF | Example: PNG | Specify the image format used for shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.locale -- Type: string | Example: en_US" | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Use this element to indicate whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Specify the label stock type.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.shippingDocumentTypes -- Type: array | Example: ['RETURN_INSTRUCTIONS', 'DANGEROUS_GOODS_SHIPPERS_DECLARATION'] | Indicates the types of shipping documents requested.
requestedShipment.shippingDocumentSpecification.shippingDocumentTypes[] -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, CUSTOM_PACKAGE_DOCUMENT, CUSTOM_SHIPMENT_DOCUMENT, CUSTOMER_SPECIFIED_LABELS, EXPORT_DECLARATION, DANGEROUS_GOODS_SHIPPERS_DECLARATION, GENERAL_AGENCY_AGREEMENT, LABEL, USMCA_CERTIFICATION_OF_ORIGIN, OP_900, PENDING_SHIPMENT_EMAIL_NOTIFICATION, PRO_FORMA_INVOICE, RETURN_INSTRUCTIONS, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail -- Type: object | The instructions indicating how to print the USMCA Certificate of Origin (e.g. whether or not to include the instructions, image type, etc ...).
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod -- Type: object | Date Range for custom delivery request; only used if type is BETWEEN.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod.begins -- Type: string | Example: 22-01-2020 | Indicates the start date.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod.ends -- Type: string | Example: 2-01-2020 | Indicates the end date.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.certifierJobTitle -- Type: string | Example: Manager | Specify the job title of the certifier
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.certifierSpecification -- Type: string | Valid values: EXPORTER, IMPORTER, PRODUCER | Example: EXPORTER | This is certifier specification.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.importerSpecification -- Type: string | Valid values: UNKNOWN, VARIOUS | Example: UNKNOWN | This is importer specification.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br>Example: Beverly Hills
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.geographicCoordinates -- Type: string | Example: geographicCoordinates | Indicates the geographic coordinates. <br> example: geographicCoordinates
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.postalCode -- Type: string | Example: 90210 | This is the Postal code.<br>This is Optional for non postal-aware countries.<br>Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Po...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.streetLines[] -- Type: string
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation of the company name.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.faxNumber -- Type: string | Specify contact person's fax number. Maximum length is 15.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br> Example: John Taylor
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. <br>Minimum length is 10 and supports Maximum as 15 for certain countries using longer phone numbers. <br>Note: Recommended Maximum length is 15 and there's no specifi...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins -- Type: array | This is the tax identification number details.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producerSpecification -- Type: string | Valid values: AVAILABLE_UPON_REQUEST, VARIOUS, SAME_AS_EXPORTER | Example: SAME_AS_EXPORTER | This is producer specification.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail -- Type: object | The instructions indicating commercial invoice certification of origin.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.certifierJobTitle -- Type: string | Example: Manager | Specify the job title of the certifier
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.certifierSpecification -- Type: string | Valid values: EXPORTER, IMPORTER, PRODUCER | Example: EXPORTER | This is certifier specification.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.importerSpecification -- Type: string | Valid values: UNKNOWN, VARIOUS | Example: UNKNOWN | This is importer specification.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br>Example: Beverly Hills
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.geographicCoordinates -- Type: string | Example: geographicCoordinates | Indicates the geographic coordinates. <br> example: geographicCoordinates
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.postalCode -- Type: string | Example: 90210 | This is the Postal code.<br>This is Optional for non postal-aware countries.<br>Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Po...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.streetLines[] -- Type: string
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation of the company name.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.faxNumber -- Type: string | Specify contact person's fax number. Maximum length is 15.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br> Example: John Taylor
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. <br>Minimum length is 10 and supports Maximum as 15 for certain countries using longer phone numbers. <br>Note: Recommended Maximum length is 15 and there's no specifi...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins -- Type: array | This is the tax identification number details.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producerSpecification -- Type: string | Valid values: AVAILABLE_UPON_REQUEST, VARIOUS, SAME_AS_EXPORTER | Example: SAME_AS_EXPORTER | This is producer specification.
requestedShipment.smartPostInfoDetail -- Type: object | Use this object to specify the smartpost shipment details. <br>Required for SMARTPOST service. If SmartPostInfoDetail is indicated, the elements below it are also required.
requestedShipment.smartPostInfoDetail.ancillaryEndorsement -- Type: string | Valid values: ADDRESS_CORRECTION, CARRIER_LEAVE_IF_NO_RESPONSE, CHANGE_SERVICE, FORWARDING_SERVICE, RETURN_SERVICE | Example: RETURN_SERVICE | Indicate the type of ancillary endorsement. Is required for Presorted Standard but not for returns or parcel select. <br>Note: Not all are usable for all ancillary endorsements.<br>For more informa...
requestedShipment.smartPostInfoDetail.hubId -- Type: string | Example: 5015 | Specify the four-digit numeric Hub ID value used for smartport shipments.<br><a onclick='loadDocReference("smartposthubids")'>click here to see Hub Ids</a>
requestedShipment.smartPostInfoDetail.indicia -- Type: string | Valid values: MEDIA_MAIL, PARCEL_RETURN, PARCEL_SELECT, PRESORTED_BOUND_PRINTED_MATTER, PRESORTED_STANDARD | Example: PRESORTED_STANDARD | Specify the indicia type.<br>Available options include:<ul><li>MEDIA_MAIL</li><li>PARCEL_SELECT (1 LB through 70 LB)</li><li>PRESORTED_BOUND_PRINTED_MATTER</li><li>PRESORTED_STANDARD (less than 1 L...
requestedShipment.smartPostInfoDetail.specialServices -- Type: string | Valid values: USPS_DELIVERY_CONFIRMATION | Example: USPS_DELIVERY_CONFIRMATION | Specify the special handling associated with Smartpost Shipment.
requestedShipment.soldTo -- Type: object | 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 par...
requestedShipment.soldTo.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.soldTo.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.soldTo.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.soldTo.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.soldTo.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.soldTo.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.soldTo.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.soldTo.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.soldTo.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.soldTo.address.streetLines[] -- Type: string
requestedShipment.soldTo.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.soldTo.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.soldTo.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.soldTo.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.soldTo.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.soldTo.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.soldTo.tins -- Type: array | Used for adding the tax id
requestedShipment.soldTo.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.soldTo.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.soldTo.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.soldTo.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.soldTo.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.soldTo.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.totalDeclaredValue -- Type: object | 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...
requestedShipment.totalDeclaredValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.totalDeclaredValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.totalPackageCount -- Type: integer | Format: int32 | Example: 25 | For an MPS, this is the total number of packages in the shipment.Applicable for parent shipment for one label at a time shipments. <br>Example: 25
requestedShipment.totalWeight -- Type: number | Format: double | Example: 20.6 | Indicate the shipment total weight in pounds.<br>Example: 10.6<br>Note: <ul><li>This only applies to International shipments and should be used on the first package of a multiple piece shipment.</l...
requestedShipment.variableHandlingChargeDetail -- Type: object | Indicate the details about how to calculate variable handling charges at the shipment level. They can be based on a percentage of the shipping charges or a fixed amount. If indicated, element rateL...
requestedShipment.variableHandlingChargeDetail.fixedValue -- Type: object | Example: {'amount': 24.45, 'currency': 'USD'} | 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. <br>Example: 5.00. Specifies taxes or...
requestedShipment.variableHandlingChargeDetail.fixedValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45 fixed variable handling charge amount
requestedShipment.variableHandlingChargeDetail.fixedValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a> fixed variable handling charge currency type<br><a o...
requestedShipment.variableHandlingChargeDetail.percentValue -- Type: number | Format: double | Example: 12.45 | This is the variable handling percentage. If the percent value is mentioned as 10, it means 10%(multiplier of 0.1).<br>Example: 12.45
requestedShipment.variableHandlingChargeDetail.rateElementBasis -- Type: string | Valid values: NET_CHARGE, NET_FREIGHT, BASE_CHARGE, NET_CHARGE_EXCLUDING_TAXES | Example: NET_CHARGE_EXCLUDING_TAXES | Specify the charge type upon which the variable handling percentage amount is calculated.
requestedShipment.variableHandlingChargeDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Example: INDIVIDUAL_PACKAGE_RATE | Specifies if the rate level type is either Individual or Bundled.
requestedShipment.variableHandlingChargeDetail.rateType -- Type: string | Valid values: ACCOUNT, ACTUAL, CURRENT, CUSTOM, LIST, INCENTIVE, PREFERRED, PREFERRED_INCENTIVE, PREFERRED_CURRENCY | Example: PREFERRED_CURRENCY | This is the rate type used for this package.
shipAction -- Type: string | Valid values: CONFIRM, TRANSFER | Example: CONFIRM | Indicate shipment action for the Shipment. <ul><li>CONFIRM &ndash; used in case of shipment submission</li><li>TRANSFER &ndash; used in case of Email Label Shipment or Pending Shipment submission.

Cancel Shipment

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
accountNumber -- Type: object | Example: {'value': 'Your account number'} | The account number (account value) associated with the shipment. The account number associated with the shipment.
accountNumber.value -- Type: string | The account number value. Maximum length is 9 .<br>Example: Your account number
deletionControl -- Type: string | Valid values: DELETE_ALL_PACKAGES, DELETE_ONE_PACKAGE | Example: DELETE_ONE_PACKAGE | Specifies which packages in a shipment to be canceled.<br>  Valid Values are<br><b>DELETE_ONE_PACKAGE</b> which will cancel only the single package indicated in the trackingNumber element below.<br...
senderCountryCode -- Type: string | Example: US | The two-letter sender Country code(Ex: US, CA, GB..etc).<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
trackingNumber -- Type: string | Example: 794953555571 | This is an unique number assigned by FedEx to the packages for tracking.<br>Example: "794953555571"

Validate Shipment

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
accountNumber -- Type: object | Example: {'value': 'Your account number'} | The account number associated with the shipment.
accountNumber.value -- Type: string | The account number value. Maximum length is 9 .<br>Example: Your account number
requestedShipment -- Type: object | This is the detailed shipment request data to be validated before being submitted to FedEx.
requestedShipment.blockInsightVisibility -- Type: boolean | Example: True | 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 said tool.
requestedShipment.customsClearanceDetail -- Type: object | These are customs clearance details. Required for International and intra-country Shipments.
requestedShipment.customsClearanceDetail.brokers -- Type: array | 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 ...
requestedShipment.customsClearanceDetail.brokers[] -- Type: object | Example: {'broker': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 91, 'companyName': 'Fedex', 'faxNumber': 1234567}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}], 'deliveryInstructions': 'deliveryInstructions'}, 'type': 'IMPORT'} | These are broker details for the shipment.
requestedShipment.customsClearanceDetail.brokers[].broker -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | These are broker details for the shipment with physical address, contact and account number information.
requestedShipment.customsClearanceDetail.brokers[].broker.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.customsClearanceDetail.brokers[].broker.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.customsClearanceDetail.brokers[].broker.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.customsClearanceDetail.brokers[].broker.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.customsClearanceDetail.brokers[].broker.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.customsClearanceDetail.brokers[].broker.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.customsClearanceDetail.brokers[].broker.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.customsClearanceDetail.brokers[].broker.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.customsClearanceDetail.brokers[].broker.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.customsClearanceDetail.brokers[].broker.address.streetLines[] -- Type: string
requestedShipment.customsClearanceDetail.brokers[].broker.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment. Specifies broker contact details.
requestedShipment.customsClearanceDetail.brokers[].broker.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.customsClearanceDetail.brokers[].broker.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.customsClearanceDetail.brokers[].broker.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.customsClearanceDetail.brokers[].broker.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.customsClearanceDetail.brokers[].broker.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.customsClearanceDetail.brokers[].broker.tins -- Type: array | This is the tax identification number details.
requestedShipment.customsClearanceDetail.brokers[].broker.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.customsClearanceDetail.brokers[].type -- Type: string | Valid values: IMPORT | Example: IMPORT | Identifies the type of broker.
requestedShipment.customsClearanceDetail.commercialInvoice -- Type: object | Use this object to provide Commercial Invoice details. This element is required for electronic upload of CI data. It will serve to create/transmit an electronic Commercial Invoice through the FedEx...
requestedShipment.customsClearanceDetail.commercialInvoice.comments -- Type: array | Example: ['optional comments for the commercial invoice'] | 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 i...
requestedShipment.customsClearanceDetail.commercialInvoice.comments[] -- Type: string
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences -- Type: array | These are additional customer reference data for commercial invoice.
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences[] -- Type: object
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences[].customerReferenceType -- Type: string | Valid values: INVOICE_NUMBER, P_O_NUMBER | Example: INVOICE_NUMBER | This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information.<p>Note: <ul><li>The P_O_NUMBER value must b...
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences[].value -- Type: string | Example: 3686 | This is a customer reference type value.<br>Example: 3686<br>Note: Maximum length for all customer references is 40 characters.
requestedShipment.customsClearanceDetail.commercialInvoice.declarationStatement -- Type: string | Example: declarationStatement | This is the declaration statement which will populate the Commercial Invoice (or Pro Forma).<br>Maximum length is 554.<br>Example: declarationStatement
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail -- Type: object | These are email disposition details. Provides the type and email addresses of e-mail recipients. If returnedDispositionDetail in labelSpecification is set as true then email will be send with label...
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.emailAddress -- Type: string | Example: neena@fedex.com | This is email Address.<br>Example: xxxx@xxx.com
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.recipientType -- Type: string | Example: SHIPPER | Specify the recipient Type.<br>Example: SHIPPER/BROKER
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.type -- Type: string | Example: EMAILED | Specify the email status.<br>Example: EMAILED
requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge -- Type: object | Indicate the freight charge. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts -- Type: object | Indicate the handling cost. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.originatorName -- Type: string | Example: originator Name | The originator name that will populate the Commercial Invoice (or Pro Forma).
requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts -- Type: object | Indicate the packing cost. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.shipmentPurpose -- Type: string | Valid values: GIFT, NOT_SOLD, PERSONAL_EFFECTS, REPAIR_AND_RETURN, SAMPLE, SOLD | Example: REPAIR_AND_RETURN | This is the reason for the shipment. <br>Note: SOLD is not a valid purpose for a Proforma Invoice.
requestedShipment.customsClearanceDetail.commercialInvoice.specialInstructions -- Type: string | Example: specialInstructions" | These are special instructions that will be populated on the Commercial Invoice (or Pro Forma).<br>Example: specialInstructions
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge -- Type: object | Indicate the taxes or miscellaneous charges(other than freight charges or insurance charges) that are associated with the shipment. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousChargeType -- Type: string | Valid values: COMMISSIONS, DISCOUNTS, HANDLING_FEES, OTHER, ROYALTIES_AND_LICENSE_FEES, TAXES | Example: COMMISSIONS | Indicate the type of taxes Or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.termsOfSale -- Type: string | Example: FCA | Specify terms Of Sale that will be populated on the Commercial Invoice (or Pro Forma). Maximum length is 3<br>Valid values are:<ul><li>FCA/FOB (Free Carrier/Free On Board): Seller is responsible fo...
requestedShipment.customsClearanceDetail.commodities -- Type: array | Indicates the details about the dutiable packages. Maximum upto 999 commodities per shipment.
requestedShipment.customsClearanceDetail.commodities[] -- Type: object
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures -- Type: array | This object contains additional quantitative information other than weight and quantity to calculate duties and taxes.
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures[] -- Type: object
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures[].quantity -- Type: number | Format: double | Example: 12.45 | Specify commodity quantity.
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures[].units -- Type: string | Example: KG | Unit of measure used to express the quantity of this commodity line item.
requestedShipment.customsClearanceDetail.commodities[].cIMarksAndNumbers -- Type: string | Example: 87123 | This is an identifying mark or number used on the packaging of a shipment to help customers identify a particular shipment<br>Example: 87123
requestedShipment.customsClearanceDetail.commodities[].countryOfManufacture -- Type: string | Example: US | This is commodity country of manufacture. This is required for International shipments. Maximum allowed length is 4.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to se...
requestedShipment.customsClearanceDetail.commodities[].customsValue -- Type: object | This is the customs value. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commodities[].customsValue.amount -- Type: number | Format: double | Example: 1556.25 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example:  1556.25
requestedShipment.customsClearanceDetail.commodities[].customsValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commodities[].description -- Type: string | Example: description | This is the commodity description. Maximum allowed 450 characters.<br><a onclick='loadDocReference("vaguecommoditydescriptions")'>click here to see Vague commodity descriptions</a>
requestedShipment.customsClearanceDetail.commodities[].exportLicenseExpirationDate -- Type: string | Format: date-time | Specify the export license expiration date for the shipment.<br>Format YYYY-MM-DD<br>Example : 2009-04-12
requestedShipment.customsClearanceDetail.commodities[].exportLicenseNumber -- Type: string | Example: 26456 | This is the export license number for the shipment.<br>Example: 26456
requestedShipment.customsClearanceDetail.commodities[].harmonizedCode -- Type: string | Example: 0613 | This is to specify the Harmonized Tariff System (HTS) code to meet U.S. and foreign governments' customs requirements. These are mainly used to estimate the duties and taxes.<br>Example: 0613<br>To...
requestedShipment.customsClearanceDetail.commodities[].name -- Type: string | Example: non-threaded rivets | This is Commodity name.<br>Example: Non-Threaded Rivets
requestedShipment.customsClearanceDetail.commodities[].numberOfPieces -- Type: integer | Format: int32 | Example: 12 | Indicate the number of pieces associated with the commodity. The value can neither be negative nor exceed 9,999.<br>Example: 12
requestedShipment.customsClearanceDetail.commodities[].partNumber -- Type: string | Example: 167 | This is a part number.<br>Example: 167
requestedShipment.customsClearanceDetail.commodities[].purpose -- Type: string | Valid values: BUSINESS, CONSUMER | Example: BUSINESS | This is the purpose of this shipment. This is used for calculation of duties and taxes.
requestedShipment.customsClearanceDetail.commodities[].quantity -- Type: integer | Format: int32 | Example: 125 | This is the units quantity (using quantityUnits as the unit of measure) per commodity. This is used to estimate duties and taxes.<br> Example: 125
requestedShipment.customsClearanceDetail.commodities[].quantityUnits -- Type: string | Example: Ea | This is the unit of measure for the units quantity. This is used to estimate duties and taxes.<br>Example: EA<br><a onclick='loadDocReference("harmonizedsystemcodeunitofmeasure-table1")'>click here...
requestedShipment.customsClearanceDetail.commodities[].unitPrice -- Type: object | This is the unit price. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commodities[].unitPrice.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commodities[].unitPrice.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commodities[].usmcaDetail -- Type: object | Indicates the USMCA detail
requestedShipment.customsClearanceDetail.commodities[].usmcaDetail.originCriterion -- Type: string | Valid values: A, B, C, D, E | Specify the origin criterion.
requestedShipment.customsClearanceDetail.commodities[].weight -- Type: object | Example: {'units': 'KG', 'value': 68} | These are the package weight details.<br>Note: Weight is not required for One rate shipments
requestedShipment.customsClearanceDetail.commodities[].weight.units -- Type: string | Valid values: KG | Example: KG | Indicate the weight unit type. The package and commodity weight unit should be the same else the request will result in an error.
requestedShipment.customsClearanceDetail.commodities[].weight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.customsClearanceDetail.customsOption -- Type: object | Example: {'description': 'Description', 'type': 'COURTESY_RETURN_LABEL'} | These are customs Option Detail, type must be indicated for each occurrence.
requestedShipment.customsClearanceDetail.customsOption.description -- Type: string | Example: Description | Specify additional description about customs options. This is a required field when the Type is OTHER.
requestedShipment.customsClearanceDetail.customsOption.type -- Type: string | Valid values: COURTESY_RETURN_LABEL, EXHIBITION_TRADE_SHOW, FAULTY_ITEM, FOLLOWING_REPAIR, FOR_REPAIR, ITEM_FOR_LOAN, OTHER, REJECTED, REPLACEMENT, TRIAL | Example: COURTESY_RETURN_LABEL | Specify the reason for a global return, as recognized by Customs. Valid values:<ul><li>COURTESY_RETURN_LABEL: Applicable for Outbound shipments.</li><li>EXHIBITION_TRADE_SHOW: For exhibition or tra...
requestedShipment.customsClearanceDetail.declarationStatementDetail -- Type: object | Specifies about the statements to be declared for Customs.
requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail -- Type: object | Specify the low Value statement necessary for printing the USMCA for Customs documentation.
requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail.countryOfOriginLowValueDocumentRequested -- Type: boolean | Example: True | Specify the country Of Origin of Low Value Document for Customs declaration.
requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail.customsRole -- Type: string | Valid values: EXPORTER, IMPORTER | Example: EXPORTER | Specify the shipper role for Customs declaration.
requestedShipment.customsClearanceDetail.dutiesPayment -- Type: object | Example: {'payor': {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}, {'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}}, 'billingDetails': {'billingCode': 'billingCode', 'billingType': 'billingType', 'aliasId': 'aliasId', 'accountNickname': 'accountNickname', 'accountNumber': 'Your account number', 'accountNumberCountryCode': 'US'}, 'paymentType': 'SENDER'} | This is a payment type, basically indicates who is the payor for the shipment.Conditional required for International Shipments
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails -- Type: object | Example: {'billingCode': '128345', 'billingType': 'billingType', 'aliasId': 'alias identifier', 'accountNickname': 'accountNickname', 'accountNumber': 'Your account number', 'accountNumberCountryCode': 'CA'} | These are billing details.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNickname -- Type: string | This is account nick name.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNumber -- Type: string | This is bill to account number.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNumberCountryCode -- Type: string | This is the country code of the account number.<br>Example: CA
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.aliasId -- Type: string | This is bill to alias identifier.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.billingCode -- Type: string | Indicates a billing code.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.billingType -- Type: string | These are duties and taxes billing type.
requestedShipment.customsClearanceDetail.dutiesPayment.paymentType -- Type: string | Valid values: SENDER, RECIPIENT, THIRD_PARTY, COLLECT | This is a payment type, basically indicates who is the payor for the shipment.<br>Required for Express and Ground.<br>The payment type COLLECT is applicable only for Ground shipments.
requestedShipment.customsClearanceDetail.dutiesPayment.payor -- Type: object | Example: {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}, {'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}} | Information about the person who is paying for the shipment. Not applicable for credit card payment.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}, {'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | Use this object to provide the attributes such as physical address, contact information and account number information.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.streetLines[] -- Type: string
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins -- Type: array | This is the tax identification number details.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.customsClearanceDetail.exportDetail -- Type: object | These are export Detail used for US or CA exports.
requestedShipment.customsClearanceDetail.exportDetail.b13AFilingOption -- Type: string | Valid values: NOT_REQUIRED, MANUALLY_ATTACHED, FILED_ELECTRONICALLY, SUMMARY_REPORTING, FEDEX_TO_STAMP | Example: NOT_REQUIRED | 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. Virgi...
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail -- Type: object | Use this object to specify the appropriate destination control statement type(s). Also make sure to specify destination country and end user.
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.destinationCountries -- Type: array | Example: ['USA', 'India'] | Specify DCS shipment destination country. You may enter up to four country codes in this element. Up to 11 alphanumeric characters are allowed.<br>Example: US<br><a onclick='loadDocReference("count...
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.destinationCountries[] -- Type: string
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.endUser -- Type: string | Example: dest country user | Specify End User name. Its is required if StatementTypes is entered as DEPARTMENT_OF_STATE. <br>Example: John Wick
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.statementTypes -- Type: string | Valid values: DEPARTMENT_OF_COMMERCE, DEPARTMENT_OF_STATE, DEPARTMENT_OF_COMMERCE_AND_DEPARTMENT_OF_STATE | Example: DEPARTMENT_OF_COMMERCE | Specify appropriate destination control statement type(s), Also make sure to specify destination country and end user.
requestedShipment.customsClearanceDetail.exportDetail.exportComplianceStatement -- Type: string | Example: 12345678901234567 | 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 nu...
requestedShipment.customsClearanceDetail.exportDetail.permitNumber -- Type: string | Example: 12345 | 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.<br> Example: 12345
requestedShipment.customsClearanceDetail.freightOnValue -- Type: string | Valid values: CARRIER_RISK, OWN_RISK | Example: OWN_RISK | Specify the risk owner for the Freight shipment.This element is only mandatory or valid for Intra India shipments.
requestedShipment.customsClearanceDetail.generatedDocumentLocale -- Type: string | Example: en_US | This is the locale for generated document.<br>Example: en_US<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is e...
requestedShipment.customsClearanceDetail.importerOfRecord -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | The descriptive data for the importer of Record for the shipment and their physical address, contact and account number information.
requestedShipment.customsClearanceDetail.importerOfRecord.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.customsClearanceDetail.importerOfRecord.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.customsClearanceDetail.importerOfRecord.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.customsClearanceDetail.importerOfRecord.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.customsClearanceDetail.importerOfRecord.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.customsClearanceDetail.importerOfRecord.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.customsClearanceDetail.importerOfRecord.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.customsClearanceDetail.importerOfRecord.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.customsClearanceDetail.importerOfRecord.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.customsClearanceDetail.importerOfRecord.address.streetLines[] -- Type: string
requestedShipment.customsClearanceDetail.importerOfRecord.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.customsClearanceDetail.importerOfRecord.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.customsClearanceDetail.importerOfRecord.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.customsClearanceDetail.importerOfRecord.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.customsClearanceDetail.importerOfRecord.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.customsClearanceDetail.importerOfRecord.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.customsClearanceDetail.importerOfRecord.tins -- Type: array | This is the tax identification number details.
requestedShipment.customsClearanceDetail.importerOfRecord.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.customsClearanceDetail.insuranceCharge -- Type: object | Specify insurance charges if applicable. <br><i>Note: FedEx does not provide insurance of any kind.</i> Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.insuranceCharge.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.insuranceCharge.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.isDocumentOnly -- Type: boolean | Example: True | 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 -- Type: boolean | Specify if the transacting parties are related.
requestedShipment.customsClearanceDetail.recipientCustomsId -- Type: object | Use this element to provide valid identification details. Used for populating brazil tax id.
requestedShipment.customsClearanceDetail.recipientCustomsId.type -- Type: string | Valid values: COMPANY, INDIVIDUAL, PASSPORT | Example: PASSPORT | This is ID Type.
requestedShipment.customsClearanceDetail.recipientCustomsId.value -- Type: string | Example: 123 | This is the ID number.
requestedShipment.customsClearanceDetail.regulatoryControls -- Type: array | Example: NOT_IN_FREE_CIRCULATION | These are the regulatory controls applicable to the shipment.
requestedShipment.customsClearanceDetail.regulatoryControls[] -- Type: string | Valid values: FOOD_OR_PERISHABLE, USMCA, NOT_APPLICABLE_FOR_LOW_VALUE_CUSTOMS_EXCEPTIONS, NOT_IN_FREE_CIRCULATION
requestedShipment.customsClearanceDetail.totalCustomsValue -- Type: object | This is the total customs value. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.totalCustomsValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.totalCustomsValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.emailNotificationDetail -- Type: object | These are email disposition details. Provides the type and email addresses of e-mail recipients. If returnedDispositionDetail in labelSpecification is set as true then email will be send with label...
requestedShipment.emailNotificationDetail.aggregationType -- Type: string | Valid values: PER_PACKAGE, PER_SHIPMENT | Example: PER_PACKAGE | Indicate the shipment notification aggregation type.
requestedShipment.emailNotificationDetail.emailNotificationRecipients -- Type: array | These are email notification recipient details.
requestedShipment.emailNotificationDetail.emailNotificationRecipients[] -- Type: object | These are recipient details for receiving email notification.
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].emailAddress -- Type: string | Example: jsmith3@aol.com | Specify the recipient email address.<br>Example: xyz@aol.com
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].emailNotificationRecipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: SHIPPER | Specify the recipient type for email notification.
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].locale -- Type: string | Example: en_US | These are the locale details for email.<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an error mess...
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].name -- Type: string | Example: Joe Smith | Specify the recipient name.<br>Example: Joe Smith
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationEventType -- Type: array | Example: ['ON_PICKUP_DRIVER_ARRIVED', 'ON_SHIPMENT'] | Specify notification event types.<br><a onclick='loadDocReference("notificationeventtypes")'>Click here for more information on Notification Event Types.</a>
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationEventType[] -- Type: string | Valid values: ON_DELIVERY, ON_EXCEPTION, ON_SHIPMENT, ON_TENDER, ON_ESTIMATED_DELIVERY, ON_PICKUP, ON_LABEL, ON_BILL_OF_LADING, ON_PICKUP_DRIVER_ARRIVED, ON_PICKUP_DRIVER_ASSIGNED, ON_PICKUP_DRIVER_DEPARTED, ON_PICKUP_DRIVER_EN_ROUTE
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationFormatType -- Type: string | Valid values: HTML, TEXT | Example: TEXT | This is the format for the email notification. Either HTML or plain text can be provided.
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationType -- Type: string | Valid values: EMAIL | Example: EMAIL | Indicate the type of notification that will be sent as an email.
requestedShipment.emailNotificationDetail.personalMessage -- Type: string | Example: your personal message here | This is your personal message for the email.<br>Note: The maximum personal message character limit depends on the element emailNotificationDetail\emailNotificationRecipients\notificationFormatType ...
requestedShipment.labelSpecification -- Type: object | These are label specification details includes the image type, printer format, and label stock for label. Can also specify specific details such as doc-tab content, regulatory labels, and masking d...
requestedShipment.labelSpecification.customerSpecifiedDetail -- Type: object | This object allows the control of label content for customization.
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels -- Type: array | Specify how the additional details to be provided on the labels.
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels[] -- Type: object
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels[].count -- Type: integer | Example: 1 | Specifies the count of label to return.
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels[].type -- Type: string | Valid values: BROKER, CONSIGNEE, CUSTOMS, DESTINATION, DESTINATION_CONTROL_STATEMENT, FREIGHT_REFERENCE, MANIFEST, ORIGIN, RECIPIENT, SECOND_ADDRESS, SHIPPER | Example: CONSIGNEE | Specify the type of additional  details to be added on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent -- Type: object | Specifies details of doc tab content.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded -- Type: object | It is a doc tab content type which is in barcoded format.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification -- Type: object | Indicates the doc tab zone specification.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.dataField -- Type: string | Indicate the path request/reply element to be printed on doc tab.<br>Example:<ul><li>REQUEST/SHIPMENT/ShipTimestamp</li><li>REQUEST/PACKAGE/weight/Value</li><li>REQUEST/PACKAGE/InsuredValue/Amount<...
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.header -- Type: string | Indicates the parameter name in the header for the doc tab zone.<br>Example:  WHT
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.justification -- Type: string | Valid values: LEFT, RIGHT | Example: RIGHT | Indicates the justification format for the string.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.literalValue -- Type: string | Indicates the actual data to be printed in the label<br>
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.zoneNumber -- Type: integer | Format: int32 | It is a non-negative integer that represents the portion of doc-tab in a label.<br>Example: 1
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.symbology -- Type: string | Valid values: CODABAR, CODE128, CODE128_WIDEBAR, CODE128B, CODE128C, CODE39, CODE93, I2OF5, MANUAL, PDF417, POSTNET, QR_CODE, UCC128 | Example: UCC128 | Indicates the type of barcode symbology used on FedEx documents and labels.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.docTabContentType -- Type: string | Valid values: BARCODED, CUSTOM, MINIMUM, STANDARD, ZONE001 | Example: BARCODED | Indicates the content type of the doc tab.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001 -- Type: object | Indicate the doc tab specification for different zones on the label. The specification includes zone number, header and data field to be displayed on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications -- Type: array | Indicate the doc tab specifications for the individual doc tab zone on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[] -- Type: object | Indicates the doc tab zone specification.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].dataField -- Type: string | Indicate the path request/reply element to be printed on doc tab.<br>Example:<ul><li>REQUEST/SHIPMENT/ShipTimestamp</li><li>REQUEST/PACKAGE/weight/Value</li><li>REQUEST/PACKAGE/InsuredValue/Amount<...
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].header -- Type: string | Indicates the parameter name in the header for the doc tab zone.<br>Example:  WHT
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].justification -- Type: string | Valid values: LEFT, RIGHT | Example: RIGHT | Indicates the justification format for the string.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].literalValue -- Type: string | Indicates the actual data to be printed in the label<br>
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].zoneNumber -- Type: integer | Format: int32 | It is a non-negative integer that represents the portion of doc-tab in a label.<br>Example: 1
requestedShipment.labelSpecification.customerSpecifiedDetail.maskedData -- Type: array | Example: ['CUSTOMS_VALUE', 'TOTAL_WEIGHT'] | Specify which data/sections on the label to be masked.<br>Note: <ul><li>SECONDARY_BARCODE &ndash; This is used for Smartpost shipment labels.</li><li>SHIPPER_INFORMATION &ndash; This is used for Th...
requestedShipment.labelSpecification.customerSpecifiedDetail.maskedData[] -- Type: string | Valid values: CUSTOMS_VALUE, DIMENSIONS, DUTIES_AND_TAXES_PAYOR_ACCOUNT_NUMBER, INSURED_VALUE, SECONDARY_BARCODE, SHIPPER_INFORMATION, TERMS_AND_CONDITIONS, TOTAL_WEIGHT, TRANSPORTATION_CHARGES_PAYOR_ACCOUNT_NUMBER
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels -- Type: array | Specify how the regulatory details to be provided on the labels.
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels[] -- Type: object
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels[].generationOptions -- Type: string | Valid values: CONTENT_ON_SHIPPING_LABEL_PREFERRED, CONTENT_ON_SUPPLEMENTAL_LABEL_ONLY, CONTENT_ON_SHIPPING_LABEL_ONLY | Example: CONTENT_ON_SHIPPING_LABEL_ONLY | Specify the regulatory content preference to be displayed on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels[].type -- Type: string | Valid values: ALCOHOL_SHIPMENT_LABEL | Example: ALCOHOL_SHIPMENT_LABEL | Specify the type of regulatory content to be added on the label.
requestedShipment.labelSpecification.imageType -- Type: string | Valid values: ZPLII, EPL2, PDF, PNG | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.labelSpecification.labelFormatType -- Type: string | Valid values: COMMON2D, LABEL_DATA_ONLY | Example: COMMON2D | Specify the label Format Type.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.labelSpecification.labelOrder -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST | Example: SHIPPING_LABEL_FIRST | This is the order of the Shipping label/documents to be generated.
requestedShipment.labelSpecification.labelPrintingOrientation -- Type: string | Valid values: BOTTOM_EDGE_OF_TEXT_FIRST, TOP_EDGE_OF_TEXT_FIRST | Example: TOP_EDGE_OF_TEXT_FIRST | This is applicable only to documents produced on thermal printers with roll stock.
requestedShipment.labelSpecification.labelRotation -- Type: string | Valid values: LEFT, RIGHT, UPSIDE_DOWN, NONE | Example: UPSIDE_DOWN | This is applicable only to documents produced on thermal printers with roll stock.
requestedShipment.labelSpecification.labelStockType -- Type: string | Valid values: PAPER_4X6, PAPER_4X675, PAPER_4X8, PAPER_4X9, PAPER_7X475, PAPER_85X11_BOTTOM_HALF_LABEL, PAPER_85X11_TOP_HALF_LABEL, PAPER_LETTER, STOCK_4X675_LEADING_DOC_TAB, STOCK_4X8, STOCK_4X9_LEADING_DOC_TAB, STOCK_4X6, STOCK_4X675_TRAILING_DOC_TAB, STOCK_4X9_TRAILING_DOC_TAB, STOCK_4X9, STOCK_4X85_TRAILING_DOC_TAB, STOCK_4X105_TRAILING_DOC_TAB | Example: PAPER_85X11_TOP_HALF_LABEL | Indicate the label stock type used. <br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.labelSpecification.printedLabelOrigin -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Specifies the contact and address details of a location.
requestedShipment.labelSpecification.printedLabelOrigin.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.labelSpecification.printedLabelOrigin.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.labelSpecification.printedLabelOrigin.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.labelSpecification.printedLabelOrigin.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.labelSpecification.printedLabelOrigin.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.labelSpecification.printedLabelOrigin.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.labelSpecification.printedLabelOrigin.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.labelSpecification.printedLabelOrigin.address.streetLines[] -- Type: string
requestedShipment.labelSpecification.printedLabelOrigin.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.labelSpecification.printedLabelOrigin.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.labelSpecification.printedLabelOrigin.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.labelSpecification.printedLabelOrigin.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.labelSpecification.printedLabelOrigin.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.labelSpecification.printedLabelOrigin.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.labelSpecification.printedLabelOrigin.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.labelSpecification.returnedDispositionDetail -- Type: boolean | Valid values: True, False | Example: True | Specify whether or not the return deposition is needed.
requestedShipment.origin -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Indicate the shipment origin address information, if it is different from the shippers address. Specifies the contact and address details of a location.
requestedShipment.origin.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.origin.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.origin.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.origin.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.origin.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.origin.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.origin.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.origin.address.streetLines[] -- Type: string
requestedShipment.origin.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.origin.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.origin.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.origin.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.origin.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70.<br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.origin.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.origin.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers. <br>Note: Recommended Maximum length is 15 and there's no specifi...
requestedShipment.packagingType -- Type: string | Example: YOUR_PACKAGING | Indicate the type of packaging used for the package.<br>Note: For Express Freight shipments, the packaging will default to value  YOUR_PACKAGING irrespective type provided in the request.<br>Exampl...
requestedShipment.pickupType -- Type: string | Valid values: CONTACT_FEDEX TO_SCHEDULE, DROPOFF_AT_FEDEX_LOCATION, USE_SCHEDULED_PICKUP | Example: USE_SCHEDULED_PICKUP | Select if the shipment is to be dropped off at Fedex location or to be picked up by FedEx or if it is a scheduled pickup for this shipment.<br><a onclick='loadDocReference("pickuptypes")'>Click her...
requestedShipment.preferredCurrency -- Type: string | Example: USD | Indicate the currency the caller requests to have used in all returned monetary values. Should be Used in conjunction with the element RateRequestType.<br>Example: USD<br><a onclick='loadDocReferen...
requestedShipment.rateRequestType -- Type: array | Example: ['LIST', 'PREFERRED'] | Indicate the type of rates to be returned.<br>Following are values:<ul><li>LIST - Returns published list rates will be returned in addition to account-specific rate (if applicable).</li><li>PREFERR...
requestedShipment.rateRequestType[] -- Type: string | Valid values: LIST, NONE, PREFERRED, ACCOUNT, INCENTIVE, RETAIL
requestedShipment.recipients -- Type: array | Indicate the shipment recipient details or the physical location details for the package destination.
requestedShipment.recipients[] -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'FedEx'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}], 'deliveryInstructions': 'Delivery Instructions'} | The descriptive information of the recipient for the shipment and the physical location for the package destination.
requestedShipment.recipients[].address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.recipients[].address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.recipients[].address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.recipients[].address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.recipients[].address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.recipients[].address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.recipients[].address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.recipients[].address.streetLines[] -- Type: string
requestedShipment.recipients[].contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.recipients[].contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.recipients[].contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.recipients[].contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.recipients[].contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.recipients[].contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.recipients[].deliveryInstructions -- Type: string | Example: Instruction 1 | Specify the delivery instructions to be added with the shipment. Use with Ground Home Delivery.<br>Example: Delivery Instructions
requestedShipment.recipients[].tins -- Type: array | This is the tax identification number details.
requestedShipment.recipients[].tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.recipients[].tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.recipients[].tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.recipients[].tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.recipients[].tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.recipients[].tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.requestedPackageLineItems -- Type: array | Use this object to provide the package details.<br>Note: <ul><li>At least one instance containing the weight is required for EXPRESS and GROUND package.</li><li>Only Single piece requests are suppo...
requestedShipment.requestedPackageLineItems[] -- Type: object | 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...
requestedShipment.requestedPackageLineItems[].contentRecord -- Type: array | Use this object to specify package content details.
requestedShipment.requestedPackageLineItems[].contentRecord[] -- Type: object | Use this object to specify package content details.
requestedShipment.requestedPackageLineItems[].contentRecord[].description -- Type: string | Example: Description | This is the description of the package item.
requestedShipment.requestedPackageLineItems[].contentRecord[].itemNumber -- Type: string | Example: 2876 | This is a package item number.
requestedShipment.requestedPackageLineItems[].contentRecord[].partNumber -- Type: string | Example: 456 | This is the part number.
requestedShipment.requestedPackageLineItems[].contentRecord[].receivedQuantity -- Type: integer | Format: int32 | Example: 256 | This is the package item quantity.
requestedShipment.requestedPackageLineItems[].customerReferences -- Type: array | This object lists the customer references provided with the package.
requestedShipment.requestedPackageLineItems[].customerReferences[] -- Type: object
requestedShipment.requestedPackageLineItems[].customerReferences[].customerReferenceType -- Type: string | Valid values: CUSTOMER_REFERENCE, DEPARTMENT_NUMBER, INVOICE_NUMBER, P_O_NUMBER, INTRACOUNTRY_REGULATORY_REFERENCE, RMA_ASSOCIATION | Example: INVOICE_NUMBER | This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information.<p>Note: <ul><li>The P_O_NUMBER value must b...
requestedShipment.requestedPackageLineItems[].customerReferences[].value -- Type: string | Example: 3686 | This is a customer reference type value.<br>Example: 3686<br>Note: Maximum length for all customer references is 40 characters excluding customer reference type for 'RMA_ASSCOATION' where maximum c...
requestedShipment.requestedPackageLineItems[].declaredValue -- Type: object | This is the Declared Value of any shipment which represents FedEx maximum liability associated with a shipment. This is including, but not limited to any loss, damage, delay, misdelivery, any failu...
requestedShipment.requestedPackageLineItems[].declaredValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].declaredValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.requestedPackageLineItems[].dimensions -- Type: object | Example: {'length': 100, 'width': 50, 'height': 30, 'units': 'CM'} | Indicate the dimensions of the package.<br> Following conditions will apply: <ul><li>Dimensions are optional but when added, then all three dimensions must be indicated.</li><li>Dimensions are requ...
requestedShipment.requestedPackageLineItems[].dimensions.height -- Type: integer | Format: int32 | Example: 1 | Indicate the height of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].dimensions.length -- Type: integer | Format: int32 | Example: 3 | Indicate the length of the package. No implied decimal places. Maximum value: 999 <br> Example: 20
requestedShipment.requestedPackageLineItems[].dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Indicate the Unit of measure for the provided dimensions.<br>Valid Values are:<li>IN - inches</li><li>CM - centimeters</li>Note: Any value other than CM including blank/null will default to IN.
requestedShipment.requestedPackageLineItems[].dimensions.width -- Type: integer | Format: int32 | Example: 2 | Indicate the width of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].groupPackageCount -- Type: integer | Format: int32 | Example: 2 | Indicate the grouped package count. These are number of identical package(s) each with one or more commodities. <br> Example: 2
requestedShipment.requestedPackageLineItems[].itemDescription -- Type: string | Example: item description for the package | This the item description for the package.<br>Note: Item description is required for Email Label return shipments and ground Create tag.<br>Example: Item description<br> Maximum limit is 50 characters
requestedShipment.requestedPackageLineItems[].itemDescriptionForClearance -- Type: string | Example: description | Describe the content of the package for customs clearance purposes. This applies to intra-UAE, intra-Columbia and intra-Brazil shipments.
requestedShipment.requestedPackageLineItems[].packageSpecialServices -- Type: object | These are special services that are available at the package level for some or all service types.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail -- Type: object | These are detcontentails for the package containing alcohol. This is required for alcohol special service. The alcoholRecipientType is required.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.alcoholRecipientType -- Type: string | Valid values: LICENSEE, CONSUMER | Example: LICENSEE | Specify the Alcohol Recipient Type of the shipment. <br> Example: LICENSEE
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.shipperAgreementType -- Type: string | Example: Retailer | Specify the type of entity, the shipper for alcohol shipment is registered such as fulfillment house, retailer or a winery.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails -- Type: array | Provide details about the batteries or cells that are contained within this specific package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[] -- Type: object
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryMaterialType -- Type: string | Valid values: LITHIUM_METAL, LITHIUM_ION | Indicate the material composition of the battery or cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryPackingType -- Type: string | Valid values: CONTAINED_IN_EQUIPMENT, PACKED_WITH_EQUIPMENT | Describe the packing arrangement of the battery or cell with respect to other items within the same package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryRegulatoryType -- Type: string | Valid values: IATA_SECTION_II | This is a regulation specific classification for the battery or the cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail -- Type: object | Provide dangerous goods shipment details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.accessibility -- Type: string | Valid values: ACCESSIBLE, INACCESSIBLE | Example: INACCESSIBLE | Specify Dangerous Goods Accessibility Type. <ul><li>Inaccessible &ndash; it does not have to be accessable on the aircraft.</li><li>Accessible &ndash; it must be fully accessible on the aircraft, a...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.cargoAircraftOnly -- Type: boolean | Valid values: True, False | A Boolean value that, when True, specifies the mode of shipment transportation should be Cargo Aircraft for Dangerous Goods. Its default value is set as False.<br>Note: An identifier DGD-CAO is add...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options -- Type: array | Example: ['LIMITED_QUANTITIES_COMMODITIES', 'ORM_D'] | Indicate type of DG being reported.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options[] -- Type: string | Valid values: HAZARDOUS_MATERIALS, BATTERY, ORM_D, REPORTABLE_QUANTITIES, SMALL_QUANTITY_EXCEPTION, LIMITED_QUANTITIES_COMMODITIES
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight -- Type: object | Example: {'units': 'KG', 'value': 68} | These are the package weight details.<br>Note: Weight is not required for One rate shipments
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.units -- Type: string | Valid values: KG | Example: KG | Indicate the weight unit type. The package and commodity weight unit should be the same else the request will result in an error.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail -- Type: object | These are COD package details. For use with FedEx Ground services only; COD must be present in shipments special services.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount -- Type: object | Indicate the COD collection amount. Specifies taxes or miscellaneous charge.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.requestedPackageLineItems[].packageSpecialServices.pieceCountVerificationBoxCount -- Type: integer | Format: int32 | Specify the count.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail -- Type: object | Specifies the Priority Alert Detail.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.content -- Type: array | Example: ['string'] | Specifies Content for the Priority Alert Detail.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.content[] -- Type: string
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.enhancementTypes -- Type: array | Example: ['PRIORITY_ALERT_PLUS'] | The types of all enhancement for the Priority Alert.<br>Example: PRIORITY_ALERT_PLUS
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.enhancementTypes[] -- Type: string
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionDetail -- Type: object | This element specifies Signature option details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionDetail.signatureReleaseNumber -- Type: string | Example: 23456 | This is release number.<br>Example: 23456
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionType -- Type: string | Valid values: SERVICE_DEFAULT, NO_SIGNATURE_REQUIRED, INDIRECT, DIRECT, ADULT | Example: ADULT | Indicate the Signature Type. <br>Valid Values: <ul><li>ADULT - Adult signature required, at recipient address.</li><li>DIRECT - Signature required, at recipient address.</li><li>INDIRECT - Signatur...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes -- Type: array | Example: ['ALCOHOL', 'NON_STANDARD_CONTAINER'] | Indicate the types of special services requested for the shipment.<br><a onclick='loadDocReference("packagelevelspecialservicetypes")'>click here to see Package Special Service Types</a>
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes[] -- Type: string
requestedShipment.requestedPackageLineItems[].sequenceNumber -- Type: integer | Example: 1 | Optional. <br>Used only with individual packages as a unique identifier of each requested package. Will be adjusted at the shipment level as pieces are added.
requestedShipment.requestedPackageLineItems[].subPackagingType -- Type: string | Example: BUCKET | Indicate the subPackagingType, if you are using your own packaging for the shipment. Use it for all shipments inbound to Canada (CA) and inbound shipments to the U.S. and Puerto Rico (PR) from Cana...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail -- Type: object | Indicate the details about how to calculate variable handling charges at the shipment level. They can be based on a percentage of the shipping charges or a fixed amount. If indicated, element rateL...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue -- Type: object | Example: {'amount': 24.45, 'currency': 'USD'} | 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. <br>Example: 5.00. Specifies taxes or...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45 fixed variable handling charge amount
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a> fixed variable handling charge currency type<br><a o...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.percentValue -- Type: number | Format: double | Example: 12.45 | This is the variable handling percentage. If the percent value is mentioned as 10, it means 10%(multiplier of 0.1).<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateElementBasis -- Type: string | Valid values: NET_CHARGE, NET_FREIGHT, BASE_CHARGE, NET_CHARGE_EXCLUDING_TAXES | Example: NET_CHARGE_EXCLUDING_TAXES | Specify the charge type upon which the variable handling percentage amount is calculated.
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Example: INDIVIDUAL_PACKAGE_RATE | Specifies if the rate level type is either Individual or Bundled.
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateType -- Type: string | Valid values: ACCOUNT, ACTUAL, CURRENT, CUSTOM, LIST, INCENTIVE, PREFERRED, PREFERRED_INCENTIVE, PREFERRED_CURRENCY | Example: PREFERRED_CURRENCY | This is the rate type used for this package.
requestedShipment.requestedPackageLineItems[].weight -- Type: object | Example: {'units': 'KG', 'value': 68} | These are the package weight details.<br>Note: Weight is not required for One rate shipments
requestedShipment.requestedPackageLineItems[].weight.units -- Type: string | Valid values: KG | Example: KG | Indicate the weight unit type. The package and commodity weight unit should be the same else the request will result in an error.
requestedShipment.requestedPackageLineItems[].weight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.serviceType -- Type: string | Example: PRIORITY_OVERNIGHT | Indicate the FedEx service Type used for this shipment.<br>Example: STANDARD_OVERNIGHT<br><a onclick='loadDocReference("servicetypes")'>click here to see available FedEx Service Types</a>
requestedShipment.shipDatestamp -- Type: string | Example: 2019-10-14 | Indicate the shipment date.<br>Format: YYYY-MM-DD<br>Note: Default value is current date in case the date is not provided in the request.<br>Example: 2021-04-06
requestedShipment.shipmentSpecialServices -- Type: object | Indicate the shipment special service or handling required for this shipment. <br>Note: <ul><li>If the shipper is requesting a special service, the special service type must be indicated in the obj...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail -- Type: object | Indicate the Delivery On Invoice Acceptance detail. Recipient is required for Delivery On Invoice Special service.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'FedEx'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}], 'deliveryInstructions': 'Delivery Instructions'} | The descriptive data for the recipient of the shipment and the physical location for the shipment destination. The descriptive information of the recipient for the shipment and the physical locatio...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a> The two-letter code used to identify...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory. Identifies the company this contact is associated with. Maximum length is 35.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor Identifies the contact person's name. Maximum length is 70.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.deliveryInstructions -- Type: string | Example: Instruction 1 | Specify the delivery instructions to be added with the shipment. Use with Ground Home Delivery.<br>Example: Delivery Instructions
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins -- Type: array | This is the tax identification number details.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shipmentSpecialServices.etdDetail -- Type: object | Use this object to specify all information on how the electronic Trade document references used with the shipment.
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments -- Type: array | 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 val...
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[] -- Type: object | Specify the document upload reference details.
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].description -- Type: string | Example: PRO FORMA INVOICE | Specify additional information about the uploaded document for better understanding.<br>Example: Certificate of Origin is uploaded for country of manufacturing verification.
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].documentId -- Type: string | Example: 090927d680038c61 | This is the uploaded document ID value.<br>Example: 090927d680038c61
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].documentReference -- Type: string | Example: DocumentReference | Specify the reference for the uploaded document.This is for the customer to reference their uploaded docs when they retrieve them. Could be anything, order number, po number, whatever the customer ...
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].documentType -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, ETD_LABEL, USMCA_CERTIFICATION_OF_ORIGIN, OTHER, PRO_FORMA_INVOICE, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN | Example: PRO_FORMA_INVOICE | Specify document type for the uploaded document. It should match with the type of uploaded document associated with documentId.
requestedShipment.shipmentSpecialServices.etdDetail.attributes -- Type: array | Use this attribute to specify if the Trade documents will be uploaded post the shipment.
requestedShipment.shipmentSpecialServices.etdDetail.attributes[] -- Type: string | Valid values: POST_SHIPMENT_UPLOAD_REQUESTED
requestedShipment.shipmentSpecialServices.etdDetail.requestedDocumentTypes -- Type: array | Example: ['VICS_BILL_OF_LADING', 'GENERAL_AGENCY_AGREEMENT'] | 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.<br>Note: For more information...
requestedShipment.shipmentSpecialServices.etdDetail.requestedDocumentTypes[] -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, CUSTOM_PACKAGE_DOCUMENT, CUSTOM_SHIPMENT_DOCUMENT, CUSTOMER_SPECIFIED_LABELS, EXPORT_DECLARATION, DANGEROUS_GOODS_SHIPPERS_DECLARATION, GENERAL_AGENCY_AGREEMENT, LABEL, USMCA_CERTIFICATION_OF_ORIGIN, OP_900, PENDING_SHIPMENT_EMAIL_NOTIFICATION, PRO_FORMA_INVOICE, RETURN_INSTRUCTIONS, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN
requestedShipment.shipmentSpecialServices.holdAtLocationDetail -- Type: object | Use this object to specify required information for a shipment to be held at destination FedEx location.<br><i>Note: This object HoldAtLocationDetail is Required, when HOLD_AT_LOCATION is chosen in...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Specifies the contact and address details of a location.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationId -- Type: string | Example: YBZA | This is an alphanumeric identifier used for Location/Facility Identification.<br>Example: YBZA<br>Note: <ul><li>For HAL Shipment, Location ID is <b>REQUIRED</b> to ensure packages are delivered to ...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationType -- Type: string | Valid values: FEDEX_AUTHORIZED_SHIP_CENTER, FEDEX_OFFICE, FEDEX_SELF_SERVICE_LOCATION, FEDEX_STAFFED, RETAIL_ALLICANCE_LOCATION, FEDEX_GROUND_TERMINAL, FEDEX_ONSITE | Example: FEDEX_ONSITE | Specifies the type of facility at which package/shipment is to be held.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail -- Type: object | These are Special service elements for FedEx Ground Home Delivery shipments. If selected, element homedeliveryPremiumType is mandatory.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.deliveryDate -- Type: string | Example: 2019-06-26 | This is delivery date. Required for FedEx Date Certain Home Delivery. Valid dates are Monday to Sunday. <br>There may be a delay in delivery on Sundays to locations that are geographically difficul...
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.homedeliveryPremiumType -- Type: string | Valid values: APPOINTMENT, DATE_CERTAIN, EVENING | Example: APPOINTMENT | 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 appointme...
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber -- Type: object | Example: {'areaCode': '901', 'localNumber': '3575012', 'extension': '200', 'personalIdentificationNumber': '98712345'} | Indicate the phone number. Only numeric values allowed.<br> Note that phoneNumber is mandatory when homedeliveryPremiumType is DATE_CERTAIN or EVENING.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.areaCode -- Type: string | Indicate the area code for the phone number.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.extension -- Type: string | Indicate the extension for the phone number.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.localNumber -- Type: string | Indicate the local phone number for contacting in the event of an emergency. Maximum length  is 10.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.personalIdentificationNumber -- Type: string | Indicate the Personal Identification Number associated with the phone number.
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail -- Type: object | Use this object to specify International Controlled Export shipment Details.<br>Note: licenseOrPermitExpirationDate and licenseOrPermitNumber are not required when type is WAREHOUSE_WITHDRAWAL.
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.entryNumber -- Type: string | Example: 125 | Indicate Entry Number for the export.<br>Example: 125
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.foreignTradeZoneCode -- Type: string | Example: US | Indicate the Foreign Trade Zone Code.<br>Example: US
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.licenseOrPermitExpirationDate -- Type: string | Example: 2019-12-03 | Indicate the expiration date for the license or permit. The format is YYYY-MM-DD.<br>Example: "2019-12-03"
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.licenseOrPermitNumber -- Type: string | Example: 11 | Indicate License Or Permit Number for the commodity being exported.<br>Example: 11
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.type -- Type: string | Valid values: DEA_036, DEA_236, DSP_05, DSP_61, DSP_73, DSP_85, DSP_LICENSE_AGREEMENT, WAREHOUSE_WITHDRAWAL | Example: WAREHOUSE_WITHDRAWAL | Indicate International Controlled Export Type.
requestedShipment.shipmentSpecialServices.internationalTrafficInArmsRegulationsDetail -- Type: object | These are International Traffic In Arms Regulations shipment service details.
requestedShipment.shipmentSpecialServices.internationalTrafficInArmsRegulationsDetail.licenseOrExemptionNumber -- Type: string | Example: 9871234 | The export or license number for the ITAR shipment.<br>Minimum length is 5 characters.<br>Maximum length is 21 characters.<br>Example: 9871234
requestedShipment.shipmentSpecialServices.pendingShipmentDetail -- Type: object | This object is used to specify the Pending Shipment Type for Email label.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments -- Type: array | These are the reference document details with the shipment.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[] -- Type: object | Specify the document upload reference details.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].description -- Type: string | Example: PRO FORMA INVOICE | This is the document description of the attached document.<br>Example: PRO FORMA INVOICE
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].documentId -- Type: string | Example: 090927d680038c61 | This is the uploaded document ID value.<br>Example: 090927d680038c61
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].documentReference -- Type: string | Example: DocumentReference | Specify the reference for the uploaded document.<br>Example: Reference
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].documentType -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, ETD_LABEL, USMCA_CERTIFICATION_OF_ORIGIN, NET_RATE_SHEET, OTHER, PRO_FORMA_INVOICE, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN | Example: PRO_FORMA_INVOICE | This is the uploaded document type.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail -- Type: object | These are specific information about the pending email label.<br>Required when PendingShipmentType is EMAIL.<br>Not applicable for CreateTag.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.message -- Type: string | Example: your optional message | This is an optional personalized message to be included in the email to the recipient.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients -- Type: array | This is Email label recipient email address, shipment role, & language locale details. Atleast one entry must be specified.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[] -- Type: object | These are the recipient details for the online email return label.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].emailAddress -- Type: string | Example: neena@fedex.com | This is recipient email address for notifying the return label. Maximum length 200 characters.<br> Example: neena@abc.com
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested -- Type: object | These are to indicate how the email notifications for the pending shipment to be processed.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested.options -- Type: array | Example: ['PRODUCE_PAPERLESS_SHIPPING_FORMAT', 'SUPPRESS_ACCESS_EMAILS'] | These are the processing options.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested.options[] -- Type: string | Valid values: PRODUCE_PAPERLESS_SHIPPING_FORMAT, SUPPRESS_ADDITIONAL_LANGUAGES, SUPPRESS_ACCESS_EMAILS
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].role -- Type: string | Valid values: SHIPMENT_COMPLETOR, SHIPMENT_INITIATOR | This is to specify Recipient role in the shipment.Shipment completor role is needed when we pass shipment initiator. We cannot use shipment initiator alone.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.expirationTimeStamp -- Type: string | Example: 2020-01-01 | 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.<b...
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.pendingShipmentType -- Type: string | Valid values: EMAIL | Example: EMAIL | This is Pending Shipment Type. Must include the value 'EMAIL' for email return shipments.<br>Not applicable for other types of shipments.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions -- Type: object | Use this object to allow the Email Label shipment originator,  specify if the Email label shipment completer can make modifications to editable shipment data.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions.options -- Type: array | Example: ['ALLOW_MODIFICATIONS'] | These are processing options.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions.options[] -- Type: string | Valid values: ALLOW_MODIFICATIONS
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification -- Type: object | These are documents that are recommended to be included with the shipment.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification.types -- Type: array | Example: ANTIQUE_STATEMENT_EUROPEAN_UNION | This is the recommended document Type.<br><a onclick='loadDocReference("shipmentdocumenttype")'>click here to see shipment document type</a>
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification.types[] -- Type: string | Valid values: ANTIQUE_STATEMENT_EUROPEAN_UNION, ANTIQUE_STATEMENT_UNITED_STATES, ASSEMBLER_DECLARATION, BEARING_WORKSHEET, CERTIFICATE_OF_SHIPMENTS_TO_SYRIA, COMMERCIAL_INVOICE_FOR_THE_CARIBBEAN_COMMON_MARKET, CONIFEROUS_SOLID_WOOD_PACKAGING_MATERIAL_TO_THE_PEOPLES_REPUBLIC_OF_CHINA, DECLARATION_FOR_FREE_ENTRY_OF_RETURNED_AMERICAN_PRODUCTS, DECLARATION_OF_BIOLOGICAL_STANDARDS, DECLARATION_OF_IMPORTED_ELECTRONIC_PRODUCTS_SUBJECT_TO_RADIATION_CONTROL_STANDARD, ELECTRONIC_INTEGRATED_CIRCUIT_WORKSHEET, FILM_AND_VIDEO_CERTIFICATE, INTERIM_FOOTWEAR_INVOICE, USMCA_CERTIFICATION_OF_ORIGIN_CANADA_ENGLISH, USMCA_CERTIFICATION_OF_ORIGIN_CANADA_FRENCH, USMCA_CERTIFICATION_OF_ORIGIN_SPANISH, USMCA_CERTIFICATION_OF_ORIGIN_UNITED_STATES, PACKING_LIST, PRINTED_CIRCUIT_BOARD_WORKSHEET, REPAIRED_WATCH_BREAKOUT_WORKSHEET, STATEMENT_REGARDING_THE_IMPORT_OF_RADIO_FREQUENCY_DEVICES, TOXIC_SUBSTANCES_CONTROL_ACT, UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERSHIP_ACT_CERTIFICATE_OF_ORIGIN_TEXTILES, UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERSHIP_ACT_CERTIFICATE_OF_ORIGIN_NON_TEXTILES, UNITED_STATES_NEW_WATCH_WORKSHEET, UNITED_STATES_WATCH_REPAIR_DECLARATION
requestedShipment.shipmentSpecialServices.returnShipmentDetail -- Type: object | Use this object for specifying return shipment details.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail -- Type: object | Specifies the details of an outbound shipment in order to associate the return shipment to it.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail.shipDatestamp -- Type: string | Example: 2019-10-01 | This is the ship date for the outbound shipment associated with a return shipment. The format is YYYY-MM-DD.<br> Example: 2019-10-01
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail.trackingNumber -- Type: string | Example: 123456789 | This is the tracking number associated with this package.<br>Example: 49XXX0000XXX20032835
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail -- Type: object | These are email details for the return shipment.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail.allowedSpecialService -- Type: array | Indicate the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created.<br>Only services represented in EmailLabelAllowedSpecialServiceType will b...
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail.allowedSpecialService[] -- Type: string | Valid values: SATURDAY_DELIVERY, SATURDAY_PICKUP | Example: SATURDAY_DELIVERY
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail.merchantPhoneNumber -- Type: string | Example: 19012635656 | This is the merchant phone number and required for Email Return Labels.<br>Example: 19012635656
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnType -- Type: string | Valid values: PENDING, PRINT_RETURN_LABEL | Example: PRINT_RETURN_LABEL | 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 mu...
requestedShipment.shipmentSpecialServices.returnShipmentDetail.rma -- Type: object | This is a Return Merchant Authorization (RMA) for the return shipment.<br> Reason for the requirement is mandatory.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.rma.reason -- Type: string | Example: Wrong Size or Color | Specify the reason for the return.<br> Note: There is no validation for reason. Recommended length is 60 alpha-numeric characters<br>Example: Wrong color or size.
requestedShipment.shipmentSpecialServices.shipmentCODDetail -- Type: object | This is the shipment level COD detail.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail -- Type: object | Use this object to specify C.O.D. transportation charges.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.chargeLevelType -- Type: string | Valid values: CURRENT_PACKAGE, SUM_OF_PACKAGES | Specify which level the charges to be applied.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.chargeType -- Type: string | Valid values: COD_SURCHARGE, NET_CHARGE, NET_FREIGHT, TOTAL_CUSTOMER_CHARGE | Specify Charge type.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Specify which level the rate to be applied.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.rateType -- Type: string | Valid values: ACCOUNT, CURRENT, CUSTOM | Specify the Rate Type used.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount -- Type: object | Indicate the COD collection amount. Specifies taxes or miscellaneous charge.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionType -- Type: string | Valid values: ANY, CASH, GUARANTEED_FUNDS, COMPANY_CHECK, PERSONAL_CHECK | Identifies the type of funds FedEx should collect upon shipment delivery
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | Descriptive data of the Cash On Delivery along with their details of the physical location.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins -- Type: array | This is the tax identification number details.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Specifies the contact and address details of a location.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.remitToName -- Type: string | Example: remitToName | Specify the name of the person or company receiving the secured/unsecured funds payment.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.returnReferenceIndicatorType -- Type: string | Valid values: INVOICE, PO, REFERENCE, TRACKING | Indicate return reference type information to include on the COD return shipping label.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount -- Type: object | Indicate the COD amount for this shipment. Specifies taxes or miscellaneous charge.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail -- Type: object | This is the descriptive data required for a FedEx shipment containing dangerous materials. This element is required when SpecialServiceType DRY_ICE is selected.<p><i>Note:<ul><li>Dry Ice is a Packa...
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.packageCount -- Type: integer | Format: int32 | Example: 12 | Indicates the total number of packages in the shipment that contain dry ice.<br>Example: 12
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight -- Type: object | Example: {'units': 'LB', 'value': 10} | These are the package weight details.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.units -- Type: string | Valid values: KG, LB | Example: LB | This is the package weight unit. For Dry Ice the unit of measure is KG.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.shipmentSpecialServices.specialServiceTypes -- Type: array | Example: ['THIRD_PARTY_CONSIGNEE'] | Indicate the Special services requested for this shipment.<br>Example: <ul><li>HOLD_AT_LOCATION</li><li>RETURN_SHIPMENT</li><li>BROKER_SELECT_OPTION</li><li>CALL_BEFORE_DELIVERY</li><li>COD</li><li...
requestedShipment.shipmentSpecialServices.specialServiceTypes[] -- Type: string
requestedShipment.shipper -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | Indicate shippers details. <br>Note: Shipper address and Origin address should be the same address. Indicate the Shipper contact details for this shipment.
requestedShipment.shipper.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipper.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shipper.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipper.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shipper.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipper.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipper.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shipper.address.streetLines[] -- Type: string
requestedShipment.shipper.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shipper.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.shipper.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipper.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.shipper.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipper.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shipper.tins -- Type: array | This is the tax identification number details.
requestedShipment.shipper.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shipper.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipper.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipper.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shipper.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shipper.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shippingChargesPayment -- Type: object | Example: {'paymentType': 'SENDER', 'payor': {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': 'XXXX567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}}}} | Specifies the payment details specifying the method and means of payment to FedEx for providing shipping services.
requestedShipment.shippingChargesPayment.paymentType -- Type: string | Valid values: SENDER, RECIPIENT, THIRD_PARTY, COLLECT | Specifies the payment Type. <br>Note: This is required for Express, Ground and SmartPost shipments.<br> The payment type COLLECT is applicable only for Ground shipments.
requestedShipment.shippingChargesPayment.payor -- Type: object | Example: {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': 'XXXX567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}}} | Payor is mandatory when the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.shippingChargesPayment.payor.responsibleParty -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'FedEx'}, 'accountNumber': {'value': 'Your account number'}} | Indicate the payer Information responsible for paying for the shipment. <br>Note: ResponsibleParty accountNumber is required for ACCOUNT based services.
requestedShipment.shippingChargesPayment.payor.responsibleParty.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.shippingChargesPayment.payor.responsibleParty.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.shippingChargesPayment.payor.responsibleParty.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.streetLines[] -- Type: string
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shippingDocumentSpecification -- Type: object | Use this object to provide all data required for additional (non-label) shipping documents to be produced.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin -- Type: object | The instructions indicating how to print the Certificate of Origin ( e.g. whether or not to include the instructions, image type, etc ...)
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail -- Type: object | The instructions indicating how to print the Commercial Invoice( e.g. image type) Specifies characteristics of a shipping document to be produced.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail -- Type: object | Use this object to specify details to generate general agency agreement detail.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.op900Detail -- Type: object | Use this object to specify details to generate the OP-900 document for hazardous material packages.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages -- Type: array | Specify the use and identification of supplied images to be used on document.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.op900Detail.signatureName -- Type: string | Example: Signature Name | Indicates the name to be printed as signature on the document instead of (or in addition to) a signature image.<br>Example: John Hill
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail -- Type: object | These are return instruction details which will be returned in the transaction to be printed on Return Label.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.customText -- Type: string | Example: This is additional text printed on Return instr | Specify additional information (text) to be inserted into the return document.<br>Example: This is additional text printed on Return Label
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat -- Type: object | These are characteristics of a shipping document to be produced.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions -- Type: array | Details on creating, organizing, and returning the document.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.docType -- Type: string | Valid values: PNG, PDF | Example: PNG | Specify the image format used for shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.locale -- Type: string | Example: en_US" | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Use this element to indicate whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Specify the label stock type.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.shippingDocumentTypes -- Type: array | Example: ['RETURN_INSTRUCTIONS', 'DANGEROUS_GOODS_SHIPPERS_DECLARATION'] | Indicates the types of shipping documents requested.
requestedShipment.shippingDocumentSpecification.shippingDocumentTypes[] -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, CUSTOM_PACKAGE_DOCUMENT, CUSTOM_SHIPMENT_DOCUMENT, CUSTOMER_SPECIFIED_LABELS, EXPORT_DECLARATION, DANGEROUS_GOODS_SHIPPERS_DECLARATION, GENERAL_AGENCY_AGREEMENT, LABEL, USMCA_CERTIFICATION_OF_ORIGIN, OP_900, PENDING_SHIPMENT_EMAIL_NOTIFICATION, PRO_FORMA_INVOICE, RETURN_INSTRUCTIONS, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail -- Type: object | The instructions indicating how to print the USMCA Certificate of Origin (e.g. whether or not to include the instructions, image type, etc ...).
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod -- Type: object | Date Range for custom delivery request; only used if type is BETWEEN.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod.begins -- Type: string | Example: 22-01-2020 | Indicates the start date.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod.ends -- Type: string | Example: 2-01-2020 | Indicates the end date.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.certifierJobTitle -- Type: string | Example: Manager | Specify the job title of the certifier
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.certifierSpecification -- Type: string | Valid values: EXPORTER, IMPORTER, PRODUCER | Example: EXPORTER | This is certifier specification.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.importerSpecification -- Type: string | Valid values: UNKNOWN, VARIOUS | Example: UNKNOWN | This is importer specification.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br>Example: Beverly Hills
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.geographicCoordinates -- Type: string | Example: geographicCoordinates | Indicates the geographic coordinates. <br> example: geographicCoordinates
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.postalCode -- Type: string | Example: 90210 | This is the Postal code.<br>This is Optional for non postal-aware countries.<br>Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Po...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.streetLines[] -- Type: string
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation of the company name.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.faxNumber -- Type: string | Specify contact person's fax number. Maximum length is 15.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br> Example: John Taylor
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. <br>Minimum length is 10 and supports Maximum as 15 for certain countries using longer phone numbers. <br>Note: Recommended Maximum length is 15 and there's no specifi...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins -- Type: array | This is the tax identification number details.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producerSpecification -- Type: string | Valid values: AVAILABLE_UPON_REQUEST, VARIOUS, SAME_AS_EXPORTER | Example: SAME_AS_EXPORTER | This is producer specification.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail -- Type: object | The instructions indicating commercial invoice certification of origin.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.certifierJobTitle -- Type: string | Example: Manager | Specify the job title of the certifier
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.certifierSpecification -- Type: string | Valid values: EXPORTER, IMPORTER, PRODUCER | Example: EXPORTER | This is certifier specification.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.importerSpecification -- Type: string | Valid values: UNKNOWN, VARIOUS | Example: UNKNOWN | This is importer specification.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br>Example: Beverly Hills
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.geographicCoordinates -- Type: string | Example: geographicCoordinates | Indicates the geographic coordinates. <br> example: geographicCoordinates
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.postalCode -- Type: string | Example: 90210 | This is the Postal code.<br>This is Optional for non postal-aware countries.<br>Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Po...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.streetLines[] -- Type: string
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation of the company name.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.faxNumber -- Type: string | Specify contact person's fax number. Maximum length is 15.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br> Example: John Taylor
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. <br>Minimum length is 10 and supports Maximum as 15 for certain countries using longer phone numbers. <br>Note: Recommended Maximum length is 15 and there's no specifi...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins -- Type: array | This is the tax identification number details.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producerSpecification -- Type: string | Valid values: AVAILABLE_UPON_REQUEST, VARIOUS, SAME_AS_EXPORTER | Example: SAME_AS_EXPORTER | This is producer specification.
requestedShipment.smartPostInfoDetail -- Type: object | Use this object to specify the smartpost shipment details. <br>Required for SMARTPOST service. If SmartPostInfoDetail is indicated, the elements below it are also required.
requestedShipment.smartPostInfoDetail.ancillaryEndorsement -- Type: string | Valid values: ADDRESS_CORRECTION, CARRIER_LEAVE_IF_NO_RESPONSE, CHANGE_SERVICE, FORWARDING_SERVICE, RETURN_SERVICE | Example: RETURN_SERVICE | Indicate the type of ancillary endorsement. Is required for Presorted Standard but not for returns or parcel select. <br>Note: Not all are usable for all ancillary endorsements.<br>For more informa...
requestedShipment.smartPostInfoDetail.hubId -- Type: string | Example: 5015 | Specify the four-digit numeric Hub ID value used for smartport shipments.<br><a onclick='loadDocReference("smartposthubids")'>click here to see Hub Ids</a>
requestedShipment.smartPostInfoDetail.indicia -- Type: string | Valid values: MEDIA_MAIL, PARCEL_RETURN, PARCEL_SELECT, PRESORTED_BOUND_PRINTED_MATTER, PRESORTED_STANDARD | Example: PRESORTED_STANDARD | Specify the indicia type.<br>Available options include:<ul><li>MEDIA_MAIL</li><li>PARCEL_SELECT (1 LB through 70 LB)</li><li>PRESORTED_BOUND_PRINTED_MATTER</li><li>PRESORTED_STANDARD (less than 1 L...
requestedShipment.smartPostInfoDetail.specialServices -- Type: string | Valid values: USPS_DELIVERY_CONFIRMATION | Example: USPS_DELIVERY_CONFIRMATION | Specify the special handling associated with Smartpost Shipment.
requestedShipment.totalWeight -- Type: integer | Format: int32 | Example: 20 | shipment total weight should be in Kg or in Lbs
requestedShipment.variableHandlingChargeDetail -- Type: object | Indicate the details about how to calculate variable handling charges at the shipment level. They can be based on a percentage of the shipping charges or a fixed amount. If indicated, element rateL...
requestedShipment.variableHandlingChargeDetail.fixedValue -- Type: object | Example: {'amount': 24.45, 'currency': 'USD'} | 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. <br>Example: 5.00. Specifies taxes or...
requestedShipment.variableHandlingChargeDetail.fixedValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45 fixed variable handling charge amount
requestedShipment.variableHandlingChargeDetail.fixedValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a> fixed variable handling charge currency type<br><a o...
requestedShipment.variableHandlingChargeDetail.percentValue -- Type: number | Format: double | Example: 12.45 | This is the variable handling percentage. If the percent value is mentioned as 10, it means 10%(multiplier of 0.1).<br>Example: 12.45
requestedShipment.variableHandlingChargeDetail.rateElementBasis -- Type: string | Valid values: NET_CHARGE, NET_FREIGHT, BASE_CHARGE, NET_CHARGE_EXCLUDING_TAXES | Example: NET_CHARGE_EXCLUDING_TAXES | Specify the charge type upon which the variable handling percentage amount is calculated.
requestedShipment.variableHandlingChargeDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Example: INDIVIDUAL_PACKAGE_RATE | Specifies if the rate level type is either Individual or Bundled.
requestedShipment.variableHandlingChargeDetail.rateType -- Type: string | Valid values: ACCOUNT, ACTUAL, CURRENT, CUSTOM, LIST, INCENTIVE, PREFERRED, PREFERRED_INCENTIVE, PREFERRED_CURRENCY | Example: PREFERRED_CURRENCY | This is the rate type used for this package.

Retrieve Async Ship

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | Example: 0e671149-016f-1000-941f-ef4dbabadd2e | This transaction Id helps the customers to track the transaction with APIF.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
jobId -- Type: string | Example: 89sxxxxx233ae24ff31xxxxx | Indicates the job under which the deferred shipment artifacts must be identified in the subsequent retrieval request. <br> Example: 89sxxxxx233ae24ff31xxxxx

Create Tag

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
accountNumber -- Type: object | Example: {'value': 'Your account number'} | The specific FedEx customer account number (account value) associated with the shipment. This is FedEx Account number details.
accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment -- Type: object | The shipment data describing the shipment being tendered to FedEx. The descriptive data of the requested shipment.
requestedShipment.blockInsightVisibility -- Type: boolean | Example: True | Indicate if the shipment be available to be visible/tracked using FedEx InSight<sup>®</sup> tool. If value indicated as true, only the shipper/payer will have visibility of this shipment in the Fed...
requestedShipment.customsClearanceDetail -- Type: object | These are customs clearance details. Required for International and intra-country Shipments.
requestedShipment.customsClearanceDetail.brokers -- Type: array | 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 ...
requestedShipment.customsClearanceDetail.brokers[] -- Type: object | Example: {'broker': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 91, 'companyName': 'Fedex', 'faxNumber': 1234567}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}], 'deliveryInstructions': 'deliveryInstructions'}, 'type': 'IMPORT'} | These are broker details for the shipment.
requestedShipment.customsClearanceDetail.brokers[].broker -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | These are broker details for the shipment with physical address, contact and account number information.
requestedShipment.customsClearanceDetail.brokers[].broker.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.customsClearanceDetail.brokers[].broker.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.customsClearanceDetail.brokers[].broker.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.customsClearanceDetail.brokers[].broker.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.customsClearanceDetail.brokers[].broker.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.customsClearanceDetail.brokers[].broker.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.customsClearanceDetail.brokers[].broker.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.customsClearanceDetail.brokers[].broker.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.customsClearanceDetail.brokers[].broker.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.customsClearanceDetail.brokers[].broker.address.streetLines[] -- Type: string
requestedShipment.customsClearanceDetail.brokers[].broker.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment. Specifies broker contact details.
requestedShipment.customsClearanceDetail.brokers[].broker.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.customsClearanceDetail.brokers[].broker.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.customsClearanceDetail.brokers[].broker.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.customsClearanceDetail.brokers[].broker.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.customsClearanceDetail.brokers[].broker.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.customsClearanceDetail.brokers[].broker.tins -- Type: array | This is the tax identification number details.
requestedShipment.customsClearanceDetail.brokers[].broker.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.customsClearanceDetail.brokers[].broker.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.customsClearanceDetail.brokers[].type -- Type: string | Valid values: IMPORT | Example: IMPORT | Identifies the type of broker.
requestedShipment.customsClearanceDetail.commercialInvoice -- Type: object | Use this object to provide Commercial Invoice details. This element is required for electronic upload of CI data. It will serve to create/transmit an electronic Commercial Invoice through the FedEx...
requestedShipment.customsClearanceDetail.commercialInvoice.comments -- Type: array | Example: ['optional comments for the commercial invoice'] | 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 i...
requestedShipment.customsClearanceDetail.commercialInvoice.comments[] -- Type: string
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences -- Type: array | These are additional customer reference data for commercial invoice.
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences[] -- Type: object
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences[].customerReferenceType -- Type: string | Valid values: INVOICE_NUMBER, P_O_NUMBER | Example: INVOICE_NUMBER | This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information.<p>Note: <ul><li>The P_O_NUMBER value must b...
requestedShipment.customsClearanceDetail.commercialInvoice.customerReferences[].value -- Type: string | Example: 3686 | This is a customer reference type value.<br>Example: 3686<br>Note: Maximum length for all customer references is 40 characters.
requestedShipment.customsClearanceDetail.commercialInvoice.declarationStatement -- Type: string | Example: declarationStatement | This is the declaration statement which will populate the Commercial Invoice (or Pro Forma).<br>Maximum length is 554.<br>Example: declarationStatement
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail -- Type: object | These are email disposition details. Provides the type and email addresses of e-mail recipients. If returnedDispositionDetail in labelSpecification is set as true then email will be send with label...
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.emailAddress -- Type: string | Example: neena@fedex.com | This is email Address.<br>Example: xxxx@xxx.com
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.recipientType -- Type: string | Example: SHIPPER | Specify the recipient Type.<br>Example: SHIPPER/BROKER
requestedShipment.customsClearanceDetail.commercialInvoice.emailNotificationDetail.type -- Type: string | Example: EMAILED | Specify the email status.<br>Example: EMAILED
requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge -- Type: object | Indicate the freight charge. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.freightCharge.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts -- Type: object | Indicate the handling cost. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.handlingCosts.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.originatorName -- Type: string | Example: originator Name | The originator name that will populate the Commercial Invoice (or Pro Forma).
requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts -- Type: object | Indicate the packing cost. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.packingCosts.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.shipmentPurpose -- Type: string | Valid values: GIFT, NOT_SOLD, PERSONAL_EFFECTS, REPAIR_AND_RETURN, SAMPLE, SOLD | Example: REPAIR_AND_RETURN | This is the reason for the shipment. <br>Note: SOLD is not a valid purpose for a Proforma Invoice.
requestedShipment.customsClearanceDetail.commercialInvoice.specialInstructions -- Type: string | Example: specialInstructions" | These are special instructions that will be populated on the Commercial Invoice (or Pro Forma).<br>Example: specialInstructions
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge -- Type: object | Indicate the taxes or miscellaneous charges(other than freight charges or insurance charges) that are associated with the shipment. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousCharge.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commercialInvoice.taxesOrMiscellaneousChargeType -- Type: string | Valid values: COMMISSIONS, DISCOUNTS, HANDLING_FEES, OTHER, ROYALTIES_AND_LICENSE_FEES, TAXES | Example: COMMISSIONS | Indicate the type of taxes Or miscellaneous charge.
requestedShipment.customsClearanceDetail.commercialInvoice.termsOfSale -- Type: string | Example: FCA | Specify terms Of Sale that will be populated on the Commercial Invoice (or Pro Forma). Maximum length is 3<br>Valid values are:<ul><li>FCA/FOB (Free Carrier/Free On Board): Seller is responsible fo...
requestedShipment.customsClearanceDetail.commodities -- Type: array | Indicates the details about the dutiable packages. Maximum upto 999 commodities per shipment.
requestedShipment.customsClearanceDetail.commodities[] -- Type: object
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures -- Type: array | This object contains additional quantitative information other than weight and quantity to calculate duties and taxes.
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures[] -- Type: object
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures[].quantity -- Type: number | Format: double | Example: 12.45 | Specify commodity quantity.
requestedShipment.customsClearanceDetail.commodities[].additionalMeasures[].units -- Type: string | Example: KG | Unit of measure used to express the quantity of this commodity line item.
requestedShipment.customsClearanceDetail.commodities[].cIMarksAndNumbers -- Type: string | Example: 87123 | This is an identifying mark or number used on the packaging of a shipment to help customers identify a particular shipment<br>Example: 87123
requestedShipment.customsClearanceDetail.commodities[].countryOfManufacture -- Type: string | Example: US | This is commodity country of manufacture. This is required for International shipments. Maximum allowed length is 4.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to se...
requestedShipment.customsClearanceDetail.commodities[].customsValue -- Type: object | This is the customs value. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commodities[].customsValue.amount -- Type: number | Format: double | Example: 1556.25 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example:  1556.25
requestedShipment.customsClearanceDetail.commodities[].customsValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commodities[].description -- Type: string | Example: description | This is the commodity description. Maximum allowed 450 characters.<br><a onclick='loadDocReference("vaguecommoditydescriptions")'>click here to see Vague commodity descriptions</a>
requestedShipment.customsClearanceDetail.commodities[].exportLicenseExpirationDate -- Type: string | Format: date-time | Specify the export license expiration date for the shipment.<br>Format YYYY-MM-DD<br>Example : 2009-04-12
requestedShipment.customsClearanceDetail.commodities[].exportLicenseNumber -- Type: string | Example: 26456 | This is the export license number for the shipment.<br>Example: 26456
requestedShipment.customsClearanceDetail.commodities[].harmonizedCode -- Type: string | Example: 0613 | This is to specify the Harmonized Tariff System (HTS) code to meet U.S. and foreign governments' customs requirements. These are mainly used to estimate the duties and taxes.<br>Example: 0613<br>To...
requestedShipment.customsClearanceDetail.commodities[].name -- Type: string | Example: non-threaded rivets | This is Commodity name.<br>Example: Non-Threaded Rivets
requestedShipment.customsClearanceDetail.commodities[].numberOfPieces -- Type: integer | Format: int32 | Example: 12 | Indicate the number of pieces associated with the commodity. The value can neither be negative nor exceed 9,999.<br>Example: 12
requestedShipment.customsClearanceDetail.commodities[].partNumber -- Type: string | Example: 167 | This is a part number.<br>Example: 167
requestedShipment.customsClearanceDetail.commodities[].purpose -- Type: string | Valid values: BUSINESS, CONSUMER | Example: BUSINESS | This is the purpose of this shipment. This is used for calculation of duties and taxes.
requestedShipment.customsClearanceDetail.commodities[].quantity -- Type: integer | Format: int32 | Example: 125 | This is the units quantity (using quantityUnits as the unit of measure) per commodity. This is used to estimate duties and taxes.<br> Example: 125
requestedShipment.customsClearanceDetail.commodities[].quantityUnits -- Type: string | Example: Ea | This is the unit of measure for the units quantity. This is used to estimate duties and taxes.<br>Example: EA<br><a onclick='loadDocReference("harmonizedsystemcodeunitofmeasure-table1")'>click here...
requestedShipment.customsClearanceDetail.commodities[].unitPrice -- Type: object | This is the unit price. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.commodities[].unitPrice.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.commodities[].unitPrice.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.commodities[].usmcaDetail -- Type: object | Indicates the USMCA detail
requestedShipment.customsClearanceDetail.commodities[].usmcaDetail.originCriterion -- Type: string | Valid values: A, B, C, D, E | Specify the origin criterion.
requestedShipment.customsClearanceDetail.commodities[].weight -- Type: object | Example: {'units': 'KG', 'value': 68} | These are the package weight details.<br>Note: Weight is not required for One rate shipments
requestedShipment.customsClearanceDetail.commodities[].weight.units -- Type: string | Valid values: KG | Example: KG | Indicate the weight unit type. The package and commodity weight unit should be the same else the request will result in an error.
requestedShipment.customsClearanceDetail.commodities[].weight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.customsClearanceDetail.customsOption -- Type: object | Example: {'description': 'Description', 'type': 'COURTESY_RETURN_LABEL'} | These are customs Option Detail, type must be indicated for each occurrence.
requestedShipment.customsClearanceDetail.customsOption.description -- Type: string | Example: Description | Specify additional description about customs options. This is a required field when the Type is OTHER.
requestedShipment.customsClearanceDetail.customsOption.type -- Type: string | Valid values: COURTESY_RETURN_LABEL, EXHIBITION_TRADE_SHOW, FAULTY_ITEM, FOLLOWING_REPAIR, FOR_REPAIR, ITEM_FOR_LOAN, OTHER, REJECTED, REPLACEMENT, TRIAL | Example: COURTESY_RETURN_LABEL | Specify the reason for a global return, as recognized by Customs. Valid values:<ul><li>COURTESY_RETURN_LABEL: Applicable for Outbound shipments.</li><li>EXHIBITION_TRADE_SHOW: For exhibition or tra...
requestedShipment.customsClearanceDetail.declarationStatementDetail -- Type: object | Specifies about the statements to be declared for Customs.
requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail -- Type: object | Specify the low Value statement necessary for printing the USMCA for Customs documentation.
requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail.countryOfOriginLowValueDocumentRequested -- Type: boolean | Example: True | Specify the country Of Origin of Low Value Document for Customs declaration.
requestedShipment.customsClearanceDetail.declarationStatementDetail.usmcaLowValueStatementDetail.customsRole -- Type: string | Valid values: EXPORTER, IMPORTER | Example: EXPORTER | Specify the shipper role for Customs declaration.
requestedShipment.customsClearanceDetail.dutiesPayment -- Type: object | Example: {'payor': {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}, {'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}}, 'billingDetails': {'billingCode': 'billingCode', 'billingType': 'billingType', 'aliasId': 'aliasId', 'accountNickname': 'accountNickname', 'accountNumber': 'Your account number', 'accountNumberCountryCode': 'US'}, 'paymentType': 'SENDER'} | This is a payment type, basically indicates who is the payor for the shipment.Conditional required for International Shipments
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails -- Type: object | Example: {'billingCode': '128345', 'billingType': 'billingType', 'aliasId': 'alias identifier', 'accountNickname': 'accountNickname', 'accountNumber': 'Your account number', 'accountNumberCountryCode': 'CA'} | These are billing details.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNickname -- Type: string | This is account nick name.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNumber -- Type: string | This is bill to account number.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.accountNumberCountryCode -- Type: string | This is the country code of the account number.<br>Example: CA
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.aliasId -- Type: string | This is bill to alias identifier.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.billingCode -- Type: string | Indicates a billing code.
requestedShipment.customsClearanceDetail.dutiesPayment.billingDetails.billingType -- Type: string | These are duties and taxes billing type.
requestedShipment.customsClearanceDetail.dutiesPayment.paymentType -- Type: string | Valid values: SENDER, RECIPIENT, THIRD_PARTY, COLLECT | This is a payment type, basically indicates who is the payor for the shipment.<br>Required for Express and Ground.<br>The payment type COLLECT is applicable only for Ground shipments.
requestedShipment.customsClearanceDetail.dutiesPayment.payor -- Type: object | Example: {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}, {'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}} | Information about the person who is paying for the shipment. Not applicable for credit card payment.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}, {'number': 'number', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | Use this object to provide the attributes such as physical address, contact information and account number information.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.address.streetLines[] -- Type: string
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins -- Type: array | This is the tax identification number details.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.customsClearanceDetail.dutiesPayment.payor.responsibleParty.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.customsClearanceDetail.exportDetail -- Type: object | These are export Detail used for US or CA exports.
requestedShipment.customsClearanceDetail.exportDetail.b13AFilingOption -- Type: string | Valid values: NOT_REQUIRED, MANUALLY_ATTACHED, FILED_ELECTRONICALLY, SUMMARY_REPORTING, FEDEX_TO_STAMP | Example: NOT_REQUIRED | 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. Virgi...
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail -- Type: object | Use this object to specify the appropriate destination control statement type(s). Also make sure to specify destination country and end user.
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.destinationCountries -- Type: array | Example: ['USA', 'India'] | Specify DCS shipment destination country. You may enter up to four country codes in this element. Up to 11 alphanumeric characters are allowed.<br>Example: US<br><a onclick='loadDocReference("count...
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.destinationCountries[] -- Type: string
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.endUser -- Type: string | Example: dest country user | Specify End User name. Its is required if StatementTypes is entered as DEPARTMENT_OF_STATE. <br>Example: John Wick
requestedShipment.customsClearanceDetail.exportDetail.destinationControlDetail.statementTypes -- Type: string | Valid values: DEPARTMENT_OF_COMMERCE, DEPARTMENT_OF_STATE, DEPARTMENT_OF_COMMERCE_AND_DEPARTMENT_OF_STATE | Example: DEPARTMENT_OF_COMMERCE | Specify appropriate destination control statement type(s), Also make sure to specify destination country and end user.
requestedShipment.customsClearanceDetail.exportDetail.exportComplianceStatement -- Type: string | Example: 12345678901234567 | 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 nu...
requestedShipment.customsClearanceDetail.exportDetail.permitNumber -- Type: string | Example: 12345 | 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.<br> Example: 12345
requestedShipment.customsClearanceDetail.freightOnValue -- Type: string | Valid values: CARRIER_RISK, OWN_RISK | Example: OWN_RISK | Specify the risk owner for the Freight shipment.This element is only mandatory or valid for Intra India shipments.
requestedShipment.customsClearanceDetail.generatedDocumentLocale -- Type: string | Example: en_US | This is the locale for generated document.<br>Example: en_US<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is e...
requestedShipment.customsClearanceDetail.importerOfRecord -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | The descriptive data for the importer of Record for the shipment and their physical address, contact and account number information.
requestedShipment.customsClearanceDetail.importerOfRecord.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.customsClearanceDetail.importerOfRecord.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.customsClearanceDetail.importerOfRecord.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.customsClearanceDetail.importerOfRecord.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.customsClearanceDetail.importerOfRecord.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.customsClearanceDetail.importerOfRecord.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.customsClearanceDetail.importerOfRecord.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.customsClearanceDetail.importerOfRecord.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.customsClearanceDetail.importerOfRecord.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.customsClearanceDetail.importerOfRecord.address.streetLines[] -- Type: string
requestedShipment.customsClearanceDetail.importerOfRecord.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.customsClearanceDetail.importerOfRecord.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.customsClearanceDetail.importerOfRecord.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.customsClearanceDetail.importerOfRecord.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.customsClearanceDetail.importerOfRecord.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.customsClearanceDetail.importerOfRecord.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.customsClearanceDetail.importerOfRecord.tins -- Type: array | This is the tax identification number details.
requestedShipment.customsClearanceDetail.importerOfRecord.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.customsClearanceDetail.importerOfRecord.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.customsClearanceDetail.insuranceCharge -- Type: object | Specify insurance charges if applicable. <br><i>Note: FedEx does not provide insurance of any kind.</i> Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.insuranceCharge.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.insuranceCharge.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.customsClearanceDetail.isDocumentOnly -- Type: boolean | Example: True | 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 -- Type: boolean | Specify if the transacting parties are related.
requestedShipment.customsClearanceDetail.recipientCustomsId -- Type: object | Use this element to provide valid identification details. Used for populating brazil tax id.
requestedShipment.customsClearanceDetail.recipientCustomsId.type -- Type: string | Valid values: COMPANY, INDIVIDUAL, PASSPORT | Example: PASSPORT | This is ID Type.
requestedShipment.customsClearanceDetail.recipientCustomsId.value -- Type: string | Example: 123 | This is the ID number.
requestedShipment.customsClearanceDetail.regulatoryControls -- Type: array | Example: NOT_IN_FREE_CIRCULATION | These are the regulatory controls applicable to the shipment.
requestedShipment.customsClearanceDetail.regulatoryControls[] -- Type: string | Valid values: FOOD_OR_PERISHABLE, USMCA, NOT_APPLICABLE_FOR_LOW_VALUE_CUSTOMS_EXCEPTIONS, NOT_IN_FREE_CIRCULATION
requestedShipment.customsClearanceDetail.totalCustomsValue -- Type: object | This is the total customs value. Specifies taxes or miscellaneous charge.
requestedShipment.customsClearanceDetail.totalCustomsValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.customsClearanceDetail.totalCustomsValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.emailNotificationDetail -- Type: object | This is used to provide eMail notification information..
requestedShipment.emailNotificationDetail.aggregationType -- Type: string | Valid values: PER_PACKAGE, PER_SHIPMENT | Example: PER_PACKAGE | This is the shipment Notification Aggregation Type.
requestedShipment.emailNotificationDetail.emailNotificationRecipients -- Type: array | These are email notification recipient details.
requestedShipment.emailNotificationDetail.emailNotificationRecipients[] -- Type: object | These are recipient details for receiving email notification.
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].emailAddress -- Type: string | Example: jsmith3@aol.com | Specify the recipient email address.<br>Example: xyz@aol.com
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].emailNotificationRecipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: SHIPPER | Specify the recipient type for email notification.
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].locale -- Type: string | Example: en_US | These are the locale details for email.<br>Example: en_US, fr_CA, es_MX,.etc.<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an in...
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].name -- Type: string | Example: Joe Smith | Specify the recipient name.<br>Example: Joe Smith
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationEventType -- Type: array | Example: ['ON_PICKUP_DRIVER_ARRIVED', 'ON_SHIPMENT'] | These are to specify the notification event types.<br> Example: [ON_PICKUP_DRIVER_ARRIVED, ON_SHIPMENT]<br><a onclick='loadDocReference("notificationeventtypes")'>Click here for more information on...
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationEventType[] -- Type: string | Valid values: ON_DELIVERY, ON_EXCEPTION, ON_SHIPMENT, ON_TENDER, ON_ESTIMATED_DELIVERY, ON_PICKUP, ON_LABEL, ON_PICKUP_DRIVER_ARRIVED, ON_PICKUP_DRIVER_ASSIGNED, ON_PICKUP_DRIVER_DEPARTED, ON_PICKUP_DRIVER_EN_ROUTE
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationFormatType -- Type: string | Valid values: HTML, TEXT | Example: TEXT | This is the format for the email notification. Either HTML or plain text can be provided.<br>Example: TEXT
requestedShipment.emailNotificationDetail.emailNotificationRecipients[].notificationType -- Type: string | Valid values: EMAIL | Example: EMAIL | Indicate the type of notification that will be sent as an email<br>Example: EMAIL
requestedShipment.emailNotificationDetail.personalMessage -- Type: string | Example: your personal message here | This is your personal message for the email.<br>Note: The maximum personal message character limit depends on the element notificationFormatType values:<ul><li>If notificationFormatType is TEXT, th...
requestedShipment.expressFreightDetail -- Type: object | Indicates the advance booking number, shipper load /count and packing list details. This details must be provided by the user during freight shipment.
requestedShipment.expressFreightDetail.bookingConfirmationNumber -- Type: string | Example: 123456789812 | 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 Freig...
requestedShipment.expressFreightDetail.packingListEnclosed -- Type: boolean | Example: True | 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. <br> Example: true
requestedShipment.expressFreightDetail.shippersLoadAndCount -- Type: integer | Format: int32 | Example: 123 | Indicates the content of a container were loaded and counted by the shipper.<br>Minimum length: 1 digits <br> Maximum length: 5 digits <br>Example:  If a skid has 32 small boxes on it that are shri...
requestedShipment.labelSpecification -- Type: object | These are label specification details includes the image type, printer format, and label stock for label. Can also specify specific details such as doc-tab content, regulatory labels, and masking d...
requestedShipment.labelSpecification.customerSpecifiedDetail -- Type: object | This object allows the control of label content for customization.
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels -- Type: array | Specify how the additional details to be provided on the labels.
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels[] -- Type: object
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels[].count -- Type: integer | Example: 1 | Specifies the count of label to return.
requestedShipment.labelSpecification.customerSpecifiedDetail.additionalLabels[].type -- Type: string | Valid values: BROKER, CONSIGNEE, CUSTOMS, DESTINATION, DESTINATION_CONTROL_STATEMENT, FREIGHT_REFERENCE, MANIFEST, ORIGIN, RECIPIENT, SECOND_ADDRESS, SHIPPER | Example: CONSIGNEE | Specify the type of additional  details to be added on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent -- Type: object | Specifies details of doc tab content.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded -- Type: object | It is a doc tab content type which is in barcoded format.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification -- Type: object | Indicates the doc tab zone specification.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.dataField -- Type: string | Indicate the path request/reply element to be printed on doc tab.<br>Example:<ul><li>REQUEST/SHIPMENT/ShipTimestamp</li><li>REQUEST/PACKAGE/weight/Value</li><li>REQUEST/PACKAGE/InsuredValue/Amount<...
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.header -- Type: string | Indicates the parameter name in the header for the doc tab zone.<br>Example:  WHT
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.justification -- Type: string | Valid values: LEFT, RIGHT | Example: RIGHT | Indicates the justification format for the string.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.literalValue -- Type: string | Indicates the actual data to be printed in the label<br>
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.specification.zoneNumber -- Type: integer | Format: int32 | It is a non-negative integer that represents the portion of doc-tab in a label.<br>Example: 1
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.barcoded.symbology -- Type: string | Valid values: CODABAR, CODE128, CODE128_WIDEBAR, CODE128B, CODE128C, CODE39, CODE93, I2OF5, MANUAL, PDF417, POSTNET, QR_CODE, UCC128 | Example: UCC128 | Indicates the type of barcode symbology used on FedEx documents and labels.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.docTabContentType -- Type: string | Valid values: BARCODED, CUSTOM, MINIMUM, STANDARD, ZONE001 | Example: BARCODED | Indicates the content type of the doc tab.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001 -- Type: object | Indicate the doc tab specification for different zones on the label. The specification includes zone number, header and data field to be displayed on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications -- Type: array | Indicate the doc tab specifications for the individual doc tab zone on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[] -- Type: object | Indicates the doc tab zone specification.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].dataField -- Type: string | Indicate the path request/reply element to be printed on doc tab.<br>Example:<ul><li>REQUEST/SHIPMENT/ShipTimestamp</li><li>REQUEST/PACKAGE/weight/Value</li><li>REQUEST/PACKAGE/InsuredValue/Amount<...
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].header -- Type: string | Indicates the parameter name in the header for the doc tab zone.<br>Example:  WHT
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].justification -- Type: string | Valid values: LEFT, RIGHT | Example: RIGHT | Indicates the justification format for the string.
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].literalValue -- Type: string | Indicates the actual data to be printed in the label<br>
requestedShipment.labelSpecification.customerSpecifiedDetail.docTabContent.zone001.docTabZoneSpecifications[].zoneNumber -- Type: integer | Format: int32 | It is a non-negative integer that represents the portion of doc-tab in a label.<br>Example: 1
requestedShipment.labelSpecification.customerSpecifiedDetail.maskedData -- Type: array | Example: ['CUSTOMS_VALUE', 'TOTAL_WEIGHT'] | Specify which data/sections on the label to be masked.<br>Note: <ul><li>SECONDARY_BARCODE &ndash; This is used for Smartpost shipment labels.</li><li>SHIPPER_INFORMATION &ndash; This is used for Th...
requestedShipment.labelSpecification.customerSpecifiedDetail.maskedData[] -- Type: string | Valid values: CUSTOMS_VALUE, DIMENSIONS, DUTIES_AND_TAXES_PAYOR_ACCOUNT_NUMBER, INSURED_VALUE, SECONDARY_BARCODE, SHIPPER_INFORMATION, TERMS_AND_CONDITIONS, TOTAL_WEIGHT, TRANSPORTATION_CHARGES_PAYOR_ACCOUNT_NUMBER
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels -- Type: array | Specify how the regulatory details to be provided on the labels.
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels[] -- Type: object
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels[].generationOptions -- Type: string | Valid values: CONTENT_ON_SHIPPING_LABEL_PREFERRED, CONTENT_ON_SUPPLEMENTAL_LABEL_ONLY, CONTENT_ON_SHIPPING_LABEL_ONLY | Example: CONTENT_ON_SHIPPING_LABEL_ONLY | Specify the regulatory content preference to be displayed on the label.
requestedShipment.labelSpecification.customerSpecifiedDetail.regulatoryLabels[].type -- Type: string | Valid values: ALCOHOL_SHIPMENT_LABEL | Example: ALCOHOL_SHIPMENT_LABEL | Specify the type of regulatory content to be added on the label.
requestedShipment.labelSpecification.imageType -- Type: string | Valid values: ZPLII, EPL2, PDF, PNG | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.labelSpecification.labelFormatType -- Type: string | Valid values: COMMON2D, LABEL_DATA_ONLY | Example: COMMON2D | Specify the label Format Type.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.labelSpecification.labelOrder -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST | Example: SHIPPING_LABEL_FIRST | This is the order of the Shipping label/documents to be generated.
requestedShipment.labelSpecification.labelPrintingOrientation -- Type: string | Valid values: BOTTOM_EDGE_OF_TEXT_FIRST, TOP_EDGE_OF_TEXT_FIRST | Example: TOP_EDGE_OF_TEXT_FIRST | This is applicable only to documents produced on thermal printers with roll stock.
requestedShipment.labelSpecification.labelRotation -- Type: string | Valid values: LEFT, RIGHT, UPSIDE_DOWN, NONE | Example: UPSIDE_DOWN | This is applicable only to documents produced on thermal printers with roll stock.
requestedShipment.labelSpecification.labelStockType -- Type: string | Valid values: PAPER_4X6, PAPER_4X675, PAPER_4X8, PAPER_4X9, PAPER_7X475, PAPER_85X11_BOTTOM_HALF_LABEL, PAPER_85X11_TOP_HALF_LABEL, PAPER_LETTER, STOCK_4X675_LEADING_DOC_TAB, STOCK_4X8, STOCK_4X9_LEADING_DOC_TAB, STOCK_4X6, STOCK_4X675_TRAILING_DOC_TAB, STOCK_4X9_TRAILING_DOC_TAB, STOCK_4X9, STOCK_4X85_TRAILING_DOC_TAB, STOCK_4X105_TRAILING_DOC_TAB | Example: PAPER_85X11_TOP_HALF_LABEL | Indicate the label stock type used. <br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.labelSpecification.printedLabelOrigin -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Specifies the contact and address details of a location.
requestedShipment.labelSpecification.printedLabelOrigin.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.labelSpecification.printedLabelOrigin.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.labelSpecification.printedLabelOrigin.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.labelSpecification.printedLabelOrigin.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.labelSpecification.printedLabelOrigin.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.labelSpecification.printedLabelOrigin.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.labelSpecification.printedLabelOrigin.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.labelSpecification.printedLabelOrigin.address.streetLines[] -- Type: string
requestedShipment.labelSpecification.printedLabelOrigin.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.labelSpecification.printedLabelOrigin.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.labelSpecification.printedLabelOrigin.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.labelSpecification.printedLabelOrigin.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.labelSpecification.printedLabelOrigin.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.labelSpecification.printedLabelOrigin.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.labelSpecification.printedLabelOrigin.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.labelSpecification.returnedDispositionDetail -- Type: boolean | Valid values: True, False | Example: True | Specify whether or not the return deposition is needed.
requestedShipment.masterTrackingId -- Type: object | Indicates the tracking details of the package.Required for child shipments of an oneLabelAtATime shipments
requestedShipment.masterTrackingId.formId -- Type: string | Example: 0201 | This is FedEx tracking Identifier associated with the package.<br>Example: 8600
requestedShipment.masterTrackingId.trackingIdType -- Type: string | Example: EXPRESS | Specify the FedEx transportation type. <br>Example: EXPRESS
requestedShipment.masterTrackingId.trackingNumber -- Type: string | Example: 49092000070120032835 | 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. <b...
requestedShipment.masterTrackingId.uspsApplicationId -- Type: string | Example: 92 | Specify the USPS tracking Identifier associated with FedEx SmartPost shipment.<br>Example: 92
requestedShipment.origin -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Indicate shipment origin address information, if it is different from the shipper address. Specifies the contact and address details of a location.
requestedShipment.origin.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.origin.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.origin.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.origin.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.origin.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.origin.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.origin.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.origin.address.streetLines[] -- Type: string
requestedShipment.origin.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.origin.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.origin.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.origin.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.origin.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.origin.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.origin.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers. <br>Note: Recommended Maximum length is 15 and there's no specifi...
requestedShipment.packagingType -- Type: string | Example: YOUR_PACKAGING | Specify the packaging used.<br>Note: For Express Freight shipments, the packaging will default to YOUR_PACKAGING irrespective of the user provided package type in the request.<br>Example: FEDEX_PAK...
requestedShipment.pickupDetail -- Type: object | Specifies the pickup details for the Tag shipment.<br>ReadyDateTime and LatestPickupDateTime are required.
requestedShipment.pickupDetail.latestPickupDateTime -- Type: string | Example: 2020-07-03T09:00:00Z | Specify the last possible pickup date and time.
requestedShipment.pickupDetail.readyPickupDateTime -- Type: string | Example: 2020-07-03T09:00:00Z | Specify the time and date the package will be ready for pickup.
requestedShipment.pickupType -- Type: string | Valid values: CONTACT_FEDEX_TO_SCHEDULE, DROPOFF_AT_FEDEX_LOCATION, USE_SCHEDULED_PICKUP | Example: USE_SCHEDULED_PICKUP | Indicate the pickup type method by which the shipment to be tendered to FedEx.<br><a onclick='loadDocReference("pickuptypes")'>Click here for more information on Pickup Types.</a>
requestedShipment.preferredCurrency -- Type: string | Example: USD | Indicate the currency the caller requests to have used in all returned monetary values. Should be Used in conjunction with the element RateRequestType.<br>Example: USD<br><a onclick='loadDocReferen...
requestedShipment.rateRequestType -- Type: array | Example: ['LIST', 'PREFERRED'] | 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.<br>Following are values:<ul><li>LIST - Returns FedEx...
requestedShipment.rateRequestType[] -- Type: string | Valid values: LIST, NONE, PREFERRED, ACCOUNT, INCENTIVE, RETAIL
requestedShipment.recipientLocationNumber -- Type: string | Example: 1234567 | A unique identifier for a recipient location.
requestedShipment.recipients -- Type: array | Indicate the descriptive data for the recipient location to which the shipment is to be received.
requestedShipment.recipients[] -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'FedEx'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}], 'deliveryInstructions': 'Delivery Instructions'} | The descriptive information of the recipient for the shipment and the physical location for the package destination.
requestedShipment.recipients[].address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.recipients[].address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.recipients[].address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.recipients[].address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.recipients[].address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.recipients[].address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.recipients[].address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.recipients[].address.streetLines[] -- Type: string
requestedShipment.recipients[].contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.recipients[].contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.recipients[].contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.recipients[].contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.recipients[].contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.recipients[].contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.recipients[].deliveryInstructions -- Type: string | Example: Instruction 1 | Specify the delivery instructions to be added with the shipment. Use with Ground Home Delivery.<br>Example: Delivery Instructions
requestedShipment.recipients[].tins -- Type: array | This is the tax identification number details.
requestedShipment.recipients[].tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.recipients[].tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.recipients[].tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.recipients[].tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.recipients[].tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.recipients[].tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.requestedPackageLineItems -- Type: array | 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...
requestedShipment.requestedPackageLineItems[] -- Type: object | 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...
requestedShipment.requestedPackageLineItems[].contentRecord -- Type: array | Use this object to specify package content details.
requestedShipment.requestedPackageLineItems[].contentRecord[] -- Type: object | Use this object to specify package content details.
requestedShipment.requestedPackageLineItems[].contentRecord[].description -- Type: string | Example: Description | This is the description of the package item.
requestedShipment.requestedPackageLineItems[].contentRecord[].itemNumber -- Type: string | Example: 2876 | This is a package item number.
requestedShipment.requestedPackageLineItems[].contentRecord[].partNumber -- Type: string | Example: 456 | This is the part number.
requestedShipment.requestedPackageLineItems[].contentRecord[].receivedQuantity -- Type: integer | Format: int32 | Example: 256 | This is the package item quantity.
requestedShipment.requestedPackageLineItems[].customerReferences -- Type: array | This object lists the customer references provided with the package.
requestedShipment.requestedPackageLineItems[].customerReferences[] -- Type: object
requestedShipment.requestedPackageLineItems[].customerReferences[].customerReferenceType -- Type: string | Valid values: CUSTOMER_REFERENCE, DEPARTMENT_NUMBER, INVOICE_NUMBER, P_O_NUMBER, INTRACOUNTRY_REGULATORY_REFERENCE, RMA_ASSOCIATION | Example: INVOICE_NUMBER | This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information.<p>Note: <ul><li>The P_O_NUMBER value must b...
requestedShipment.requestedPackageLineItems[].customerReferences[].value -- Type: string | Example: 3686 | This is a customer reference type value.<br>Example: 3686<br>Note: Maximum length for all customer references is 40 characters excluding customer reference type for 'RMA_ASSCOATION' where maximum c...
requestedShipment.requestedPackageLineItems[].declaredValue -- Type: object | This is the Declared Value of any shipment which represents FedEx maximum liability associated with a shipment. This is including, but not limited to any loss, damage, delay, misdelivery, any failu...
requestedShipment.requestedPackageLineItems[].declaredValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].declaredValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.requestedPackageLineItems[].dimensions -- Type: object | Example: {'length': 100, 'width': 50, 'height': 30, 'units': 'CM'} | Indicate the dimensions of the package.<br> Following conditions will apply: <ul><li>Dimensions are optional but when added, then all three dimensions must be indicated.</li><li>Dimensions are requ...
requestedShipment.requestedPackageLineItems[].dimensions.height -- Type: integer | Format: int32 | Example: 1 | Indicate the height of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].dimensions.length -- Type: integer | Format: int32 | Example: 3 | Indicate the length of the package. No implied decimal places. Maximum value: 999 <br> Example: 20
requestedShipment.requestedPackageLineItems[].dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Indicate the Unit of measure for the provided dimensions.<br>Valid Values are:<li>IN - inches</li><li>CM - centimeters</li>Note: Any value other than CM including blank/null will default to IN.
requestedShipment.requestedPackageLineItems[].dimensions.width -- Type: integer | Format: int32 | Example: 2 | Indicate the width of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].groupPackageCount -- Type: integer | Format: int32 | Example: 2 | Indicate the grouped package count. These are number of identical package(s) each with one or more commodities. <br> Example: 2
requestedShipment.requestedPackageLineItems[].itemDescription -- Type: string | Example: item description for the package | This the item description for the package.<br>Note: Item description is required for Email Label return shipments and ground Create tag.<br>Example: Item description<br> Maximum limit is 50 characters
requestedShipment.requestedPackageLineItems[].itemDescriptionForClearance -- Type: string | Example: description | Describe the content of the package for customs clearance purposes. This applies to intra-UAE, intra-Columbia and intra-Brazil shipments.
requestedShipment.requestedPackageLineItems[].packageSpecialServices -- Type: object | These are special services that are available at the package level for some or all service types.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail -- Type: object | These are detcontentails for the package containing alcohol. This is required for alcohol special service. The alcoholRecipientType is required.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.alcoholRecipientType -- Type: string | Valid values: LICENSEE, CONSUMER | Example: LICENSEE | Specify the Alcohol Recipient Type of the shipment. <br> Example: LICENSEE
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.shipperAgreementType -- Type: string | Example: Retailer | Specify the type of entity, the shipper for alcohol shipment is registered such as fulfillment house, retailer or a winery.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails -- Type: array | Provide details about the batteries or cells that are contained within this specific package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[] -- Type: object
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryMaterialType -- Type: string | Valid values: LITHIUM_METAL, LITHIUM_ION | Indicate the material composition of the battery or cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryPackingType -- Type: string | Valid values: CONTAINED_IN_EQUIPMENT, PACKED_WITH_EQUIPMENT | Describe the packing arrangement of the battery or cell with respect to other items within the same package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryRegulatoryType -- Type: string | Valid values: IATA_SECTION_II | This is a regulation specific classification for the battery or the cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail -- Type: object | Provide dangerous goods shipment details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.accessibility -- Type: string | Valid values: ACCESSIBLE, INACCESSIBLE | Example: INACCESSIBLE | Specify Dangerous Goods Accessibility Type. <ul><li>Inaccessible &ndash; it does not have to be accessable on the aircraft.</li><li>Accessible &ndash; it must be fully accessible on the aircraft, a...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.cargoAircraftOnly -- Type: boolean | Valid values: True, False | A Boolean value that, when True, specifies the mode of shipment transportation should be Cargo Aircraft for Dangerous Goods. Its default value is set as False.<br>Note: An identifier DGD-CAO is add...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options -- Type: array | Example: ['LIMITED_QUANTITIES_COMMODITIES', 'ORM_D'] | Indicate type of DG being reported.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options[] -- Type: string | Valid values: HAZARDOUS_MATERIALS, BATTERY, ORM_D, REPORTABLE_QUANTITIES, SMALL_QUANTITY_EXCEPTION, LIMITED_QUANTITIES_COMMODITIES
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight -- Type: object | Example: {'units': 'KG', 'value': 68} | These are the package weight details.<br>Note: Weight is not required for One rate shipments
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.units -- Type: string | Valid values: KG | Example: KG | Indicate the weight unit type. The package and commodity weight unit should be the same else the request will result in an error.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail -- Type: object | These are COD package details. For use with FedEx Ground services only; COD must be present in shipments special services.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount -- Type: object | Indicate the COD collection amount. Specifies taxes or miscellaneous charge.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].packageSpecialServices.packageCODDetail.codCollectionAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.requestedPackageLineItems[].packageSpecialServices.pieceCountVerificationBoxCount -- Type: integer | Format: int32 | Specify the count.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail -- Type: object | Specifies the Priority Alert Detail.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.content -- Type: array | Example: ['string'] | Specifies Content for the Priority Alert Detail.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.content[] -- Type: string
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.enhancementTypes -- Type: array | Example: ['PRIORITY_ALERT_PLUS'] | The types of all enhancement for the Priority Alert.<br>Example: PRIORITY_ALERT_PLUS
requestedShipment.requestedPackageLineItems[].packageSpecialServices.priorityAlertDetail.enhancementTypes[] -- Type: string
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionDetail -- Type: object | This element specifies Signature option details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionDetail.signatureReleaseNumber -- Type: string | Example: 23456 | This is release number.<br>Example: 23456
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionType -- Type: string | Valid values: SERVICE_DEFAULT, NO_SIGNATURE_REQUIRED, INDIRECT, DIRECT, ADULT | Example: ADULT | Indicate the Signature Type. <br>Valid Values: <ul><li>ADULT - Adult signature required, at recipient address.</li><li>DIRECT - Signature required, at recipient address.</li><li>INDIRECT - Signatur...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes -- Type: array | Example: ['ALCOHOL', 'NON_STANDARD_CONTAINER'] | Indicate the types of special services requested for the shipment.<br><a onclick='loadDocReference("packagelevelspecialservicetypes")'>click here to see Package Special Service Types</a>
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes[] -- Type: string
requestedShipment.requestedPackageLineItems[].sequenceNumber -- Type: integer | Example: 1 | Optional. <br>Used only with individual packages as a unique identifier of each requested package. Will be adjusted at the shipment level as pieces are added.
requestedShipment.requestedPackageLineItems[].subPackagingType -- Type: string | Example: BUCKET | Indicate the subPackagingType, if you are using your own packaging for the shipment. Use it for all shipments inbound to Canada (CA) and inbound shipments to the U.S. and Puerto Rico (PR) from Cana...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail -- Type: object | Indicate the details about how to calculate variable handling charges at the shipment level. They can be based on a percentage of the shipping charges or a fixed amount. If indicated, element rateL...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue -- Type: object | Example: {'amount': 24.45, 'currency': 'USD'} | 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. <br>Example: 5.00. Specifies taxes or...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45 fixed variable handling charge amount
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.fixedValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a> fixed variable handling charge currency type<br><a o...
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.percentValue -- Type: number | Format: double | Example: 12.45 | This is the variable handling percentage. If the percent value is mentioned as 10, it means 10%(multiplier of 0.1).<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateElementBasis -- Type: string | Valid values: NET_CHARGE, NET_FREIGHT, BASE_CHARGE, NET_CHARGE_EXCLUDING_TAXES | Example: NET_CHARGE_EXCLUDING_TAXES | Specify the charge type upon which the variable handling percentage amount is calculated.
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Example: INDIVIDUAL_PACKAGE_RATE | Specifies if the rate level type is either Individual or Bundled.
requestedShipment.requestedPackageLineItems[].variableHandlingChargeDetail.rateType -- Type: string | Valid values: ACCOUNT, ACTUAL, CURRENT, CUSTOM, LIST, INCENTIVE, PREFERRED, PREFERRED_INCENTIVE, PREFERRED_CURRENCY | Example: PREFERRED_CURRENCY | This is the rate type used for this package.
requestedShipment.requestedPackageLineItems[].weight -- Type: object | Example: {'units': 'KG', 'value': 68} | These are the package weight details.<br>Note: Weight is not required for One rate shipments
requestedShipment.requestedPackageLineItems[].weight.units -- Type: string | Valid values: KG | Example: KG | Indicate the weight unit type. The package and commodity weight unit should be the same else the request will result in an error.
requestedShipment.requestedPackageLineItems[].weight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.serviceType -- Type: string | Example: PRIORITY_OVERNIGHT | Indicate the FedEx service type used for this shipment.<br>Example: STANDARD_OVERNIGHT<br><a onclick='loadDocReference("servicetypes")'>click here to see Service Types</a>
requestedShipment.shipDatestamp -- Type: string | Example: 2019-10-14 | This is the shipment date. Default value is current date in case the date is not provided or a past date is provided.<br>Format [YYYY-MM-DD].<br>Example: 2019-10-14
requestedShipment.shipmentSpecialServices -- Type: object | Specify the special services requested at the shipment level.<br>If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail -- Type: object | Indicate the Delivery On Invoice Acceptance detail. Recipient is required for Delivery On Invoice Special service.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'FedEx'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}], 'deliveryInstructions': 'Delivery Instructions'} | The descriptive data for the recipient of the shipment and the physical location for the shipment destination. The descriptive information of the recipient for the shipment and the physical locatio...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a> The two-letter code used to identify...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory. Identifies the company this contact is associated with. Maximum length is 35.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor Identifies the contact person's name. Maximum length is 70.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.deliveryInstructions -- Type: string | Example: Instruction 1 | Specify the delivery instructions to be added with the shipment. Use with Ground Home Delivery.<br>Example: Delivery Instructions
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins -- Type: array | This is the tax identification number details.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shipmentSpecialServices.deliveryOnInvoiceAcceptanceDetail.recipient.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shipmentSpecialServices.etdDetail -- Type: object | Use this object to specify all information on how the electronic Trade document references used with the shipment.
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments -- Type: array | 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 val...
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[] -- Type: object | Specify the document upload reference details.
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].description -- Type: string | Example: PRO FORMA INVOICE | Specify additional information about the uploaded document for better understanding.<br>Example: Certificate of Origin is uploaded for country of manufacturing verification.
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].documentId -- Type: string | Example: 090927d680038c61 | This is the uploaded document ID value.<br>Example: 090927d680038c61
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].documentReference -- Type: string | Example: DocumentReference | Specify the reference for the uploaded document.This is for the customer to reference their uploaded docs when they retrieve them. Could be anything, order number, po number, whatever the customer ...
requestedShipment.shipmentSpecialServices.etdDetail.attachedDocuments[].documentType -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, ETD_LABEL, USMCA_CERTIFICATION_OF_ORIGIN, OTHER, PRO_FORMA_INVOICE, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN | Example: PRO_FORMA_INVOICE | Specify document type for the uploaded document. It should match with the type of uploaded document associated with documentId.
requestedShipment.shipmentSpecialServices.etdDetail.attributes -- Type: array | Use this attribute to specify if the Trade documents will be uploaded post the shipment.
requestedShipment.shipmentSpecialServices.etdDetail.attributes[] -- Type: string | Valid values: POST_SHIPMENT_UPLOAD_REQUESTED
requestedShipment.shipmentSpecialServices.etdDetail.requestedDocumentTypes -- Type: array | Example: ['VICS_BILL_OF_LADING', 'GENERAL_AGENCY_AGREEMENT'] | 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.<br>Note: For more information...
requestedShipment.shipmentSpecialServices.etdDetail.requestedDocumentTypes[] -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, CUSTOM_PACKAGE_DOCUMENT, CUSTOM_SHIPMENT_DOCUMENT, CUSTOMER_SPECIFIED_LABELS, EXPORT_DECLARATION, DANGEROUS_GOODS_SHIPPERS_DECLARATION, GENERAL_AGENCY_AGREEMENT, LABEL, USMCA_CERTIFICATION_OF_ORIGIN, OP_900, PENDING_SHIPMENT_EMAIL_NOTIFICATION, PRO_FORMA_INVOICE, RETURN_INSTRUCTIONS, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN
requestedShipment.shipmentSpecialServices.holdAtLocationDetail -- Type: object | Use this object to specify required information for a shipment to be held at destination FedEx location.<br><i>Note: This object HoldAtLocationDetail is Required, when HOLD_AT_LOCATION is chosen in...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Specifies the contact and address details of a location.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationId -- Type: string | Example: YBZA | This is an alphanumeric identifier used for Location/Facility Identification.<br>Example: YBZA<br>Note: <ul><li>For HAL Shipment, Location ID is <b>REQUIRED</b> to ensure packages are delivered to ...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationType -- Type: string | Valid values: FEDEX_AUTHORIZED_SHIP_CENTER, FEDEX_OFFICE, FEDEX_SELF_SERVICE_LOCATION, FEDEX_STAFFED, RETAIL_ALLICANCE_LOCATION, FEDEX_GROUND_TERMINAL, FEDEX_ONSITE | Example: FEDEX_ONSITE | Specifies the type of facility at which package/shipment is to be held.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail -- Type: object | These are Special service elements for FedEx Ground Home Delivery shipments. If selected, element homedeliveryPremiumType is mandatory.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.deliveryDate -- Type: string | Example: 2019-06-26 | This is delivery date. Required for FedEx Date Certain Home Delivery. Valid dates are Monday to Sunday. <br>There may be a delay in delivery on Sundays to locations that are geographically difficul...
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.homedeliveryPremiumType -- Type: string | Valid values: APPOINTMENT, DATE_CERTAIN, EVENING | Example: APPOINTMENT | 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 appointme...
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber -- Type: object | Example: {'areaCode': '901', 'localNumber': '3575012', 'extension': '200', 'personalIdentificationNumber': '98712345'} | Indicate the phone number. Only numeric values allowed.<br> Note that phoneNumber is mandatory when homedeliveryPremiumType is DATE_CERTAIN or EVENING.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.areaCode -- Type: string | Indicate the area code for the phone number.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.extension -- Type: string | Indicate the extension for the phone number.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.localNumber -- Type: string | Indicate the local phone number for contacting in the event of an emergency. Maximum length  is 10.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.phoneNumber.personalIdentificationNumber -- Type: string | Indicate the Personal Identification Number associated with the phone number.
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail -- Type: object | Use this object to specify International Controlled Export shipment Details.<br>Note: licenseOrPermitExpirationDate and licenseOrPermitNumber are not required when type is WAREHOUSE_WITHDRAWAL.
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.entryNumber -- Type: string | Example: 125 | Indicate Entry Number for the export.<br>Example: 125
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.foreignTradeZoneCode -- Type: string | Example: US | Indicate the Foreign Trade Zone Code.<br>Example: US
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.licenseOrPermitExpirationDate -- Type: string | Example: 2019-12-03 | Indicate the expiration date for the license or permit. The format is YYYY-MM-DD.<br>Example: "2019-12-03"
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.licenseOrPermitNumber -- Type: string | Example: 11 | Indicate License Or Permit Number for the commodity being exported.<br>Example: 11
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.type -- Type: string | Valid values: DEA_036, DEA_236, DSP_05, DSP_61, DSP_73, DSP_85, DSP_LICENSE_AGREEMENT, WAREHOUSE_WITHDRAWAL | Example: WAREHOUSE_WITHDRAWAL | Indicate International Controlled Export Type.
requestedShipment.shipmentSpecialServices.internationalTrafficInArmsRegulationsDetail -- Type: object | These are International Traffic In Arms Regulations shipment service details.
requestedShipment.shipmentSpecialServices.internationalTrafficInArmsRegulationsDetail.licenseOrExemptionNumber -- Type: string | Example: 9871234 | The export or license number for the ITAR shipment.<br>Minimum length is 5 characters.<br>Maximum length is 21 characters.<br>Example: 9871234
requestedShipment.shipmentSpecialServices.pendingShipmentDetail -- Type: object | This object is used to specify the Pending Shipment Type for Email label.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments -- Type: array | These are the reference document details with the shipment.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[] -- Type: object | Specify the document upload reference details.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].description -- Type: string | Example: PRO FORMA INVOICE | This is the document description of the attached document.<br>Example: PRO FORMA INVOICE
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].documentId -- Type: string | Example: 090927d680038c61 | This is the uploaded document ID value.<br>Example: 090927d680038c61
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].documentReference -- Type: string | Example: DocumentReference | Specify the reference for the uploaded document.<br>Example: Reference
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.attachedDocuments[].documentType -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, ETD_LABEL, USMCA_CERTIFICATION_OF_ORIGIN, NET_RATE_SHEET, OTHER, PRO_FORMA_INVOICE, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN | Example: PRO_FORMA_INVOICE | This is the uploaded document type.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail -- Type: object | These are specific information about the pending email label.<br>Required when PendingShipmentType is EMAIL.<br>Not applicable for CreateTag.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.message -- Type: string | Example: your optional message | This is an optional personalized message to be included in the email to the recipient.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients -- Type: array | This is Email label recipient email address, shipment role, & language locale details. Atleast one entry must be specified.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[] -- Type: object | These are the recipient details for the online email return label.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].emailAddress -- Type: string | Example: neena@fedex.com | This is recipient email address for notifying the return label. Maximum length 200 characters.<br> Example: neena@abc.com
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested -- Type: object | These are to indicate how the email notifications for the pending shipment to be processed.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested.options -- Type: array | Example: ['PRODUCE_PAPERLESS_SHIPPING_FORMAT', 'SUPPRESS_ACCESS_EMAILS'] | These are the processing options.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].optionsRequested.options[] -- Type: string | Valid values: PRODUCE_PAPERLESS_SHIPPING_FORMAT, SUPPRESS_ADDITIONAL_LANGUAGES, SUPPRESS_ACCESS_EMAILS
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.emailLabelDetail.recipients[].role -- Type: string | Valid values: SHIPMENT_COMPLETOR, SHIPMENT_INITIATOR | This is to specify Recipient role in the shipment.Shipment completor role is needed when we pass shipment initiator. We cannot use shipment initiator alone.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.expirationTimeStamp -- Type: string | Example: 2020-01-01 | 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.<b...
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.pendingShipmentType -- Type: string | Valid values: EMAIL | Example: EMAIL | This is Pending Shipment Type. Must include the value 'EMAIL' for email return shipments.<br>Not applicable for other types of shipments.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions -- Type: object | Use this object to allow the Email Label shipment originator,  specify if the Email label shipment completer can make modifications to editable shipment data.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions.options -- Type: array | Example: ['ALLOW_MODIFICATIONS'] | These are processing options.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.processingOptions.options[] -- Type: string | Valid values: ALLOW_MODIFICATIONS
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification -- Type: object | These are documents that are recommended to be included with the shipment.
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification.types -- Type: array | Example: ANTIQUE_STATEMENT_EUROPEAN_UNION | This is the recommended document Type.<br><a onclick='loadDocReference("shipmentdocumenttype")'>click here to see shipment document type</a>
requestedShipment.shipmentSpecialServices.pendingShipmentDetail.recommendedDocumentSpecification.types[] -- Type: string | Valid values: ANTIQUE_STATEMENT_EUROPEAN_UNION, ANTIQUE_STATEMENT_UNITED_STATES, ASSEMBLER_DECLARATION, BEARING_WORKSHEET, CERTIFICATE_OF_SHIPMENTS_TO_SYRIA, COMMERCIAL_INVOICE_FOR_THE_CARIBBEAN_COMMON_MARKET, CONIFEROUS_SOLID_WOOD_PACKAGING_MATERIAL_TO_THE_PEOPLES_REPUBLIC_OF_CHINA, DECLARATION_FOR_FREE_ENTRY_OF_RETURNED_AMERICAN_PRODUCTS, DECLARATION_OF_BIOLOGICAL_STANDARDS, DECLARATION_OF_IMPORTED_ELECTRONIC_PRODUCTS_SUBJECT_TO_RADIATION_CONTROL_STANDARD, ELECTRONIC_INTEGRATED_CIRCUIT_WORKSHEET, FILM_AND_VIDEO_CERTIFICATE, INTERIM_FOOTWEAR_INVOICE, USMCA_CERTIFICATION_OF_ORIGIN_CANADA_ENGLISH, USMCA_CERTIFICATION_OF_ORIGIN_CANADA_FRENCH, USMCA_CERTIFICATION_OF_ORIGIN_SPANISH, USMCA_CERTIFICATION_OF_ORIGIN_UNITED_STATES, PACKING_LIST, PRINTED_CIRCUIT_BOARD_WORKSHEET, REPAIRED_WATCH_BREAKOUT_WORKSHEET, STATEMENT_REGARDING_THE_IMPORT_OF_RADIO_FREQUENCY_DEVICES, TOXIC_SUBSTANCES_CONTROL_ACT, UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERSHIP_ACT_CERTIFICATE_OF_ORIGIN_TEXTILES, UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERSHIP_ACT_CERTIFICATE_OF_ORIGIN_NON_TEXTILES, UNITED_STATES_NEW_WATCH_WORKSHEET, UNITED_STATES_WATCH_REPAIR_DECLARATION
requestedShipment.shipmentSpecialServices.returnShipmentDetail -- Type: object | Use this object for specifying return shipment details.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail -- Type: object | Specifies the details of an outbound shipment in order to associate the return shipment to it.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail.shipDatestamp -- Type: string | Example: 2019-10-01 | This is the ship date for the outbound shipment associated with a return shipment. The format is YYYY-MM-DD.<br> Example: 2019-10-01
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnAssociationDetail.trackingNumber -- Type: string | Example: 123456789 | This is the tracking number associated with this package.<br>Example: 49XXX0000XXX20032835
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail -- Type: object | These are email details for the return shipment.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail.allowedSpecialService -- Type: array | Indicate the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created.<br>Only services represented in EmailLabelAllowedSpecialServiceType will b...
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail.allowedSpecialService[] -- Type: string | Valid values: SATURDAY_DELIVERY, SATURDAY_PICKUP | Example: SATURDAY_DELIVERY
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnEmailDetail.merchantPhoneNumber -- Type: string | Example: 19012635656 | This is the merchant phone number and required for Email Return Labels.<br>Example: 19012635656
requestedShipment.shipmentSpecialServices.returnShipmentDetail.returnType -- Type: string | Valid values: PENDING, PRINT_RETURN_LABEL | Example: PRINT_RETURN_LABEL | 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 mu...
requestedShipment.shipmentSpecialServices.returnShipmentDetail.rma -- Type: object | This is a Return Merchant Authorization (RMA) for the return shipment.<br> Reason for the requirement is mandatory.
requestedShipment.shipmentSpecialServices.returnShipmentDetail.rma.reason -- Type: string | Example: Wrong Size or Color | Specify the reason for the return.<br> Note: There is no validation for reason. Recommended length is 60 alpha-numeric characters<br>Example: Wrong color or size.
requestedShipment.shipmentSpecialServices.shipmentCODDetail -- Type: object | This is the shipment level COD detail.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail -- Type: object | Use this object to specify C.O.D. transportation charges.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.chargeLevelType -- Type: string | Valid values: CURRENT_PACKAGE, SUM_OF_PACKAGES | Specify which level the charges to be applied.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.chargeType -- Type: string | Valid values: COD_SURCHARGE, NET_CHARGE, NET_FREIGHT, TOTAL_CUSTOMER_CHARGE | Specify Charge type.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Specify which level the rate to be applied.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.addTransportationChargesDetail.rateType -- Type: string | Valid values: ACCOUNT, CURRENT, CUSTOM | Specify the Rate Type used.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount -- Type: object | Indicate the COD collection amount. Specifies taxes or miscellaneous charge.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codCollectionType -- Type: string | Valid values: ANY, CASH, GUARANTEED_FUNDS, COMPANY_CHECK, PERSONAL_CHECK | Identifies the type of funds FedEx should collect upon shipment delivery
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | Descriptive data of the Cash On Delivery along with their details of the physical location.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins -- Type: array | This is the tax identification number details.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.codRecipient.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}} | Specifies the contact and address details of a location.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name.<br>Note: This is conditional and not required in all the requests.<br>Note: It is recommended for Express shipments for the most accurate ODA and OPA surcharges...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.postalCode -- Type: string | Example: 38127 | Indicate the Postal code. This is Optional for non postal-aware countries. Maximum length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Postal...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.streetLines -- Type: array | Example: ['Bldg. 10', '10 FedEx Parkway'] | This is the combination of number, street name, etc. <br>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...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details of the shipper.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation for the company name.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.faxNumber -- Type: string | Example: 956123 | Specify contact fax number.<br>Note: Recommended length is 15. There's no specific validation for the fax number.<br> Example: 1234567890
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact person name.<br>Recommended length is 70. <br>Note: There's no specific validation for the person name.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. <br>Note: Recommended length is 6. There's no specific validation for the phone extension. <br> Example: 1234
requestedShipment.shipmentSpecialServices.shipmentCODDetail.financialInstitutionContactAndAddress.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | Contact person's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digi...
requestedShipment.shipmentSpecialServices.shipmentCODDetail.remitToName -- Type: string | Example: remitToName | Specify the name of the person or company receiving the secured/unsecured funds payment.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.returnReferenceIndicatorType -- Type: string | Valid values: INVOICE, PO, REFERENCE, TRACKING | Indicate return reference type information to include on the COD return shipping label.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount -- Type: object | Indicate the COD amount for this shipment. Specifies taxes or miscellaneous charge.
requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.shipmentSpecialServices.shipmentCODDetail.shipmentCodAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail -- Type: object | This is the descriptive data required for a FedEx shipment containing dangerous materials. This element is required when SpecialServiceType DRY_ICE is selected.<p><i>Note:<ul><li>Dry Ice is a Packa...
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.packageCount -- Type: integer | Format: int32 | Example: 12 | Indicates the total number of packages in the shipment that contain dry ice.<br>Example: 12
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight -- Type: object | Example: {'units': 'LB', 'value': 10} | These are the package weight details.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.units -- Type: string | Valid values: KG, LB | Example: LB | This is the package weight unit. For Dry Ice the unit of measure is KG.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>.
requestedShipment.shipmentSpecialServices.specialServiceTypes -- Type: array | Example: ['THIRD_PARTY_CONSIGNEE', 'PROTECTION_FROM_FREEZING'] | Special services requested for the shipment.<br>Example: <ul><li>HOLD_AT_LOCATION</li><li>RETURN_SHIPMENT</li><li>BROKER_SELECT_OPTION</li><li>CALL_BEFORE_DELIVERY</li><li>COD</li><li>CUSTOM_DELIVE...
requestedShipment.shipmentSpecialServices.specialServiceTypes[] -- Type: string
requestedShipment.shipper -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': 'XXXX567890', 'companyName': 'Fedex'}, 'tins': [{'number': 'XXX567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]} | Indicate the Shipper contact details for this shipment.
requestedShipment.shipper.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipper.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shipper.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shipper.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shipper.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shipper.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shipper.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shipper.address.streetLines[] -- Type: string
requestedShipment.shipper.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shipper.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.shipper.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipper.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.shipper.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipper.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shipper.tins -- Type: array | This is the tax identification number details.
requestedShipment.shipper.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shipper.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipper.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shipper.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shipper.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shipper.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shippingChargesPayment -- Type: object | Example: {'paymentType': 'SENDER', 'payor': {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': 'XXXX567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}}}} | Specifies the payment details specifying the method and means of payment to FedEx for providing shipping services.
requestedShipment.shippingChargesPayment.paymentType -- Type: string | Valid values: SENDER, RECIPIENT, THIRD_PARTY, COLLECT | Specifies the payment Type. <br>Note: This is required for Express, Ground and SmartPost shipments.<br> The payment type COLLECT is applicable only for Ground shipments.
requestedShipment.shippingChargesPayment.payor -- Type: object | Example: {'responsibleParty': {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': 'XXXX567890', 'phoneExtension': 'phone extension', 'companyName': 'Fedex', 'faxNumber': 'fax number'}, 'accountNumber': {'value': 'Your account number'}}} | Payor is mandatory when the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.shippingChargesPayment.payor.responsibleParty -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'FedEx'}, 'accountNumber': {'value': 'Your account number'}} | Indicate the payer Information responsible for paying for the shipment. <br>Note: ResponsibleParty accountNumber is required for ACCOUNT based services.
requestedShipment.shippingChargesPayment.payor.responsibleParty.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.shippingChargesPayment.payor.responsibleParty.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.shippingChargesPayment.payor.responsibleParty.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.streetLines[] -- Type: string
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shippingChargesPayment.payor.responsibleParty.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.shippingDocumentSpecification -- Type: object | Use this object to provide all data required for additional (non-label) shipping documents to be produced.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin -- Type: object | The instructions indicating how to print the Certificate of Origin ( e.g. whether or not to include the instructions, image type, etc ...)
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.certificateOfOrigin.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail -- Type: object | The instructions indicating how to print the Commercial Invoice( e.g. image type) Specifies characteristics of a shipping document to be produced.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.commercialInvoiceDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail -- Type: object | Use this object to specify details to generate general agency agreement detail.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.generalAgencyAgreementDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.op900Detail -- Type: object | Use this object to specify details to generate the OP-900 document for hazardous material packages.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages -- Type: array | Specify the use and identification of supplied images to be used on document.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.op900Detail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.op900Detail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.op900Detail.signatureName -- Type: string | Example: Signature Name | Indicates the name to be printed as signature on the document instead of (or in addition to) a signature image.<br>Example: John Hill
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail -- Type: object | These are return instruction details which will be returned in the transaction to be printed on Return Label.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.customText -- Type: string | Example: This is additional text printed on Return instr | Specify additional information (text) to be inserted into the return document.<br>Example: This is additional text printed on Return Label
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat -- Type: object | These are characteristics of a shipping document to be produced.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions -- Type: array | Details on creating, organizing, and returning the document.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.docType -- Type: string | Valid values: PNG, PDF | Example: PNG | Specify the image format used for shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.locale -- Type: string | Example: en_US" | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Use this element to indicate whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.returnInstructionsDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Specify the label stock type.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.shippingDocumentTypes -- Type: array | Example: ['RETURN_INSTRUCTIONS', 'DANGEROUS_GOODS_SHIPPERS_DECLARATION'] | Indicates the types of shipping documents requested.
requestedShipment.shippingDocumentSpecification.shippingDocumentTypes[] -- Type: string | Valid values: CERTIFICATE_OF_ORIGIN, COMMERCIAL_INVOICE, CUSTOM_PACKAGE_DOCUMENT, CUSTOM_SHIPMENT_DOCUMENT, CUSTOMER_SPECIFIED_LABELS, EXPORT_DECLARATION, DANGEROUS_GOODS_SHIPPERS_DECLARATION, GENERAL_AGENCY_AGREEMENT, LABEL, USMCA_CERTIFICATION_OF_ORIGIN, OP_900, PENDING_SHIPMENT_EMAIL_NOTIFICATION, PRO_FORMA_INVOICE, RETURN_INSTRUCTIONS, USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail -- Type: object | The instructions indicating how to print the USMCA Certificate of Origin (e.g. whether or not to include the instructions, image type, etc ...).
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod -- Type: object | Date Range for custom delivery request; only used if type is BETWEEN.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod.begins -- Type: string | Example: 22-01-2020 | Indicates the start date.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.blanketPeriod.ends -- Type: string | Example: 2-01-2020 | Indicates the end date.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.certifierJobTitle -- Type: string | Example: Manager | Specify the job title of the certifier
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.certifierSpecification -- Type: string | Valid values: EXPORTER, IMPORTER, PRODUCER | Example: EXPORTER | This is certifier specification.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.importerSpecification -- Type: string | Valid values: UNKNOWN, VARIOUS | Example: UNKNOWN | This is importer specification.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br>Example: Beverly Hills
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.geographicCoordinates -- Type: string | Example: geographicCoordinates | Indicates the geographic coordinates. <br> example: geographicCoordinates
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.postalCode -- Type: string | Example: 90210 | This is the Postal code.<br>This is Optional for non postal-aware countries.<br>Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Po...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.address.streetLines[] -- Type: string
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation of the company name.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.faxNumber -- Type: string | Specify contact person's fax number. Maximum length is 15.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br> Example: John Taylor
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. <br>Minimum length is 10 and supports Maximum as 15 for certain countries using longer phone numbers. <br>Note: Recommended Maximum length is 15 and there's no specifi...
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins -- Type: array | This is the tax identification number details.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producer.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shippingDocumentSpecification.usmcaCertificationOfOriginDetail.producerSpecification -- Type: string | Valid values: AVAILABLE_UPON_REQUEST, VARIOUS, SAME_AS_EXPORTER | Example: SAME_AS_EXPORTER | This is producer specification.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail -- Type: object | The instructions indicating commercial invoice certification of origin.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.certifierJobTitle -- Type: string | Example: Manager | Specify the job title of the certifier
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.certifierSpecification -- Type: string | Valid values: EXPORTER, IMPORTER, PRODUCER | Example: EXPORTER | This is certifier specification.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages -- Type: array | Specifies the usage and identification of customer supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[] -- Type: object | Specify the usse and identification of supplied images to be used on this document.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[].id -- Type: string | Valid values: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5 | Example: IMAGE_5 | Specify the Image ID.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[].providedImageType -- Type: string | Valid values: LETTER_HEAD, SIGNATURE | Example: SIGNATURE | Specify the provided document image type.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.customerImageUsages[].type -- Type: string | Valid values: SIGNATURE, LETTER_HEAD | Example: SIGNATURE | Specify document image type.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat -- Type: object | Specify the shipping document format.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions -- Type: array | Specifies how to create, organize, and return the document
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[] -- Type: object | These are document diposition details. Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].dispositionType -- Type: string | Valid values: CONFIRMED, DEFERRED_QUEUED, DEFERRED_RETURNED, DEFERRED_STORED, EMAILED, QUEUED, RETURNED, STORED | Example: CONFIRMED | Specify how to create and return the document.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail -- Type: object | Specifies how to e-mail shipping documents.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients -- Type: array | Indicates the shipping document email recipients.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[] -- Type: object
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].emailAddress -- Type: string | Example: email@fedex.com | Specifies the email address.<br> Example: email@fedex.com
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.eMailRecipients[].recipientType -- Type: string | Valid values: BROKER, OTHER, RECIPIENT, SHIPPER, THIRD_PARTY, OTHER1, OTHER2 | Example: THIRD_PARTY | Specify the email notification recipient type.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.grouping -- Type: string | Valid values: BY_RECIPIENT, NONE | Example: NONE | Identifies the convention by which documents are to be grouped as email attachment.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.dispositions[].eMailDetail.locale -- Type: string | Example: en_US | These are locale details.<br>Example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.docType -- Type: string | Valid values: PDF | Example: PDF | Specify the image format used for a shipping document.<br><a onclick='loadDocReference("labelstocktypes")'>click here to see label format types</a>
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.locale -- Type: string | Example: en_US | These are locale details.<br>example: 'en_US'<br><a onclick='loadDocReference("locales")'>click here to see Locales</a><br>Note: If the locale is left blank or an invalid locale is entered, an erro...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.optionsRequested -- Type: object | Indicate the requested options for document format.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.optionsRequested.options -- Type: array | Example: ['SUPPRESS_ADDITIONAL_LANGUAGES', 'SHIPPING_LABEL_LAST'] | 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.optionsRequested.options[] -- Type: string | Valid values: SHIPPING_LABEL_FIRST, SHIPPING_LABEL_LAST, SUPPRESS_ADDITIONAL_LANGUAGES
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.provideInstructions -- Type: boolean | Example: True | Indicates whether or not to provide the instructions.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.documentFormat.stockType -- Type: string | Valid values: PAPER_LETTER | Example: PAPER_LETTER | Indicate the used label stock type. Note to list the correct type of paper for the freight address label option.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.importerSpecification -- Type: string | Valid values: UNKNOWN, VARIOUS | Example: UNKNOWN | This is importer specification.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '000', 'phoneNumber': 'XXXX345671', 'companyName': 'Fedex'}, 'accountNumber': {'value': 'Your account number'}, 'tins': [{'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}]}
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br>Example: Beverly Hills
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.geographicCoordinates -- Type: string | Example: geographicCoordinates | Indicates the geographic coordinates. <br> example: geographicCoordinates
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.postalCode -- Type: string | Example: 90210 | This is the Postal code.<br>This is Optional for non postal-aware countries.<br>Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see Po...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.address.streetLines[] -- Type: string
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.companyName -- Type: string | Example: Fedex | Specify contact company name.<br>Recommended length is 35.<br>Note: There's no specific validation of the company name.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.faxNumber -- Type: string | Specify contact person's fax number. Maximum length is 15.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br> Example: John Taylor
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. <br>Minimum length is 10 and supports Maximum as 15 for certain countries using longer phone numbers. <br>Note: Recommended Maximum length is 15 and there's no specifi...
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins -- Type: array | This is the tax identification number details.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producer.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.shippingDocumentSpecification.usmcaCommercialInvoiceCertificationOfOriginDetail.producerSpecification -- Type: string | Valid values: AVAILABLE_UPON_REQUEST, VARIOUS, SAME_AS_EXPORTER | Example: SAME_AS_EXPORTER | This is producer specification.
requestedShipment.smartPostInfoDetail -- Type: object | Use this object to specify the smartpost shipment details. <br>Required for SMARTPOST service. If SmartPostInfoDetail is indicated, the elements below it are also required.
requestedShipment.smartPostInfoDetail.ancillaryEndorsement -- Type: string | Valid values: ADDRESS_CORRECTION, CARRIER_LEAVE_IF_NO_RESPONSE, CHANGE_SERVICE, FORWARDING_SERVICE, RETURN_SERVICE | Example: RETURN_SERVICE | Indicate the type of ancillary endorsement. Is required for Presorted Standard but not for returns or parcel select. <br>Note: Not all are usable for all ancillary endorsements.<br>For more informa...
requestedShipment.smartPostInfoDetail.hubId -- Type: string | Example: 5015 | Specify the four-digit numeric Hub ID value used for smartport shipments.<br><a onclick='loadDocReference("smartposthubids")'>click here to see Hub Ids</a>
requestedShipment.smartPostInfoDetail.indicia -- Type: string | Valid values: MEDIA_MAIL, PARCEL_RETURN, PARCEL_SELECT, PRESORTED_BOUND_PRINTED_MATTER, PRESORTED_STANDARD | Example: PRESORTED_STANDARD | Specify the indicia type.<br>Available options include:<ul><li>MEDIA_MAIL</li><li>PARCEL_SELECT (1 LB through 70 LB)</li><li>PRESORTED_BOUND_PRINTED_MATTER</li><li>PRESORTED_STANDARD (less than 1 L...
requestedShipment.smartPostInfoDetail.specialServices -- Type: string | Valid values: USPS_DELIVERY_CONFIRMATION | Example: USPS_DELIVERY_CONFIRMATION | Specify the special handling associated with Smartpost Shipment.
requestedShipment.soldTo -- Type: object | 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 par...
requestedShipment.soldTo.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is FedEx Account number details.
requestedShipment.soldTo.accountNumber.value -- Type: string | The account number value.Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT.
requestedShipment.soldTo.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.soldTo.address.city -- Type: string | Length: max: 35 | Example: Beverly Hills | The name of city, town of the recipient.Max length is 35.<br>Example: Beverly Hills
requestedShipment.soldTo.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>click here to see Country codes</a>
requestedShipment.soldTo.address.postalCode -- Type: string | Example: 90210 | This is the postal code.<br>Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>click here to see...
requestedShipment.soldTo.address.residential -- Type: boolean | Indicate whether this address is residential (as opposed to commercial).
requestedShipment.soldTo.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for state or province code.<br>Example: CA.<br><a onclick='loadDocReference("canadaprovincecodes")'>click here to see State or Province Code</a>
requestedShipment.soldTo.address.streetLines -- Type: array | Example: ['1550 Union Blvd', 'Suite 302'] | This is the combination of number, street name, etc. Maximum length per line is 35.<br>Example: 10 FedEx Parkway, Suite 302.<p><i>Note:<ul><li>At least one line is required.</li><li>Streetlines mor...
requestedShipment.soldTo.address.streetLines[] -- Type: string
requestedShipment.soldTo.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneExtension': '91', 'phoneNumber': '1234567890', 'companyName': 'Fedex'} | Indicate the contact details for this shipment.
requestedShipment.soldTo.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35. <br>Note: Either the companyName or personName is mandatory.
requestedShipment.soldTo.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.soldTo.contact.personName -- Type: string | Example: John Taylor | Specify contact name. Maximum length is 70. <br>Note: Either the companyName or personName is mandatory.<br> Example: John Taylor
requestedShipment.soldTo.contact.phoneExtension -- Type: string | Example: 91 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.soldTo.contact.phoneNumber -- Type: string | Example: 918xxxxx890 | The shipper's phone number. <br>Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.<br>Note: For US and CA, a phone number must have exactly 10 digits,...
requestedShipment.soldTo.tins -- Type: array | Used for adding the tax id
requestedShipment.soldTo.tins[] -- Type: object | Example: {'number': '123567', 'tinType': 'FEDERAL', 'usage': 'usage', 'effectiveDate': '2000-01-23T04:56:07.000+00:00', 'expirationDate': '2000-01-23T04:56:07.000+00:00'}
requestedShipment.soldTo.tins[].effectiveDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID effective date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.soldTo.tins[].expirationDate -- Type: string | Example: 2000-01-23T04:56:07.000+00:00 | Specify the tax ID expiration date.<br>Example: 2000-01-23T04:56:07.000+00:00
requestedShipment.soldTo.tins[].number -- Type: string | Example: 123567 | Specify tax ID number. Maximum length is 18. <br>Example: 123567
requestedShipment.soldTo.tins[].tinType -- Type: string | Valid values: PERSONAL_NATIONAL, PERSONAL_STATE, FEDERAL, BUSINESS_NATIONAL, BUSINESS_STATE, BUSINESS_UNION | Example: FEDERAL | Indicate the type of tax identification number.
requestedShipment.soldTo.tins[].usage -- Type: string | Example: usage | Specify the reason for using the tax identification number in shipment processing.
requestedShipment.totalDeclaredValue -- Type: object | 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...
requestedShipment.totalDeclaredValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45
requestedShipment.totalDeclaredValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a>
requestedShipment.totalPackageCount -- Type: integer | Format: int32 | Example: 25 | For an MPS, this is the total number of packages in the shipment.Applicable for parent shipment for one label at a time shipments. <br>Example: 25
requestedShipment.totalWeight -- Type: number | Format: double | Example: 20.6 | Indicate the shipment total weight in pounds.<br>Example: 10.6<br>Note: <ul><li>This only applies to International shipments and should be used on the first package of a multiple piece shipment.</l...
requestedShipment.variableHandlingChargeDetail -- Type: object | Indicate the details about how to calculate variable handling charges at the shipment level. They can be based on a percentage of the shipping charges or a fixed amount. If indicated, element rateL...
requestedShipment.variableHandlingChargeDetail.fixedValue -- Type: object | Example: {'amount': 24.45, 'currency': 'USD'} | 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. <br>Example: 5.00. Specifies taxes or...
requestedShipment.variableHandlingChargeDetail.fixedValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Maximum limit is 5 digits before decimal.<br>Example: 12.45 fixed variable handling charge amount
requestedShipment.variableHandlingChargeDetail.fixedValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency codes</a> fixed variable handling charge currency type<br><a o...
requestedShipment.variableHandlingChargeDetail.percentValue -- Type: number | Format: double | Example: 12.45 | This is the variable handling percentage. If the percent value is mentioned as 10, it means 10%(multiplier of 0.1).<br>Example: 12.45
requestedShipment.variableHandlingChargeDetail.rateElementBasis -- Type: string | Valid values: NET_CHARGE, NET_FREIGHT, BASE_CHARGE, NET_CHARGE_EXCLUDING_TAXES | Example: NET_CHARGE_EXCLUDING_TAXES | Specify the charge type upon which the variable handling percentage amount is calculated.
requestedShipment.variableHandlingChargeDetail.rateLevelType -- Type: string | Valid values: BUNDLED_RATE, INDIVIDUAL_PACKAGE_RATE | Example: INDIVIDUAL_PACKAGE_RATE | Specifies if the rate level type is either Individual or Bundled.
requestedShipment.variableHandlingChargeDetail.rateType -- Type: string | Valid values: ACCOUNT, ACTUAL, CURRENT, CUSTOM, LIST, INCENTIVE, PREFERRED, PREFERRED_INCENTIVE, PREFERRED_CURRENCY | Example: PREFERRED_CURRENCY | This is the rate type used for this package.

Cancel Tag

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
[path] shipmentid -- Type: string
accountNumber -- Type: object | Example: {'value': '123456789'} | The specific FedEx customer account number (account value and account key) associated with the shipment. The account number of the recipient.
accountNumber.value -- Type: string | Conditional.<br> The account number value. Max Length is 9.<br>Example: 123456789
completedTagDetail -- Type: object | The details of the package for which shipping has been completed. The details include dispatch confirmation number, dispatch date, location, and the cxs alerts associated with the process.
completedTagDetail.confirmationNumber -- Type: string | Example: 275 | Confirmation Number.<br>Example: 275
completedTagDetail.dispatchDate -- Type: string | Example: 2019-08-03 | The dispatch date for the FedEx Tag to be cancelled.<br>Example: 2019-08-03
completedTagDetail.location -- Type: string | Example: NQAA | Applicable for FedEx Express services.<br>Example: NQAA
serviceType -- Type: string | Example: PRIORITY_OVERNIGHT | This is the FedEx service type associated with the shipment.<br>Example: PRIORITY_OVERNIGHT<br><a onclick='loadDocReference("servicetypes")'>Click here to see Service Types</a>
trackingNumber -- Type: string | Example: 301025281523 | The tracking number for the Express or Ground Tag to the cancelled.<br>Example: 301025281523<br><a onclick='loadDocReference("mocktrackingnumbersforfedexexpressandfedexground")'>Click here to see m...

Tracking

Track Multiple Piece Shipment

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
associatedType -- Type: string | Valid values: OUTBOUND_LINK_TO_RETURN, STANDARD_MPS, GROUP_MPS | Example: STANDARD_MPS | The associated shipment type, such as MPS, Group MPS, or an outbound shipment which is linked to a return shipment. Example: STANDARD_MPS
includeDetailedScans -- Type: boolean | Example: True | Indicates if detailed scans are requested or not. <br>Valid values are True, or False.
masterTrackingNumberInfo -- Type: object | The detailed master tracking details for the shipment to be tracked. Tracking details for the shipment to be tracked
masterTrackingNumberInfo.shipDateBegin -- Type: string | Example: 2020-03-29 | ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number within a specific date range. <br>Format: ...
masterTrackingNumberInfo.shipDateEnd -- Type: string | Example: 2020-04-01 | ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number within a specific date range. <br>Format: ...
masterTrackingNumberInfo.trackingNumberInfo -- Type: object | Information uniquely identifying a shipment such as Tracking number, ShipDate, and Tracking number uniqueId.
masterTrackingNumberInfo.trackingNumberInfo.carrierCode -- Type: string | Valid values: FDXE, FDXG, FXSP, FXFR, FDXC, FXCC, FEDEX_CARGO, FEDEX_CUSTOM_CRITICAL, FEDEX_EXPRESS, FEDEX_FREIGHT, FEDEX_GROUND, FEDEX_OFFICE, FEDEX_KINKOS, FX, FDFR, FDEG, FXK, FDC, FDCC | Example: FDXE | This is a placeholder to provide the FedEx operating company (transportation) code used for package delivery. <br> Example: FDXE
masterTrackingNumberInfo.trackingNumberInfo.trackingNumber -- Type: string | Example: 128667043726 | This is a Tracking number for FedEx packages used for tracking a single package or group of packages. <br> Example: 128667043726<br><a onclick='loadDocReference("mocktrackingnumbersforfedexexpressa...
masterTrackingNumberInfo.trackingNumberInfo.trackingNumberUniqueId -- Type: string | Example: 245822~123456789012~FDEG | Unique identifier used to distinguish duplicate FedEx tracking numbers. This value will be set by FedEx systems. <br> Example: 245822\~123456789012\~FDEG
pagingDetails -- Type: object | The details about how to retrieve the subsequent pages when there is more than one page in the TrackReply. Specify the details about how to retrieve the subsequent pages when there is more than one...
pagingDetails.pagingToken -- Type: string | Example: 38903279038 | <p>Use this element to specify the starting sequence for the next set of tracking results. This element can be specified if paging is used in the initial tracking request and you need to request ne...
pagingDetails.resultsPerPage -- Type: integer | Format: int32 | Example: 56 | <p>Use this element to specify the number of Tracking results to be returned in the Tracking response. Use this and pagingToken elements, to retrieve remaining set of the track results.</p><p><u>He...

Send Notification

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
senderContactName -- Type: string | Example: Sam Smith | Placeholder for Sender contact name.<br> Example: Sam Smith
senderEMailAddress -- Type: string | Example: Lsr1234@gmail.com | Email address of the sender from which the shipment notification will be sent.<br>Example: LSR123@gmail.com
shipDateBegin -- Type: string | Example: 2019-10-13 | ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number in a specific time range. <br>Format: YYYY...
shipDateEnd -- Type: string | Example: 2019-10-31 | ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number in a specific time range. <br>Format: YYYY...
trackingEventNotificationDetail -- Type: object | Object for holding tracking event Notification details. Tracking Event Notification details.
trackingEventNotificationDetail.personalMessage -- Type: string | Example: Personal message content | An optional message which will be included in the body of the email.
trackingEventNotificationDetail.supportHTML -- Type: object | If value is 'true' then html tags are included in the response date.  If 'false' they are not provided in the response.
trackingEventNotificationDetail.trackingNotifications -- Type: array | List of Tracking notifications requested for events like ON_DELIVERY, ON_ESTIMATED_DELIVERY, ON_EXCEPTION, ON_TENDER.
trackingEventNotificationDetail.trackingNotifications[] -- Type: object | Identifies a list of details for Tracking Notifications
trackingEventNotificationDetail.trackingNotifications[].currentResultRequestedFlag -- Type: boolean | Example: True | If value is 'true' the current tracking results for the shipment along with notification details will be provided to the client. If 'false' only results for the notification request is provided.<br...
trackingEventNotificationDetail.trackingNotifications[].notificationDetail -- Type: object | Information about the notification email and the language of the notification requested.
trackingEventNotificationDetail.trackingNotifications[].notificationDetail.emailDetail -- Type: object | Specifies the Email Notification Details.
trackingEventNotificationDetail.trackingNotifications[].notificationDetail.emailDetail.emailAddress -- Type: string | Example: p1@fedex.com | Specifies email address on which user wants to get notified for various registered events.<br>Example: p1@fedex.com
trackingEventNotificationDetail.trackingNotifications[].notificationDetail.emailDetail.name -- Type: string | Example: Preethi | Specifies the name of the notification recipient.<br>Example: Sam Smith
trackingEventNotificationDetail.trackingNotifications[].notificationDetail.localization -- Type: object | Specifies the language details for email notification.
trackingEventNotificationDetail.trackingNotifications[].notificationDetail.localization.languageCode -- Type: string | Example: en | Identifies two-letter code for the language (e.g. en/EN, fr/FR, es/ES etc..).<br> Example: en
trackingEventNotificationDetail.trackingNotifications[].notificationDetail.localization.localeCode -- Type: string | Example: US | Identifies the two-letter code for the region, used to further identify the requested language.  for example, if you request Spanish, you must include a locale code of <i>US</i> for North American ...
trackingEventNotificationDetail.trackingNotifications[].notificationDetail.notificationType -- Type: string | Example: HTML | Identifies the format of the notification. <br>valid values are 'HTML' or 'TEXT'.
trackingEventNotificationDetail.trackingNotifications[].notificationEventTypes -- Type: array | Example: ['ON_DELIVERY', 'ON_EXCEPTION', 'ON_ESTIMATED_DELIVERY'] | Identifies the events for which the client is requesting notifications. <br>Possible Values are: ON_DELIVERY, ON_ESTIMATED_DELIVERY, ON_EXCEPTION, ON_TENDER
trackingEventNotificationDetail.trackingNotifications[].notificationEventTypes[] -- Type: string
trackingEventNotificationDetail.trackingNotifications[].role -- Type: string | Example: SHIPPER | This is to specify Recipient_Role in the shipment. <br>Possible values - BROKER, OTHER, RECIPIENT, SHIPPER <br> Example: SHIPPER
trackingNumberInfo -- Type: object | Information uniquely identifying a shipment such as Tracking number, ShipDate, and Tracking number uniqueId.
trackingNumberInfo.carrierCode -- Type: string | Valid values: FDXE, FDXG, FXSP, FXFR, FDXC, FXCC, FEDEX_CARGO, FEDEX_CUSTOM_CRITICAL, FEDEX_EXPRESS, FEDEX_FREIGHT, FEDEX_GROUND, FEDEX_OFFICE, FEDEX_KINKOS, FX, FDFR, FDEG, FXK, FDC, FDCC | Example: FDXE | This is a placeholder to provide the FedEx operating company (transportation) code used for package delivery. <br> Example: FDXE
trackingNumberInfo.trackingNumber -- Type: string | Example: 128667043726 | This is a Tracking number for FedEx packages used for tracking a single package or group of packages. <br> Example: 128667043726<br><a onclick='loadDocReference("mocktrackingnumbersforfedexexpressa...
trackingNumberInfo.trackingNumberUniqueId -- Type: string | Example: 245822~123456789012~FDEG | Unique identifier used to distinguish duplicate FedEx tracking numbers. This value will be set by FedEx systems. <br> Example: 245822\~123456789012\~FDEG

Track by References

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
includeDetailedScans -- Type: boolean | Example: True | Indicates if the detailed scans are being requested or not. If true, the detailed scans will be included in the response returned. <br>Valid values are True or False.
referencesInformation -- Type: object | Specifies the reference details for the tracked shipment. The following rules apply <br>- Either shipper.AccountNumber or Destination.countryCode(and postal for postal aware countries) are required...
referencesInformation.accountNumber -- Type: string | Example: XXX61073 | Conditionally required. <br>Specifies the shipper's account number. <br> Note: Either account number or destination postal code and country code are mandatory to track by reference.<br> Example: 69...
referencesInformation.carrierCode -- Type: string | Example: FDXE | Specifies which carrier should be included.<br> Example: FDXE
referencesInformation.destinationCountryCode -- Type: string | Example: US | Conditionally required. <br>Specifies the recipient's country code. <br> Note: Either account number or destination postal code and country code are mandatory to track by reference.<br> Example: US...
referencesInformation.destinationPostalCode -- Type: string | Example: 75063 | Conditionally required. <br>Indicate recipient postal code. Required for postal-aware countries. <br> Note: Either account number or destination postal code and country code are mandatory to track ...
referencesInformation.shipDateBegin -- Type: string | Example: 2020-03-29 | ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number within a specific date range. <br>Format: ...
referencesInformation.shipDateEndDate -- Type: string | Example: 2020-04-01 | ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number within a specific date range. <br>Format: ...
referencesInformation.type -- Type: string | Example:  BILL_OF_LADING | Specify the type of alternate reference used. This is Conditionally required.<br> Valid Values :<ul><li>BILL_OF_LADING</li><li>COD_RETURN_TRACKING_NUMBER</li><li>CUSTOMER_AUTHORIZATION_NUMBER</li><...
referencesInformation.value -- Type: string | Example: 56754674567546754 | Conditionally required. <br>Specifies the alternate reference value. <br> Example: 56754674567546754

Track by Tracking Control Number

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
includeDetailedScans -- Type: boolean | Example: True | Indicates if detailed scans are requested or not. <br/>Valid values are True, or False.
tcnInfo -- Type: object | The information associated with the transportation control number.<br>Only 1 TCN is supported per request.
tcnInfo.carrierCode -- Type: string | Example: FDXE | Field which holds information about carrier code of the shipment.<br> Example: FDXE
tcnInfo.shipDateBegin -- Type: string | Example: 2020-03-29 | ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number within a specific date range. <br>Format: ...
tcnInfo.shipDateEnd -- Type: string | Example: 2020-04-01 | ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number within a specific date range. <br>Format: ...
tcnInfo.value -- Type: string | Example: N552428361Y555XXX | Field which holds the Transportation Control Number value.<br> Example: N552428361Y555XXX

Track Document

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
trackDocumentDetail -- Type: object | This object specifies the tracking document details such as types of documents, for example, SIGNATURE_PROOF_OF_DELIVERY and also the format of tracking document. Supported values are PDF and PNG. ...
trackDocumentDetail.documentFormat -- Type: string | Example: PNG | Specifies the format of tracking document. <br>Valid values are PDF or PNG.<br>The values are key sensitive.<br>Note: documentTypes BILL_OF_LADING and FREIGHT_BILLING_DOCUMENT does not support PNG.
trackDocumentDetail.documentType -- Type: string | Example: SIGNATURE_PROOF_OF_DELIVERY | Indicate the Tracking Document. <br>Valid values are SIGNATURE_PROOF_OF_DELIVERY, BILL_OF_LADING and FREIGHT_BILLING_DOCUMENT.<br>Example: SIGNATURE_PROOF_OF_DELIVERY.
trackDocumentSpecification -- Type: array | This is the placeholder for document specification details required to identify the shipment being tracked. This includes tracking information such as tracking qualifier, carrier code, and tracking...
trackDocumentSpecification[] -- Type: object
trackDocumentSpecification[].accountNumber -- Type: string | Example: XXX61073 | Specifies Signature Proof of Delivery(SPOD) account number for the shipment being tracked.<br>Conditionally required when documentType is BILL_OF_LADING or FREIGHT_BILLING_DOCUMENT<br>Example: 1234...
trackDocumentSpecification[].shipDateBegin -- Type: string | Example: 2020-03-29 | ShipDateBegin and ShipDateEnd are used to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number during a specific date range.<br>Format: YYYY-MM-...
trackDocumentSpecification[].shipDateEnd -- Type: string | Example: 2020-04-01 | ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number during a specific date range.<br>Format: Y...
trackDocumentSpecification[].trackingNumberInfo -- Type: object | Information uniquely identifying the shipment such as Tracking number, Carrier Code, and Tracking number uniqueId. Information uniquely identifying a shipment such as Tracking number, ShipDate, and...
trackDocumentSpecification[].trackingNumberInfo.carrierCode -- Type: string | Valid values: FDXE, FDXG, FXSP, FXFR, FDXC, FXCC, FEDEX_CARGO, FEDEX_CUSTOM_CRITICAL, FEDEX_EXPRESS, FEDEX_FREIGHT, FEDEX_GROUND, FEDEX_OFFICE, FEDEX_KINKOS, FX, FDFR, FDEG, FXK, FDC, FDCC | Example: FDXE | This is a placeholder to provide the FedEx operating company (transportation) code used for package delivery. <br> Example: FDXE
trackDocumentSpecification[].trackingNumberInfo.trackingNumber -- Type: string | Example: 128667043726 | This is a Tracking number for FedEx packages used for tracking a single package or group of packages. <br> Example: 128667043726<br><a onclick='loadDocReference("mocktrackingnumbersforfedexexpressa...
trackDocumentSpecification[].trackingNumberInfo.trackingNumberUniqueId -- Type: string | Example: 245822~123456789012~FDEG | Unique identifier used to distinguish duplicate FedEx tracking numbers. This value will be set by FedEx systems. <br> Example: 245822\~123456789012\~FDEG

Track by Tracking Number

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
includeDetailedScans -- Type: boolean | Indicates if detailed scans are requested or not. <br/>Valid values are True, or False.
trackingInfo -- Type: array | The tracking information of the shipment to be tracked. At least one occurrence of TrackingInfo is required. Maximum limit is 30.
trackingInfo[] -- Type: object | Tracking details for the shipment to be tracked
trackingInfo[].shipDateBegin -- Type: string | Example: 2020-03-29 | ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number within a specific date range. <br>Format: ...
trackingInfo[].shipDateEnd -- Type: string | Example: 2020-04-01 | ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number within a specific date range. <br>Format: ...
trackingInfo[].trackingNumberInfo -- Type: object | Information uniquely identifying a shipment such as Tracking number, ShipDate, and Tracking number uniqueId.
trackingInfo[].trackingNumberInfo.carrierCode -- Type: string | Valid values: FDXE, FDXG, FXSP, FXFR, FDXC, FXCC, FEDEX_CARGO, FEDEX_CUSTOM_CRITICAL, FEDEX_EXPRESS, FEDEX_FREIGHT, FEDEX_GROUND, FEDEX_OFFICE, FEDEX_KINKOS, FX, FDFR, FDEG, FXK, FDC, FDCC | Example: FDXE | This is a placeholder to provide the FedEx operating company (transportation) code used for package delivery. <br> Example: FDXE
trackingInfo[].trackingNumberInfo.trackingNumber -- Type: string | Example: 128667043726 | This is a Tracking number for FedEx packages used for tracking a single package or group of packages. <br> Example: 128667043726<br><a onclick='loadDocReference("mocktrackingnumbersforfedexexpressa...
trackingInfo[].trackingNumberInfo.trackingNumberUniqueId -- Type: string | Example: 245822~123456789012~FDEG | Unique identifier used to distinguish duplicate FedEx tracking numbers. This value will be set by FedEx systems. <br> Example: 245822\~123456789012\~FDEG

---

Address Validate

Validate Address

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
addressesToValidate -- Type: array | Indicate the address to be validated and resolved. This includes the address details, such as streetline, state or province code, country code and postal code. <br><br><i>Note: Up to 100 of these c...
addressesToValidate[] -- Type: object | Specifies the address details of a location.
addressesToValidate[].address -- Type: object | This is the Address in detail to be resolved.
addressesToValidate[].address.addressVerificationId -- Type: string | Specify the Address Verification ID. The recommended length is 20 characters.
addressesToValidate[].address.city -- Type: string | Example: IRVING | Indicate the name of city, town, etc.<br><br>Note: City is mandatory, When postalcode is not provided and includeResolutionTokens value is true in the request.
addressesToValidate[].address.countryCode -- Type: string | Example: US | Specify the ISO Alpha2 code of the country.<br>Example: US <br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
addressesToValidate[].address.postalCode -- Type: object | Example: 75063-8659 | Indicate the Postal Code which is an identification code of a region (usually small) for easier and accurate mail/package delivery. The format and presence of this field may vary depending on the c...
addressesToValidate[].address.stateOrProvinceCode -- Type: object | Example: TX | Indicate the State or Province codes. The Format and presence of this field may vary depending on the country.<br>Example: TX<br><a onclick='loadDocReference("canadaprovincecodes")'> Click here to ...
addressesToValidate[].address.streetLines -- Type: array | Example: ['7372 PARKRIDGE BLVD', 'APT 286', '2903 sprank'] | Indicate the combination of number, street name. etc. <br>Example: ["7372 PARKRIDGE BLVD", "APT 286, 2903 sprank"].<br><br>Note:<ul><li>At least one line is required for a valid physical address; e...
addressesToValidate[].address.streetLines[] -- Type: string
addressesToValidate[].address.urbanizationCode -- Type: string | Example: EXT VISTA BELLA | Indicate urbanization Code. This is optional and only relevant and needed for addresses in Puerto Rico, where multiple addresses within the same postal code can have the same house number and stree...
inEffectAsOfTimestamp -- Type: string | Example: 2019-09-06 | This can be used to request the characteristics of an address had at a particular time in history. This defaults to current date time (of the Address Validation System). This is useful because the ...
validateAddressControlParameters -- Type: object | Specify the parameters applied to validate the address.
validateAddressControlParameters.includeResolutionTokens -- Type: boolean | Example: True | Use this to request detailed information of the address components once the validation is complete. The details specify the changes made to each address component to resolve the address.

Validate Postal

FullSchema-ValidatePostal.carrierCode -- Specify the four letter code of a FedEx operating company that meets your requirements. Examples of FedEx Operating Companies are: FDXE - FedEx Express, FDXG - FedEx Ground, FXSP - FedEx SmartPost, FXCC - FedEx Custom Critical.
FullSchema-ValidatePostal.countryCode -- The two-letter code used to identify a country. Example:US
FullSchema-ValidatePostal.stateOrProvinceCode -- This is the state or province code. Format and presence of this field will vary, depending on country. Example: US
FullSchema-ValidatePostal.postalCode -- Identification code of a region (usally small) for easier and accurate mail/package delivery. The format and presence of this field may vary depending on the country. Example: 75063-8659
FullSchema-ValidatePostal.shipDate -- Specify the date on which the package is to be shipped. The specified date should not be the current date or any date, 10 days after the current date. The date format must be YYYY-MM-DD. Example: 2019-10-04
FullSchema-ValidatePostal.routingCode -- Specify the routing code for the shipment. Routing code is the information that identifies the route the package or shipment may take. Example: Memphis 38017 - HKA/NQA
FullSchema-ValidatePostal.checkForMismatch -- This element checks for mismatch between State/Province Code and Postal Code. When the checkForMismatch is set TRUE, for U.S. and Canada: The values in State/Province Code are checked with respect to Postal Code provided. If these entries are valid, the response provides respective State/Province Code and Postal Code. In case of mismatch of Postal Code and State/Province Code an error message is displayed. When the checkForMismatch is set FALSE, for U.S. and Canada: The values in State/Province Code are not checked with respect to Postal Code provided. Instead the given data is reflected in the response. For regions other than U.S and Canada regardless of the value of checkForMismatch the State/Province Code are checked with respect to the Postal Code and the response provides the respective State/Province Code and Postal Code.
CountryCXSResponseVO.transactionId -- The transaction ID is special set of number that allows FedEx customer to assign a unique identifier to their each transaction. Helps in matching requests to reply. Max 40 characters. Example: 624deea6-b709-470c-8c39-4b5511281492
CountryCXSResponseVO.customerTransactionId -- This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. Example: AnyCo_order123456789
ValidatePostalOutputVO.countryCode -- The two-letter code used to identify a country. Example:US
ValidatePostalOutputVO.cityFirstInitials -- Initials of the City
ValidatePostalOutputVO.stateOrProvinceCode -- This is the state or province code. Format and presence of this element will vary, depending on country. Max length is 2. Example: US
ValidatePostalOutputVO.alerts -- This object specifies Alert details returned in the reply such as code, message and any other parameters.
ValidatePostalOutputVO.locationDescriptions -- This object specifies location details returned in the reply such as location ID, service area and airport ID etc.
ValidatePostalOutputVO.cleanedPostalCode -- This is a cleaned postal code returned in the reply. Example: 94267
Alert.code -- Specifies the API alert code. Example: CITYNAME.POSTALCODE.REQUIRED
Alert.alertType -- Specifies the alert type.
Alert.parameterList -- List of parameters which indicates the properties of the alert message.
Alert.message -- This is the alert message. Example: We are unable to process this request. Please try again later or contact FedEx Customer Service.
Parameter.value -- Identifies the error option to be applied.
Parameter.key -- Indicates the value associated with the key.
LocationDescription.locationId -- Location id of the postal code provided. Example: MAAPD
LocationDescription.locationNumber -- Location number of the postal code provided. Example: 6955
LocationDescription.serviceArea -- Service area of the postal code provided. Example: AA
LocationDescription.airportId -- Airport Id of the postal code provided. Example: BLR

Pickup

Create Pickup

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
accountAddressOfRecord -- Type: object | Example: {'streetLines': ['123 Ship Street'], 'city': 'Memphis', 'stateOrProvinceCode': 'TN', 'postalCode': '38017', 'countryCode': 'US', 'residential': False, 'addressClassification': 'MIXED'} | The city name, state or province code and the address classification associated with the customer account which requested the pickup. Conditionally required. For the Address, street, city and count...
accountAddressOfRecord.addressClassification -- Type: string | Valid values: MIXED, UNKNOWN, BUSINESS, RESIDENTIAL | Example: MIXED | Classifies a given address as either of unknown, residential, mixed or business.
accountAddressOfRecord.city -- Type: string | Example: Memphis | Conditional<br>The name of city, town, etc.<br> Example: Memphis
accountAddressOfRecord.countryCode -- Type: string | Example: US | The two-letter code used to identify a country. Maximum length is 2.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
accountAddressOfRecord.postalCode -- Type: string | Example: 38017 | Specify the postal code. This is optional for non postal-aware countries. Maximum length is 10.<br> Example: 38017<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal ...
accountAddressOfRecord.residential -- Type: boolean | Indicates whether this address is residential (as opposed to commercial).
accountAddressOfRecord.stateOrProvinceCode -- Type: string | Example: TN | This is state or province code. Maximum length is 2.<br> Example: ON <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
accountAddressOfRecord.streetLines -- Type: array | Specify Street line details for the given address <br> Example :[\"10 FedEx Parkway\", \"Suite 302\"]
accountAddressOfRecord.streetLines[] -- Type: string | Example: [["123 Ship Street"]]
associatedAccountNumber -- Type: object | Example: {'value': 'Your account number'} | This is the FedEx account number. <br>Example: Your account number
associatedAccountNumber.value -- Type: string | This is the account number. Maximum Length is 9. <br>Example: Your account number
associatedAccountNumberType -- Type: string | Example: FEDEX_OFFICE | This enumeration represents a kind of legacy account number from a FedEx operating entity for the account number associated to the pickup.<br> Valid values are: FEDEX_EXPRESS<br>FEDEX_GROUND<br>FED...
carrierCode -- Type: string | Valid values: FDXE, FDXG | Specify the four letter code of a FedEx operating company thate meets your requirements.<br> Examples of FedEx Operating Comapnies are :  <ul><li>FDXE- FedEx Express</li><li>FDXG- FedEx Ground</li>...
commodityDescription -- Type: string | Example: This field contains CommodityDescription | Description of the commodity being shipped. <br>Example:This field contains Commodity Description.<br><a onclick='loadDocReference("vaguecommoditydescriptions")'>Click here to see Vague commodity d...
countryRelationships -- Type: string | Valid values: DOMESTIC, INTERNATIONAL | Describes the country relationship among the shipments being picked up. This element is not mandatory for this request, but when added, the mandatory values are DOMESTIC or INTERNATIONAL. Empty or ...
expressFreightDetail -- Type: object | Placeholder for Express Freight pickup details. Provides the Express Freight pickup detailed information.
expressFreightDetail.bookingNumber -- Type: string | Example: 1234AGTT | Specify a freight shipment booking number from FedEx. This number is mandatory for freight dispatch requests.<br> Example: 1234AGTT
expressFreightDetail.dimensions -- Type: object | Example: {'length': 20, 'width': 15, 'height': 12, 'units': 'CM'} | Indicate the dimensions of the package.<br> Following conditions will apply: <ul><li>Dimensions are optional but when added, then all three dimensions must be indicated.</li><li>Dimensions are requ...
expressFreightDetail.dimensions.height -- Type: integer | Format: int32 | Example: 12 | Indicate the height of the package. No implied decimal places. Maximum value: 999 <br> Example: 12
expressFreightDetail.dimensions.length -- Type: integer | Format: int32 | Example: 20 | Indicate the length of the package. No implied decimal places. Maximum value is 999.<br>  Example: 20
expressFreightDetail.dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Specify the unit of measurement used for the package dimensions.
expressFreightDetail.dimensions.width -- Type: integer | Format: int32 | Example: 15 | Indicate the width of the package. No implied decimal places. Maximum value is 999.<br>  Example: 15
expressFreightDetail.service -- Type: string | Example: FEDEX_1_DAY_FREIGHT | Specify FedEx Service for the shipment.<br>Example: FEDEX_1_DAY_FREIGHT
expressFreightDetail.trailerLength -- Type: string | Valid values: TRAILER_28_FT, TRAILER_48_FT, TRAILER_53_FT | Example: TRAILER_28_FT | Specify the trailer size, required for dispatch.
expressFreightDetail.truckType -- Type: string | Valid values: DROP_TRAILER_AGREEMENT, LIFTGATE, TRACTOR_TRAILER_ACCESS | Example: DROP_TRAILER_AGREEMENT | Specify type of pickup truck.
originDetail -- Type: object | The origin address if different than the one associated with the shipper account. This element value is required when the package is to be picked up from an address other than the shipper account a...
originDetail.buildingPart -- Type: string | Valid values: APARTMENT, BUILDING, DEPARTMENT, FLOOR, ROOM, SUITE | Example: APARTMENT | This is the building type.
originDetail.buildingPartDescription -- Type: string | Example: 111 | Indicates the building part such as floor suite or apartment number or an identifier of the building.<br>Example: 111
originDetail.customerCloseTime -- Type: string | Example: 18:00:00 | Indicates the latest local time at which the driver can gain access to pickup the package(s).Format HH:MM:SS.<br>Example 18:00:00
originDetail.earlyPickup -- Type: boolean | Indicates if it is an early pickup. This applies only to Europe.
originDetail.geographicalPostalCode -- Type: string | Example: geographicalPostalCode | This is the alternate postal code associated with pickup location. (Applicable only for European pickups)
originDetail.packageLocation -- Type: string | Valid values: FRONT, NONE, REAR, SIDE | Example: FRONT | This provides a location description from where the courier/driver must pick up the package. It is mandatory for Ground Pickup.<br> Example: FRONT
originDetail.pickupAddressType -- Type: string | Valid values: ACCOUNT, SHIPPER, OTHER | Example: ACCOUNT | Indicates the type of pickup address being used whether it is account address, shipper address or alternate address. <br><br>Note: <ul><li>The default value is OTHER.</li><li> If the value is set t...
originDetail.pickupDateType -- Type: string | Valid values: SAME_DAY, FUTURE_DAY | Indicates whether the pickup request is for the same day or on a future date.
originDetail.pickupLocation -- Type: object | Example: {'contact': {'companyName': 'Fedex', 'personName': 'John Taylor', 'phoneNumber': '7194446666', 'phoneExtension': 'phone extension'}, 'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'urbanizationCode': 'URB FAIR OAKS', 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False, 'addressClassification': 'MIXED'}, 'accountNumber': {'value': 'XXX289837'}, 'deliveryInstructions': 'deliveryInstructions'} | The descriptive data for the party responsible for the pickup and the physical location from which the shipment is picked up. <br>Note: This information is not required in case the pickupAddressTyp...
originDetail.pickupLocation.accountNumber -- Type: object | Example: {'value': 'Your account number'} | This is the FedEx account number. <br>Example: Your account number
originDetail.pickupLocation.accountNumber.value -- Type: string | This is the account number. Maximum Length is 9. <br>Example: Your account number
originDetail.pickupLocation.address -- Type: object | Example: {'streetLines': ['123 Ship Street'], 'urbanizationCode': 'URB FAIR OAKS', 'city': 'Memphis', 'stateOrProvinceCode': 'TN', 'postalCode': '38017', 'countryCode': 'US', 'residential': False, 'addressClassification': 'MIXED'} | Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a ...
originDetail.pickupLocation.address.addressClassification -- Type: string | Valid values: MIXED, UNKNOWN, BUSINESS, RESIDENTIAL | Example: MIXED | Classifies a given address as either of unknown, residential, mixed or business.
originDetail.pickupLocation.address.city -- Type: string | Example: Memphis | This is a placeholder for City Name. <br>Note: This is conditional and not required in all the shipping requests. <br> Example: Beverly Hills
originDetail.pickupLocation.address.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
originDetail.pickupLocation.address.postalCode -- Type: string | Example: 38017 | This is a placeholder for postal code.<br>Note: The postal code is required for postal-aware countries. <br> Example: 38127<br><a onclick='loadDocReference("postalawarecountries")'>Click here to se...
originDetail.pickupLocation.address.residential -- Type: boolean | Indicate whether this address is Residential as opposed to Commercial.
originDetail.pickupLocation.address.stateOrProvinceCode -- Type: string | Example: TN | This is a placeholder for State or Province code.Maximum length is 2. Maximum length is 2<br> Example: CA <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province C...
originDetail.pickupLocation.address.streetLines -- Type: array | Example: ['123 Ship Street'] | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
originDetail.pickupLocation.address.streetLines[] -- Type: string | Example: [["123 Ship Street"]]
originDetail.pickupLocation.address.urbanizationCode -- Type: string | Example: URB FAIR OAKS | Optional<br> In Puerto Rico, identical street names and address number ranges can be found within the same ZIP Code. In these cases, the urbanization name is the only element that correctly identif...
originDetail.pickupLocation.contact -- Type: object | Example: {'companyName': 'Fedex', 'personName': 'John Taylor', 'phoneNumber': '7194446666', 'phoneExtension': 1234} | Indicates the contact details for the party such as name, phonenumber.
originDetail.pickupLocation.contact.companyName -- Type: string | Example: Fedex | Specify the contact person's company name. Maximum length is 35.
originDetail.pickupLocation.contact.personName -- Type: string | Example: John Taylor | Specify the contact person's name. Maximum Length is 70.
originDetail.pickupLocation.contact.phoneExtension -- Type: string | Specify the contact person's phone extension. Maximum length is 6.
originDetail.pickupLocation.contact.phoneNumber -- Type: string | Example: 7194446666 | Specify the contact person's phone number. Minimum Length is 8 and Maximum legth is 13.
originDetail.pickupLocation.deliveryInstructions -- Type: string | Indicates the detailed instructions for delivery.This is used with Ground Home Delivery.
originDetail.readyDateTimestamp -- Type: string | Example: 2020-04-21T11:00:00Z | Indicates the date and time when the freight shipment/package is ready for pick up.<br> Format: [YYYY-MM-DDTHH:MM:SSZ] <br> Example: 2020-04-02T11:00:00Z
originDetail.suppliesRequested -- Type: string | Example: Supplies requested by customer | Indicates if any shipping supplies are requested at the pickup origin required to pack the shipment such as FedEx Box, Large Box, FedEx Tube.<br> Example: Supplies requested by customer
oversizePackageCount -- Type: integer | Format: int32 | Example: 2 | Specify the number of oversize packages that are tendered to FedEx Ground.
packageCount -- Type: integer | Format: int32 | Example: 5 | Specify the total number of packages for the pickup.<br> Example: 5
pickupNotificationDetail -- Type: object | This object allows user to request for pickup confirmation email. User can specify upto 5 email addresses.
pickupNotificationDetail.emailDetails -- Type: array | Specify the list of email addresses along with locale to which the pickup confirmation email should be sent.
pickupNotificationDetail.emailDetails[] -- Type: object | Email addresses along with locale to which the pickup confirmation email must be sent.
pickupNotificationDetail.emailDetails[].address -- Type: string | Example: sample@gmail.com | Specify the email address.<br>Example: sample@gmail.com
pickupNotificationDetail.emailDetails[].locale -- Type: string | Example: en_US | Specify the language in which the email needs to be sent.Default value is en_US.<br>Example: en_US. .<br><a onclick='loadDocReference("locales")'>Click here to see Locales</a>
pickupNotificationDetail.format -- Type: string | Valid values: HTML, TEXT | Example: HTML | Specifies the format of email.
pickupNotificationDetail.userMessage -- Type: string | Example: This is the user message | Specifies the user message that can be sent as part of the pickup confirmation email.<br>Example: This is the user message
pickupType -- Type: string | Example: ON_CALL, PACKAGE_RETURN_PROGRAM, REGULAR_STOP. | Indicate the pickup type method by which the shipment to be tendered to FedEx.<br><i>Note: The value of this element does not specify dispatching the courier for package pickup.</i> <br>Example: ON...
remarks -- Type: string | Example: Please ring bell at loading dock. | Placeholder for any message to be passed to the FedEx pickup courier.<br> Example: Please ring bell at loading dock.
totalWeight -- Type: object | Example: {'units': 'KG', 'value': 20} | Specify The total weight of the packages for the pickup. Unit of measure is  LB. These are the package weight details.
totalWeight.units -- Type: string | Valid values: KG, LB | Example: KG | Indicates the type of package weight.
totalWeight.value -- Type: number | Format: double | Example: 20 | Indicates the package weight. Maximum length is 99999.<br> Example: 20
trackingNumber -- Type: string | Example: 795803657326 | This is a Tracking number for FedEx packages used for tracking a single package or group of packages.<br> Example: 795803657326<br><a onclick='loadDocReference("mocktrackingnumbersforfedexexpressan...

Pickup Availability

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
associatedAccountNumber -- Type: string | Example: 289737448 | Specify the account number that will be invoiced for this pickup.<br>Example: Your account number.
associatedAccountNumberType -- Type: string | Valid values: FEDEX_EXPRESS, FEDEX_GROUND, FEDEX_FREIGHT, FEDEX_OFFICE | Example: FEDEX_EXPRESS | This represents a kind of legacy account number from a FedEx operating entity for the account number associated to the pickup.
carriers -- Type: array | Example: ['FDXE'] | Specify the four letter code of a FedEx operating company thet meets your requirements.<br>Examples of FedEx Operating Companies are: <ul><li>FDXE - FedEx Express</li><li>FDXG - FedEx Ground</li><l...
carriers[] -- Type: string | Valid values: FDXE, FDXG
countryRelationship -- Type: string | Valid values: DOMESTIC, INTERNATIONAL | Example: INTERNATIONAL | Specify the country relationship among the shipments being picked up. Empty or incorrect values will result in to errors. <br><br><i>Note: <b>shipmentAttributes/serviceType</b> is required for dome...
customerCloseTime -- Type: string | Example: 18:00:00 | Specify the latest time the driver gets access to pick up the package. The time format is in HH:MM:SS and it refers to the local timezone. The driver should pick up the package by the given pickup ...
dispatchDate -- Type: string | Example: 2020-10-14 | Specify the date the package is to be picked up. The format is YYYY-MM-DD. If left blank, the system considers current date as dispatch date.<br> Example: 2020-01-01
numberOfBusinessDays -- Type: integer | Format: int32 | Example: 1 | Specify number of business days to consider when checking availability.<br>For example if you are indicating pickupDate for a Saturday and you indicate 3, Saturday, Sunday and Monday will be consid...
packageDetails -- Type: array | This object is used to specify the package details.
packageDetails[] -- Type: object | provides requested pickup package detail.
packageDetails[].packageSpecialServices -- Type: object | Indicates the special services associated with this package.
packageDetails[].packageSpecialServices.specialServiceTypes -- Type: array | Specifies special service types.<br>Example: DANGEROUS_GOODS<br><a onclick='loadDocReference("packagelevelspecialservicetypes")'>Click here to see Package level Special Service Types</a>
packageDetails[].packageSpecialServices.specialServiceTypes[] -- Type: string | Example: SIGNATURE_OPTION
packageReadyTime -- Type: string | Example: 15:30:00 | Specify the time that the package will be ready for pickup. The time format is HH:MM:SS and it refers to the local timezone. The driver should pick up the package/shipment by the given pickup time....
pickupAddress -- Type: object | Example: {'streetLines': ['123 Ship Street'], 'urbanizationCode': 'URB FAIR OAKS', 'city': 'Memphis', 'stateOrProvinceCode': 'TN', 'postalCode': '38017', 'countryCode': 'US', 'residential': False, 'addressClassification': 'MIXED'} | Specify the address for which pickup availability inquiry has been made. Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a c...
pickupAddress.addressClassification -- Type: string | Valid values: MIXED, UNKNOWN, BUSINESS, RESIDENTIAL | Example: MIXED | Classifies a given address as either of unknown, residential, mixed or business.
pickupAddress.city -- Type: string | Example: Memphis | This is a placeholder for City Name. <br>Note: This is conditional and not required in all the shipping requests. <br> Example: Beverly Hills
pickupAddress.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a> This is the country code for the Pickup address.<br>Example:...
pickupAddress.postalCode -- Type: string | Example: 38017 | This is a placeholder for postal code.<br>Note: The postal code is required for postal-aware countries. <br> Example: 38127<br><a onclick='loadDocReference("postalawarecountries")'>Click here to se...
pickupAddress.residential -- Type: boolean | Indicate whether this address is Residential as opposed to Commercial.
pickupAddress.stateOrProvinceCode -- Type: string | Example: TN | This is a placeholder for State or Province code.Maximum length is 2. Maximum length is 2<br> Example: CA <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province C...
pickupAddress.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
pickupAddress.streetLines[] -- Type: string | Example: [["123 Ship Street"]]
pickupAddress.urbanizationCode -- Type: string | Example: URB FAIR OAKS | Optional<br> In Puerto Rico, identical street names and address number ranges can be found within the same ZIP Code. In these cases, the urbanization name is the only element that correctly identif...
pickupRequestType -- Type: array | Example: ['SAME_DAY'] | Specify pickup request type.
pickupRequestType[] -- Type: string | Valid values: SAME_DAY, FUTURE_DAY
pickupType -- Type: string | Valid values: ON_CALL, TAG | Example: ON_CALL | Indicate the pickup type method by which the shipment to be tendered to FedEx.<br><i>Note: The value of this element does not specify dispatching the courier for package pickup.</i><br><a onclick='...
shipmentAttributes -- Type: object | Example: {'serviceType': 'FEDEX_FREIGHT_PRIORITY', 'weight': {'units': 'KG', 'value': 20}, 'packagingType': 'YOUR_PACKAGING', 'dimensions': {'length': 7, 'width': 8, 'units': 'CM', 'height': 9}} | Specify the shipment details, such as service type, packaging type, weight and dimensions. <br><br><i>Note: serviceType is required for domestic or international pickup availabilities.</i> Indicate...
shipmentAttributes.dimensions -- Type: object | Example: {'length': 7, 'width': 8, 'height': 9, 'units': 'CM'} | Indicate the dimensions of the package.<br> Following conditions will apply: <ul><li>Dimensions are optional but when added, then all three dimensions must be indicated.</li><li>Dimensions are requ...
shipmentAttributes.dimensions.height -- Type: integer | Format: int32 | Example: 10 | Indicate the height of the package. No implied decimal places. Maximum value is 999. <br> Example: 10
shipmentAttributes.dimensions.length -- Type: integer | Format: int32 | Example: 7 | Indicate the length of the package. No implied decimal places. Maximum value is 999. <br> Example: 20
shipmentAttributes.dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Unit of measure for the provided dimensions.<br><i>Note: Any value other than CM including blank/null will default to IN.</i>
shipmentAttributes.dimensions.width -- Type: integer | Format: int32 | Example: 8 | Indicate the width of the package. No implied decimal places. Maximum value is 999. <br> Example: 10
shipmentAttributes.packagingType -- Type: string | Example: YOUR_PACKAGING | Specify the FedEx Packaging Type for the shipment.
shipmentAttributes.serviceType -- Type: string | Example: FEDEX_FREIGHT_PRIORITY | Specify the FedEx service type for the shipment.<br>Example: FEDEX_FREIGHT_PRIORITY
shipmentAttributes.weight -- Type: object | Example: {'units': 'KG', 'value': 20} | These are the package weight details.
shipmentAttributes.weight.units -- Type: string | Valid values: KG, LB | Example: KG | Indicates the type of package weight.
shipmentAttributes.weight.value -- Type: number | Format: double | Example: 20 | Indicates the package weight. Maximum length is 99999.<br> Example: 20

Cancel Pickup

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
accountAddressOfRecord -- Type: object | Example: {'streetLines': ['123 Ship Street'], 'urbanizationCode': 'URB FAIR OAKS', 'city': 'Memphis', 'stateOrProvinceCode': 'TN', 'postalCode': '38017', 'countryCode': 'US', 'residential': False, 'addressClassification': 'MIXED'} | Address details for the associated pickup account. Indicates if the address is residential. Specifies the city name, country code, streetline number, postal code, address verification Identifier, a...
accountAddressOfRecord.addressClassification -- Type: string | Valid values: MIXED, UNKNOWN, BUSINESS, RESIDENTIAL | Example: MIXED | Classifies a given address as either of unknown, residential, mixed or business.
accountAddressOfRecord.city -- Type: string | Example: Memphis | This is a placeholder for City Name. <br>Note: This is conditional and not required in all the shipping requests. <br> Example: Beverly Hills Placeholder for the pickup city. Max length is 35. <br>...
accountAddressOfRecord.countryCode -- Type: string | Example: US | This is the two-letter country code.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
accountAddressOfRecord.postalCode -- Type: string | Example: 38017 | This is a placeholder for postal code.<br>Note: The postal code is required for postal-aware countries. <br> Example: 38127<br><a onclick='loadDocReference("postalawarecountries")'>Click here to se...
accountAddressOfRecord.residential -- Type: boolean | Indicate whether this address is Residential as opposed to Commercial.
accountAddressOfRecord.stateOrProvinceCode -- Type: string | Example: TN | This is a placeholder for State or Province code.Maximum length is 2. Maximum length is 2<br> Example: CA <br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province C...
accountAddressOfRecord.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
accountAddressOfRecord.streetLines[] -- Type: string | Example: [["123 Ship Street"]]
accountAddressOfRecord.urbanizationCode -- Type: string | Example: URB FAIR OAKS | Optional<br> In Puerto Rico, identical street names and address number ranges can be found within the same ZIP Code. In these cases, the urbanization name is the only element that correctly identif...
associatedAccountNumber -- Type: object | Example: {'value': 'Your account number'} | This is the FedEx account number. <br>Example: Your account number
associatedAccountNumber.value -- Type: string | This is the account number. Maximum Length is 9. <br>Example: Your account number
carrierCode -- Type: string | Valid values: FDXE, FDXG | Example: FDXE | This is a placeholder to provide the FedEx operating company (transportation) code used for package delivery. Required for FedEx Ground.<br> Optional for FedEx Express.<br> The Default is FedEx Exp...
location -- Type: string | Example: LOSA | The FedEx Express location identifier responsible for processing the pickup request. This is returned in the CreatePickup response and is required to cancel a FedEx Express dispatch.Required only f...
pickupConfirmationCode -- Type: string | Example: 7 | The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested.<br> Example: 7
remarks -- Type: string | Example: This is my remarks | This is to provide additional information.<br> Example: This is my remarks
scheduledDate -- Type: string | Example: 2019-10-15 | Indicates the date the pickup dispatch occurs.<br>Format YYYY-MM-DD <br> Example: 2019-10-15

Locator

Find Locations

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
carrierCodes -- Type: array | Unique code to identify the transporter.
carrierCodes[] -- Type: string | Valid values: FDXE, FDXG
constraints -- Type: object | Specify the constraints to be applied to the location attributes.
constraints.dropOffTimeNeeded -- Type: string | Format: HH:MM:SS | Example: 16:30:00 | Specify the preferred drop-off time for a package. This filters the results with locations supporting the specified drop-off time. <br> Example: 16:30:00
constraints.excludeUnavailableLocations -- Type: string | Example: true | Filter to exclude locations that are currently unavailable.<br>Valid values: True, False.
constraints.locationContentOptions -- Type: array | Specify the information to be included in the location results.
constraints.locationContentOptions[] -- Type: string | Valid values: HOLIDAYS, LOCATION_DROPOFF_TIMES, TIMEZONE_OFFSET | Example: LOCATION_DROPOFF_TIMES
dropOffServiceType -- Type: string | Example: GROUND | The drop-off service types supported by the specified location. If sort criteria is given as  LATEST_EXPRESS_DROPOFF_TIME and dropoffservicetype is GROUND then backend  will take the SORT_BY_LATEST...
dropoffTime -- Type: string | Example: 09:30:00 | Specifies the latest time by which you can drop-off a package at a location to process the shipment the same day. This limits the results to locations that support a specific drop-off time. The for...
getCall -- Type: boolean | Get a call. <br>Valid values: True, False.
includeHoliday -- Type: boolean | Example: True | Indicates true if the location holiday list is desired in the results; otherwise false <br> Valid values: True, False.
location -- Type: object | Based on the locationSearchCriterion value specified, the location element specifies the minimum requirement for address search like postalCode, countryCode, GeoCodes or city.<br><br><i>Note: Count...
location.address -- Type: object | Example: {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '90210', 'countryCode': 'US', 'residential': False} | Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of \"address parts\" which should be handled as a unit (such as ...
location.address.addressClassification -- Type: string | Valid values: MIXED, UNKNOWN, BUSINESS, RESIDENTIAL | The business residential indicators.
location.address.addressClassificationConfidence -- Type: string | Valid values: POTENTIAL, PERMANENT | The confidence of business residential classification business residential indicators.
location.address.addressVerificationId -- Type: string | Example: MARKET_LAUNCH | This is the address verification identifier. <br> Example: MARKET_LAUNCH
location.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> City or PostalCode is mandatory when search criteria is ADDRESS or PHONE_NUMBER<br> Example: Beverly Hills
location.address.countryCode -- Type: string | Example: US | This is the Two-letter country code.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
location.address.postalCode -- Type: string | Example: 90210 | This is placeholder for postal code.<br><i>Note: <ul><li>Postal code is required for postal-aware countries.</li>City or PostalCode is mandatory when search criteria is ADDRESS or PHONE_NUMBER</li>...
location.address.residential -- Type: boolean | Indicate whether this address is Residential as opposed to Commercial.<br>Valid Values: True or False.
location.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code. <br>Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
location.address.streetLines -- Type: array | Example: ['10 FedEx Parkway', 'Suite 302'] | This is a combination of number, street name, etc. <br><i>Note: Streetlines more than 3 will be ignored. Empty lines should not be included.</i><br>Example: [\"10 FedEx Parkway\", \"Suite 302\"]
location.address.streetLines[] -- Type: string
location.longLat -- Type: object | Example: {'latitude': 5.637376, 'longitude': 3.61607} | The ISO6709 geographic coordinates for a specific geographic location, specifically latitude and longitude.
location.longLat.latitude -- Type: string | The geo coordinate value that specifies the north-south position of the address.<br>Example: 36.1699° N
location.longLat.longitude -- Type: string | The geo coordinate value that specifies the East-West position of the address.<br>Example:115.1398° W
locationAttrTypes -- Type: array | Example: ['ACCEPTS_CASH', 'PACK_AND_SHIP'] | Indicates the attributes for the location.
locationAttrTypes[] -- Type: string | Valid values: ACCEPTS_CASH, ALREADY_OPEN, COPY_AND_PRINT_SERVICES, DANGEROUS_GOODS_SERVICES, DIRECT_MAIL_SERVICES, LOCATION_IS_IN_AIRPORT, NOTARY_SERVICES, OPEN_TWENTY_FOUR_HOURS, PACK_AND_SHIP, PACKAGING_SUPPLIES, PASSPORT_PHOTO_SERVICES, RETURNS_SERVICES, SIGNS_AND_BANNERS_SERVICE, SONY_PICTURE_STATION, DROP_BOX, DOMESTIC_SHIPPING_SERVICES, INTERNATIONAL_SHIPPING_SERVICES, CLEARANCE_SERVICES | Specify attributes to filter location types. If more than one value is specified, only those locations that have all the specified attributes will be returned. <br> Example: [ACCEPTS_CASH, PACK_AND...
locationCapabilities -- Type: array | Specify to filter the locations based on their capabilities.
locationCapabilities[] -- Type: object | Example: {'carrierCode': 'FDXE', 'serviceType': 'PRIORITY_OVERNIGHT', 'transferOfPossessionType': 'DROPOFF', 'serviceCategory': 'EXPRESS_PARCEL', 'daysOfWeek': ['MON', 'TUE']} | Location capabilities such as services, day of week, ability to dropoff, pickup shipments, ability to hold shipments for pickup, etc.
locationCapabilities[].carrierCode -- Type: string | Valid values: FDXE, FDXG | Example: FDXE | Unique code to identify the transporter.
locationCapabilities[].daysOfWeek -- Type: array | Example: [MON, TUE ] | The days of the week for which this capability applies.<br>Valid values:<ul><li>MON</li><li>TUE</li><li>WED</li><li>THU</li><li>FRI</li><li>SAT</li><li>SUN</li></ul>
locationCapabilities[].daysOfWeek[] -- Type: string
locationCapabilities[].serviceCategory -- Type: string | Valid values: EXPRESS_FREIGHT, EXPRESS_PARCEL, GROUND_HOME_DELIVERY | Example: EXPRESS_PARCEL  | The service category applicable for the capability.
locationCapabilities[].serviceType -- Type: string | Example: PRIORITY_OVERNIGHT | Indicates the service types supported by the location.<br>Example: PRIORITY_OVERNIGHT<br><a onclick='loadDocReference("servicetypes")'>Click here to see Service Types</a>
locationCapabilities[].transferOfPossessionType -- Type: string | Valid values: DROPOFF, HOLD_AT_LOCATION, REDIRECT_TO_HOLD_AT_LOCATION | Example: DROPOFF | The method by which a package is transferred to the possession of a FedEx location.
locationSearchCriterion -- Type: string | Valid values: ADDRESS, GEOGRAPHIC_COORDINATES, PHONE_NUMBER | Example: ADDRESS | Specify the criteria to be used to search for FedEx locations. Default value is ADDRESS if no value is passed.<p>Valid values: <ul><li>ADDRESS &ndash; Search by address. Location detail data is req...
locationTypes -- Type: array | Results filter which narrows the search to specific types of FedEx Locations.
locationTypes[] -- Type: string | Valid values: FEDEX_AUTHORIZED_SHIP_CENTER, FEDEX_OFFICE, FEDEX_SELF_SERVICE_LOCATION, FEDEX_ONSITE, FEDEX_EXPRESS_STATION, FEDEX_SHIPSITE, FEDEX_SHIP_AND_GET | Example: FEDEX_AUTHORIZED_SHIP_CENTER
locationsSummaryRequestControlParameters -- Type: object | Use this object to specify all the inputs to get the locations details.
locationsSummaryRequestControlParameters.distance -- Type: object | Example: {'units': 'KM', 'value': 3.5} | Specify the unit of measurement and the radius around the address to search FedEx locations. Specifies value and unit of distance between the FedEx locations and the address specified.<br>Example: ...
locationsSummaryRequestControlParameters.distance.units -- Type: string | Valid values: KM, MI | Indicates the unit of measure for the distance.
locationsSummaryRequestControlParameters.distance.value -- Type: number | Format: double | Specifies the distance value.<br>Example: 3.5
locationsSummaryRequestControlParameters.maxResults -- Type: integer | Format: int32 | Example: 12 | Specify the maximum number of locations to be returned in the reply.<br><i>Note: This takes precedence over the element multipleMatchesAction value RETURN_ALL.</i>
multipleMatchesAction -- Type: string | Valid values: RETURN_ALL, RETURN_ERROR, RETURN_FIRST | Example: RETURN_ALL | Specify the criterion to be used to return location results when there are multiple matches.<br>Valid values: RETURN_ALL,RETURN_ERROR, RETURN_FIRST.<br><br><i>Note: The 'maxResults' value takes pre...
packageAttributes -- Type: array | Specify location supported package constraints to narrow the search.<br><br>For example, a package weighing more than 151 pounds may not be supported at all location types. Drop box location would ...
packageAttributes[] -- Type: object | Example: {'weight': {'units': 'LB', 'value': 150}, 'dimensions': {'length': 20, 'width': 40, 'units': 'IN', 'height': 70}}
packageAttributes[].dimensions -- Type: object | Example: {'length': 100, 'width': 50, 'height': 30, 'units': 'CM'} | Indicate the dimensions of the package.<br> Following conditions will apply: <ul><li>Dimensions are optional but when added, then all three dimensions must be indicated.</li><li>Dimensions are requ...
packageAttributes[].dimensions.height -- Type: integer | Format: int32 | Example: 30 | Indicate the height of the package. No implied decimal places. Maximum value is 999.<br> Example: 10
packageAttributes[].dimensions.length -- Type: integer | Format: int32 | Example: 100 | Indicate the length of the package. No implied decimal places. Maximum value is 999.<br> Example: 20
packageAttributes[].dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Indicate the dimensions of the package.<br> Following conditions will apply: <ul><li>Dimensions are optional but when added, then all three dimensions must be indicated.</li><li>Dimensions are requ...
packageAttributes[].dimensions.width -- Type: integer | Format: int32 | Example: 50 | Indicate the width of the package. No implied decimal places. Maximum value is 999.<br> Example: 10
packageAttributes[].weight -- Type: object | Example: {'units': 'LB', 'value': 10} | Specify the package weight. These are the package weight details.
packageAttributes[].weight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the weighing unit of the package.
packageAttributes[].weight.value -- Type: number | Format: double | Example: 10 | This is package weight. Max. Length is 99999.
phoneNumber -- Type: string | Example: 9015551234 | Specify the phone number If the locationSearchCriterion is set to 'PHONE_NUMBER'.The mobile numbers will not return results when set as a criterion. <br> Example: 9015551234
redirectToHoldType -- Type: string | Valid values: FEDEX_EXPRESS, FEDEX_GROUND, FEDEX_GROUND_HOME_DELIVERY | Example: FEDEX_GROUND | Specify the type of service supported by a FedEx location for redirect to hold.
sameCountry -- Type: boolean | Example: True | Filter to display locations within the same country as the search criteria.<br>Valid values: True, False.
sameState -- Type: boolean | Example: True | Filter to display locations within the same state as the search criteria.<br>Valid values: True, False.
sort -- Type: object | Specifies how the location search results will be sorted in the reply.
sort.criteria -- Type: string | Valid values: DISTANCE, LATEST_EXPRESS_DROPOFF_TIME, LATEST_GROUND_DROPOFF_TIME, LOCATION_TYPE | Example: DISTANCE | Specify the criteria to sort the location details.
sort.order -- Type: string | Valid values: ASCENDING, DESCENDING | Example: ASCENDING | Specify the sort order of the location search results, either ascending or descending. Defaults to ascending order.
trackingInfo -- Type: object | Information uniquely identifying a shipment such as Tracking number, ShipDate, and Tracking number uniqueId.
trackingInfo.shipDate -- Type: string | Example: 2019-10-13 | The date of shipment.<br> Example: 2019-10-13
trackingInfo.trackingNumber -- Type: string | Example: 123456789012 | A tracking number identifying a shipment. Used to return locations that are relevant to the shipment.<br>Example: 123456789012
trackingInfo.uniqueTrackingId -- Type: string | Example: 789645 | A unique tracking number identifying a shipment. Used to return locations that are relevant to the shipment.<br> Example: 012345678912

Service Availability

Retrieve Services and Packaging Options

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
accountNumber -- Type: object | Example: {'value': '123456789'} | This is a Payor account number associated with the shipment. Account number is required, for SmartPost shipments (i.e. Carrier code: FXSP) This is FedEx account number details.
accountNumber.value -- Type: string | This is the account number. Max Length is 9. Example: Your account number
carrierCodes -- Type: array | "Specify the four letter code of a FedEx operating company that meets your requirements<br>Examples of FedEx Operating Companies are:<ul><li>FDXE - FedEx Express</li><li>FDXG - FedEx Ground</li><li...
carrierCodes[] -- Type: string | Valid values: FDXE, FDXG, FXFR, FXSP
requestedShipment -- Type: object | Example: {'recipients': [{'address': {'streetLines': ['Bldg. 10', '10 FedEx Parkway'], 'postalCode': 'm1m1m1', 'countryCode': 'CA', 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'residential': False}}]} | The descriptive data for the requested shipment.
requestedShipment.freightShipmentDetail -- Type: object | Conditional<br> Required when using FEDEX_FREIGHT and FEDEX_NATIONAL_FREIGHT services or FXFR carrier code Conditional  Details specific to a FedEx Freight LTL shipment (i.e. FedEx Priority and Eco...
requestedShipment.freightShipmentDetail.aliasID -- Type: string | Example: 36839 | Conditional. <br> This is bill to alias identifier.
requestedShipment.freightShipmentDetail.alternateBilling -- Type: boolean | Valid values: True, False | Example: True | Optional : Designates a bill-to address <br> Example: true
requestedShipment.freightShipmentDetail.clientDiscountPercent -- Type: number | Format: double | Example: 10.5 | Conditional <br> This is only used for anonymous rate requests <br> Example: 10.5
requestedShipment.freightShipmentDetail.fedExFreightAccountNumber -- Type: object | Example: {'value': 'Your account number'} | Conditional  FedEx Freight account number used with FEDEX_FREIGHT or FEDEX_FREIGHT_PRIORITY service; required for account-specific Freight rates This is FedEx account number details.
requestedShipment.freightShipmentDetail.fedExFreightAccountNumber.value -- Type: string | This is the account number. Max Length is 9. Example: Your account number
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress -- Type: object | Example: {'contactAncillaryDetail': {'emailAddresses': [{'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}, {'emailNotificationFormatType': 'TEXT', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}], 'prefix': 'prefix', 'phoneNumberDetails': [{'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}, {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}], 'companyName': {'division': 'division', 'companyCd': 'companyCd', 'name': 'name', 'department': 'department', 'storeId': 'storeId'}, 'title': 'title'}, 'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}, 'addressAncillaryDetail': {'locationInCity': 'location in the city', 'suite': 'suite', 'locationInProperty': 'location in the property', 'addtionalDescriptions': 'addtional descriptions', 'department': 'department', 'roomFloor': 'room or floor', 'crossStreet': 'cross street', 'building': 'building', 'apartment': 'apartment', 'room': 'room', 'addressVerificationOverrideReason': 'CUSTOMER_PROVIDED_PROOF'}} | Conditional  Required if a FedEx Freight account number is specified Specifies the contact and address details of a location.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.countryCode -- Type: object | Example: US | This is a Two-letter country code.Max length is two.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.postalCode -- Type: object | Example: 38127 | This is the Postal code. This is Optional for non postal-aware countries. Max length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal awar...
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.residential -- Type: boolean | Valid values: True, False | Indicate whether this address is Residential as opposed to Commercial.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code. <br> Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail -- Type: object | Example: {'locationInCity': 'Forester subdivision', 'suite': 'suite 201', 'addressVerificationOverrideReason': 'CUSTOMER_PROVIDED_PROOF', 'locationInProperty': 'south west of main office entrance', 'addtionalDescriptions': 'north door', 'department': 'Claims department', 'roomFloor': '5th floor', 'crossStreet': 'Union and Main', 'building': 'Building 300', 'apartment': 'Apartment 1503', 'room': 'Room B-23'} | specifies additional address details for the physical location
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.addressVerificationOverrideReason -- Type: string | Specifies the reason to override address verification.<br> Valid values:  CUSTOMER_PREFERENCE, CUSTOMER_PROVIDED_PROOF, MANUAL_VALIDATION
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.addtionalDescriptions -- Type: string | Specifies any additional information about the given address.<br>Example: north door
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.apartment -- Type: string | This is the apartment information for the given address.<br>Example: Apartment 1503
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.building -- Type: string | This is the building information for the given address.<br>Example: Building 300
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.crossStreet -- Type: string | This is the cross street information for the given address.<br>Example: Union and Main
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.department -- Type: string | This is the department for the given address.<br>Example: Claims department
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.locationInCity -- Type: string | This is the Subdivision or community within a city for the given address.<br> Forester subdivision
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.locationInProperty -- Type: string | This is location in a campus, such as exterior building annex A.<br> Example: south west of main office entrance.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.room -- Type: string | This is room specific information for the given address.<br>Example: Room B-23
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.roomFloor -- Type: string | This is to specify the room or floor information for the given address.<br>Example: 5th floor
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.suite -- Type: string | This is the suite information for the given address.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact -- Type: object | Indicate the contact details for this shipment. Billing contact information for FedEx Freight Shipment.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Max length is 80.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact.faxNumber -- Type: string | Specify contact person's fax number. Max length is 15.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact name.Max Length is 70.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact.phoneExtension -- Type: string | Specify contact person's phone extension. Max length is 6.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact person's phone number. Max length is 15.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail -- Type: object | Example: {'emailAddresses': [{'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}, {'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}], 'prefix': 'prefix', 'phoneNumberDetails': [{'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}, {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}], 'companyName': {'division': 'division', 'companyCd': 'companyCd', 'name': 'name', 'department': 'department', 'storeId': 'storeId'}, 'title': 'title'} | Indicate additional contact details such as email and phone information.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName -- Type: object | Example: {'division': 'Research and Design', 'companyCd': 'ARMZD', 'name': 'Armor Co Incorporated', 'department': 'department', 'storeId': 'A1234'} | Use this to provide Company details.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName.companyCd -- Type: string | This is Company code.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName.department -- Type: string | This is department within a company
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName.division -- Type: string | This is division within a company.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName.name -- Type: string | This is company Name.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName.storeId -- Type: string | This is Store identifier within a company.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.emailAddresses -- Type: array | These are contact email addresses.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.emailAddresses[] -- Type: object | Example: {'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.emailAddresses[].address -- Type: string | This is the email address.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.emailAddresses[].emailNotificationFormatType -- Type: string | Valid values: TEXT, HTML | These are email notification format type.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.emailAddresses[].permissions -- Type: object | Indicate the Email Permission Type.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails -- Type: array | Phone Number Details
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[] -- Type: object | Example: {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number -- Type: object | Example: {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'} | A phone number for a party. Numeric only
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.areaCode -- Type: string | Indicate the Area Code for the phone number.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.countryCode -- Type: string | Example: US | The two-letter code used to identify a country.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.extension -- Type: string | Indicate the extension for the phone number.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.localNumber -- Type: string | Indicate the local phone number for contacting in the event of an emergency.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.personalIdentificationNumber -- Type: string | Indicate the Personal Identification Number associated with the phone number.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].permissions -- Type: object | This is to specify the phone permission.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].type -- Type: string | Valid values: FAX, HOME, MOBILE, PAGER, WORK | Indicate the Phone Number Type.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].usage -- Type: string | Valid values: PRIMARY, SECONDARY | Specify if the phone usage is Primary or Secondary.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.prefix -- Type: string | Specify the Prefix.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.title -- Type: string | Indicate the contact title.
requestedShipment.freightShipmentDetail.liabilityCoverageDetail -- Type: object | Specifies the Liability Coverage detail for Freight Shipment. This is used specify the line item level liability coverage.
requestedShipment.freightShipmentDetail.liabilityCoverageDetail.coverageAmount -- Type: object | Specifies the Liability Coverage Amount & Currency used for Freight Shipment. Optional, but if indicated 'amount' and 'currency' must be provided.
requestedShipment.freightShipmentDetail.liabilityCoverageDetail.coverageAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Max length 18 including decimal.<br>Example: 12.45
requestedShipment.freightShipmentDetail.liabilityCoverageDetail.coverageAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("countrycodes")'>Click here to see Currency Codes</a>
requestedShipment.freightShipmentDetail.liabilityCoverageDetail.coverageType -- Type: string | Valid values: NEW, USED_OR_RECONDITIONED | Optional  This is the liability coverage type.
requestedShipment.freightShipmentDetail.lineItem -- Type: array | Required  Class/weight pairs and associated details for a Freight shipment
requestedShipment.freightShipmentDetail.lineItem[] -- Type: object | Description of an individual commodity or class of content in a shipment.
requestedShipment.freightShipmentDetail.lineItem[].classProvidedByCustomer -- Type: boolean | Example: True | defaults to false. FEDEX INTERNAL USE ONLY for FedEx system that estimate freight class from customer-provided dimensions and weight <br> Example: true
requestedShipment.freightShipmentDetail.lineItem[].description -- Type: string | Example: Description | Customer-provided description of this line item <br> Example: Description
requestedShipment.freightShipmentDetail.lineItem[].dimensions -- Type: object | Example: {'length': 100, 'width': 50, 'height': 30, 'units': 'CM'} | Individual line item dimensions. Conditionally required. Need volume for intra mexico rates. Indicate the dimensions of the package. <br>Following conditions will apply: <ul><li>Dimensions are opti...
requestedShipment.freightShipmentDetail.lineItem[].dimensions.height -- Type: integer | Format: int32 | Example: 30 | Indicate the height of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.freightShipmentDetail.lineItem[].dimensions.length -- Type: integer | Format: int32 | Example: 100 | Indicate the length of the package. No implied decimal places. Maximum value: 999 <br> Example: 20
requestedShipment.freightShipmentDetail.lineItem[].dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Indicate the Unit of measure for the provided dimensions.<br>Valid Values are:<ul><li>IN - inches</li><li>CM - centimeters</li><br>Note: Any value other than CM including blank/null will default to...
requestedShipment.freightShipmentDetail.lineItem[].dimensions.width -- Type: integer | Format: int32 | Example: 50 | Indicate the width of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.freightShipmentDetail.lineItem[].freightClass -- Type: string | Valid values: CLASS_050, CLASS_055, CLASS_060, CLASS_065, CLASS_070, CLASS_077_5, CLASS_085, CLASS_092_5, CLASS_100, CLASS_110, CLASS_125, CLASS_150, CLASS_175, CLASS_200, CLASS_250, CLASS_300, CLASS_400, CLASS_500 | Example: CLASS_050 | Specify the freight class based on the item to be shipped and its weight measured per unit volume(Example: Kilograms per Cubic Meter) the shipment is categorized accordingly.<a href='http://www.fed...
requestedShipment.freightShipmentDetail.lineItem[].handlingUnits -- Type: integer | Format: int32 | Example: 1 | Optional<br>Number of individual handling units to which this line applies. (NOTE - Total of line-item-level handling units may not balance to shipment-level total handling units) <br> Example: 1
requestedShipment.freightShipmentDetail.lineItem[].hazardousMaterials -- Type: string | Valid values: HAZARDOUS_MATERIALS, BATTERY, ORM_D, REPORTABLE_QUANTITIES, SMALL_QUANTITY_EXCEPTION, LIMITED_QUANTITIES_COMMODITIES | Example: HAZARDOUS_MATERIALS | Indicates the kind of hazardous material content in this line item <br> Example: HAZARDOUS_MATERIALS
requestedShipment.freightShipmentDetail.lineItem[].packaging -- Type: string | Example: SELFPACKAGE | Packaging type for this line item <br> Example: SELFPACKAGE
requestedShipment.freightShipmentDetail.lineItem[].pieces -- Type: integer | Format: int32 | Example: 1 | Optional <br> Total number of pieces <br> Example: 1
requestedShipment.freightShipmentDetail.lineItem[].volume -- Type: object | Example: {'units': 'CUBIC_FT', 'value': 9.965781217890562} | Individual line item volume. <br>                Conditionally required. <br> Need volume for intra mexico rates Optional  Individual line item volume.  Conditional  Need Volume or Rate for intra m...
requestedShipment.freightShipmentDetail.lineItem[].volume.units -- Type: string | Valid values: CUBIC_FT, CUBIC_M | Example: CUBIC_FT | The unit is in Cubic Feet or Cubic Meters. <br> Example: CUBIC_FT
requestedShipment.freightShipmentDetail.lineItem[].volume.value -- Type: number | Format: double | Example: 9.965781217890562 | The amount of volume. <br> Example: 9.965781217890562
requestedShipment.freightShipmentDetail.lineItem[].weight -- Type: object | Example: {'units': 'LB', 'value': 10} | Total weight of items for this line item These are the weight details. Specify the total weight of the shipment. <br>This is only applies to International shipments and should be used on the first ...
requestedShipment.freightShipmentDetail.lineItem[].weight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to weigh the shipment. The package and commodity weight unit should be the same else the request will result in an error. This is package weight type.<br> Examp...
requestedShipment.freightShipmentDetail.lineItem[].weight.value -- Type: number | Format: double | Example: 10 | Specify the value of weight of shipment.<br>Example: 68.25 Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'...
requestedShipment.freightShipmentDetail.role -- Type: string | Valid values: CONSIGNEE, SHIPPER | Example: SHIPPER | Required <br> Indicates the role of the party submitting the transaction <br> Example: SHIPPER
requestedShipment.freightShipmentDetail.shipmentDimensions -- Type: object | Example: {'length': 100, 'width': 50, 'height': 30, 'units': 'CM'} | Optional  Overall Shipment Dimensions Value Indicate the dimensions of the package.<br> Following conditions will apply: <ul><li>Dimensions are optional but when added, then all three dimensions mu...
requestedShipment.freightShipmentDetail.shipmentDimensions.height -- Type: integer | Format: int32 | Example: 30 | Indicate the height of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.freightShipmentDetail.shipmentDimensions.length -- Type: integer | Format: int32 | Example: 100 | Indicate the length of the package. No implied decimal places. Maximum value: 999 <br> Example: 20
requestedShipment.freightShipmentDetail.shipmentDimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Indicate the Unit of measure for the provided dimensions.<br>Valid Values are:<ul><li>IN - inches</li><li>CM - centimeters</li><br>Note: Any value other than CM including blank/null will default to...
requestedShipment.freightShipmentDetail.shipmentDimensions.width -- Type: integer | Format: int32 | Example: 50 | Indicate the width of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.freightShipmentDetail.totalHandlingUnits -- Type: integer | Format: int32 | Optional  Total number of individual handling units in the entire shipment (for unit pricing). May not be negative
requestedShipment.pickupType -- Type: string | Valid values: CONTACT_FEDEX_TO_SCHEDULE, DROPOFF_AT_FEDEX_LOCATION, USE_SCHEDULED_PICKUP | Example: DROPOFF_AT_FEDEX_LOCATION | Conditional Required for Express and Ground, but optional for FREIGHT or SMARTPOST.<br>Indicate the pickup type method by which the shipment yo be tendered to FedEx.<br><i>Note: The value of this e...
requestedShipment.recipients -- Type: array | Specifies the recipient details, such as postal code, state or province code, and country code of the recipient. Note: At least one recipient is required. These are recipient details, such as posta...
requestedShipment.recipients[] -- Type: object | Example: {'address': {'streetLines': ['Bldg. 10', '10 FedEx Parkway'], 'city': 'Collierville', 'stateOrProvinceCode': 'TN', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Ryan Taylor', 'emailAddress': 'sample@fedex.com', 'phoneNumber': '1234567890', 'phoneExtension': '91', 'companyName': 'Fedex', 'faxNumber': '123456789'}, 'accountNumber': {'value': '123456789'}} | optional information about sender/recipient including Address, Contact, Account number.
requestedShipment.recipients[].accountNumber -- Type: object | Example: {'value': '123456789'} | Specify the Account number. This is FedEx account number details.
requestedShipment.recipients[].accountNumber.value -- Type: string | This is the account number. Max Length is 9. Example: Your account number
requestedShipment.recipients[].address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.recipients[].address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.recipients[].address.countryCode -- Type: object | Example: US | This is a Two-letter country code.Max length is two.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.recipients[].address.postalCode -- Type: object | Example: 38127 | This is the Postal code. This is Optional for non postal-aware countries. Max length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal awar...
requestedShipment.recipients[].address.residential -- Type: boolean | Valid values: True, False | Indicate whether this address is Residential as opposed to Commercial.
requestedShipment.recipients[].address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code. <br> Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
requestedShipment.recipients[].address.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
requestedShipment.recipients[].address.streetLines[] -- Type: string
requestedShipment.recipients[].contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Contact details for the Party such as Name, Email, PhoneNumber
requestedShipment.recipients[].contact.companyName -- Type: string | Example: Fedex | Specify contact person's company name. Max length is 35.<br>Example: FedEx
requestedShipment.recipients[].contact.emailAddress -- Type: string | Example: sample@company.com | Contact person's email address. Max length is 80.<br>Example: sample@company.com
requestedShipment.recipients[].contact.faxNumber -- Type: string | Example: 956123 | Contact person's fax number. Max length is 15.<br>Example: 956123
requestedShipment.recipients[].contact.personName -- Type: string | Example: John Taylor | Specify the recipient contact person's name. Max Length is 70.<br>Example: John Taylor
requestedShipment.recipients[].contact.phoneExtension -- Type: string | Example: 91 | contact person's phone extension. Max length is 6.<br>Example: 91
requestedShipment.recipients[].contact.phoneNumber -- Type: string | Example: 1234567890 | Contact person's phone number. Max length is 15.<br>Example: 1234567890
requestedShipment.requestedPackageLineItems -- Type: array | 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...
requestedShipment.requestedPackageLineItems[] -- Type: object
requestedShipment.requestedPackageLineItems[].contentRecord -- Type: object | Specify in details the contents of the package. package/shipment content details
requestedShipment.requestedPackageLineItems[].contentRecord.description -- Type: string | Example: This is the part number. | This is the description of the package item.
requestedShipment.requestedPackageLineItems[].contentRecord.itemNumber -- Type: string | Example: 45673289 | This is a package item number.<br> Example: 45673289
requestedShipment.requestedPackageLineItems[].contentRecord.partNumber -- Type: string | Example: 123 | This is the part Number <br> Example: 123
requestedShipment.requestedPackageLineItems[].contentRecord.receivedQuantity -- Type: integer | Format: int32 | Example: 2 | This is the package item quantity.<br> Example: 2
requestedShipment.requestedPackageLineItems[].customerReferences -- Type: array | These are additional customer reference data for commercial invoice.
requestedShipment.requestedPackageLineItems[].customerReferences[] -- Type: object
requestedShipment.requestedPackageLineItems[].customerReferences[].customerReferenceType -- Type: string | Valid values: BILL_OF_LADING, CUSTOMER_REFERENCE, DEPARTMENT_NUMBER, INVOICE_NUMBER, P_O_NUMBER, SHIPMENT_INTEGRITY, INTRACOUNTRY_REGULATORY_REFERENCE, STORE_NUMBER, RMA_ASSOCIATION, SHIPPER_ID1, SHIPPER_ID2 | Example: DEPARTMENT_NUMBER | This is a customer reference type. Note: Use type as RMA_ASSOCIATION and value as the RMA Number to associate Ground Call Tag shipments to the outbound shipment.<br><a onclick='loadDocReference("cu...
requestedShipment.requestedPackageLineItems[].customerReferences[].value -- Type: string | Example: 3686 | This is a customer reference type value.<br>Example: 3686
requestedShipment.requestedPackageLineItems[].declaredValue -- Type: object | This is the Declared Value represents FedEx maximum liability in connection with a shipment of that Package, including but not limited to, any loss, damage, delay, misdelivery, any failure to provi...
requestedShipment.requestedPackageLineItems[].declaredValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Max length 18 including decimal.<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].declaredValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("countrycodes")'>Click here to see Currency Codes</a>
requestedShipment.requestedPackageLineItems[].dimensions -- Type: object | Example: {'length': 100, 'width': 50, 'height': 30, 'units': 'CM'} | Indicate the dimensions of the package. <br>Following conditions will apply: <ul><li>Dimensions are optional but when added, then all three dimensions must be indicated.</li><li>Dimensions are requ...
requestedShipment.requestedPackageLineItems[].dimensions.height -- Type: integer | Format: int32 | Example: 30 | Indicate the height of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].dimensions.length -- Type: integer | Format: int32 | Example: 100 | Indicate the length of the package. No implied decimal places. Maximum value: 999 <br> Example: 20
requestedShipment.requestedPackageLineItems[].dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Indicate the Unit of measure for the provided dimensions.<br>Valid Values are:<ul><li>IN - inches</li><li>CM - centimeters</li><br>Note: Any value other than CM including blank/null will default to...
requestedShipment.requestedPackageLineItems[].dimensions.width -- Type: integer | Format: int32 | Example: 50 | Indicate the width of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].groupPackageCount -- Type: integer | Format: int32 | Indicate the grouped package count. These are number of identical package(s) each with one or more commodities. <br> Example: 2
requestedShipment.requestedPackageLineItems[].itemDescriptionForClearance -- Type: string | Example: Item Description for Clearence | Describe the content of the package for customs clearance purposes. This applies to intra-UAE, intra-Columbia and intra-Brazil shipments.
requestedShipment.requestedPackageLineItems[].packageSpecialServices -- Type: object | These are special services that are available at the package level for some or all service types.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail -- Type: object | These are details for the package containing alcohol. This is required for alcohol special service. The alcoholRecipientType is required.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.alcoholRecipientType -- Type: string | Valid values: LICENSEE, CONSUMER | Example: LICENSEE | Specify the Alcohol Recipient Type of the shipment. <br> Example: <br> <ul><li>LICENSEE- FedEx approved alchol shipper having appropriate licenses. </li><li> CONSUMER- Individual consumer to whom t...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.shipperAgreementType -- Type: string | Example: Retailer | Specify the type of entity, the shipper for alcohol shipment is registered such as fulfillment house, retailer or a winery.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails -- Type: array | Indicates the battery details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[] -- Type: object | Provide details about the batteries or cells that are contained within this specific package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryMaterialType -- Type: string | Valid values: LITHIUM_METAL, LITHIUM_ION | Example: LITHIUM_METAL | Indicate the material composition of the battery or cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryPackingType -- Type: string | Valid values: CONTAINED_IN_EQUIPMENT, PACKED_WITH_EQUIPMENT | Example: CONTAINED_IN_EQUIPMENT | Describe the packing arrangement of the battery or cell with respect to other items within the same package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryRegulatoryType -- Type: string | Valid values: IATA_SECTION_II | Example: IATA_SECTION_II | This is a regulation specific classification for the battery or the cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail -- Type: object | For Ground-only COD, populate this object for COD detail information at the package level. Conditional <br> For Express-only COD, populate this object for COD detail information at the shipment lev...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail.codCollectionAmount -- Type: object | Example: {'currency': 'USD', 'amount': 100.5} | Optional, but if indicated 'amount' and 'currency' must be provided. Use this object to specify amount and currency details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Max length 18 including decimal.<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail.codCollectionAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("countrycodes")'>Click here to see Currency Codes</a>
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail.codCollectionType -- Type: string | Valid values: COMPANY_CHECK, ANY, CASH, GUARANTEED_FUNDS, PERSONAL_CHECK | Example: CASH | Identifies the type of funds FedEx should collect upon shipment delivery.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail -- Type: object | Use this object to provide Dangerous Goods Detail in the shipment.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.accessibility -- Type: string | Valid values: ACCESSIBLE, INACCESSIBLE | Example: ACCESSIBLE | Specify the Dangerous Goods Accessibility Type. Valid Values: <ul><li>INACCESSIBLE - It does not have to be accessible on the aircraft.</li><li>ACCESSIBLE - It must be fully accessible on the aircr...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options -- Type: array | Example: ['HAZARDOUS_MATERIALS', 'LIMITED_QUANTITIES_COMMODITIES'] | Indicate the kind of content being reported.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options[] -- Type: string | Valid values: HAZARDOUS_MATERIALS, BATTERY, ORM_D, REPORTABLE_QUANTITIES, SMALL_QUANTITY_EXCEPTION, LIMITED_QUANTITIES_COMMODITIES
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight -- Type: object | Example: {'units': 'LB', 'value': 10} | These are the weight details. Specify the total weight of the shipment. <br>This is only applies to International shipments and should be used on the first package of a multiple piece shipment. Thi...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to weigh the shipment. The package and commodity weight unit should be the same else the request will result in an error. This is package weight type.<br> Examp...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.value -- Type: number | Format: double | Example: 10 | Specify the value of weight of shipment.<br>Example: 68.25 Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.pieceCountVerificationBoxCount -- Type: integer | Format: int32 | Specify the count.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionDetail -- Type: object | These Signature option details.Required  if SignatureOptions is indicated.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionDetail.signatureReleaseNumber -- Type: string | Example: TX64739DL7564 | This is the release number. Required if signature option is NO_SIGNATURE_REQUIRED.<br> Example: 23456
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionType -- Type: string | Valid values: SERVICE_DEFAULT, NO_SIGNATURE_REQUIRED, INDIRECT, DIRECT, ADULT | Example: NO_SIGNATURE_REQUIRED | Indicate the Signature Type.<br>Valid Values:<ul><li>ADULT - Adult signature required, at recipient address.</li><li>DIRECT - Signature required, at recipient address.</li><li>INDIRECT - Signature ...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes -- Type: array | Example: ['BATTERY', 'DANGEROUS_GOODS'] | Special services requested for the shipment.<br>Example: <ul><li>RETURN_SHIPMENT</li><li>BROKER_SELECT_OPTION</li><li>CALL_BEFORE_DELIVERY</li><li>COD</li><li>CUSTOM_DELIVERY_WINDOW</li></ul><a onc...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes[] -- Type: string
requestedShipment.requestedPackageLineItems[].physicalPackaging -- Type: string | Example: FEDEX_ENVELOPE | Specify the packaging used.<br>Example: FEDEX_PAK<br><a onclick='loadDocReference("packagetypes")'>Click here to see Package Types</a>
requestedShipment.requestedPackageLineItems[].weight -- Type: object | Example: {'units': 'LB', 'value': 10} | These are the weight details. Specify the total weight of the shipment. <br>This is only applies to International shipments and should be used on the first package of a multiple piece shipment. Thi...
requestedShipment.requestedPackageLineItems[].weight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to weigh the shipment. The package and commodity weight unit should be the same else the request will result in an error. This is package weight type.<br> Examp...
requestedShipment.requestedPackageLineItems[].weight.value -- Type: number | Format: double | Example: 10 | Specify the value of weight of shipment.<br>Example: 68.25 Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'...
requestedShipment.shipDateStamp -- Type: string | Example: 2020-02-28 | Required.<br>Specify the Shipment date. Required for future ship date. Default is current date if not indicated or date is in the past. <br>Format is YYYY-MM-DD.<br>Example: 2019-09-06
requestedShipment.shipper -- Type: object | Example: {'address': {'streetLines': ['Bldg. 10', '10 FedEx Parkway'], 'city': 'Collierville', 'stateOrProvinceCode': 'TN', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 'phoneExtension', 'companyName': 'Fedex', 'faxNumber': 'faxNumber'}, 'accountNumber': {'value': 'Your account number'}} | The shipper details, such as postal code, state or province code, and country code of the shipper.
requestedShipment.shipper.accountNumber -- Type: object | Example: {'value': '123456789'} | Specify the Account number. This is FedEx account number details.
requestedShipment.shipper.accountNumber.value -- Type: string | This is the account number. Max Length is 9. Example: Your account number
requestedShipment.shipper.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipper.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.shipper.address.countryCode -- Type: object | Example: US | This is a Two-letter country code.Max length is two.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.shipper.address.postalCode -- Type: object | Example: 38127 | This is the Postal code. This is Optional for non postal-aware countries. Max length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal awar...
requestedShipment.shipper.address.residential -- Type: boolean | Valid values: True, False | Indicate whether this address is Residential as opposed to Commercial.
requestedShipment.shipper.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code. <br> Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
requestedShipment.shipper.address.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
requestedShipment.shipper.address.streetLines[] -- Type: string
requestedShipment.shipper.contact -- Type: object | Indicate the contact details for this shipment.
requestedShipment.shipper.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Max length is 80.
requestedShipment.shipper.contact.faxNumber -- Type: string | Specify contact person's fax number. Max length is 15.
requestedShipment.shipper.contact.personName -- Type: string | Example: John Taylor | Specify contact name.Max Length is 70.
requestedShipment.shipper.contact.phoneExtension -- Type: string | Specify contact person's phone extension. Max length is 6.
requestedShipment.shipper.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact person's phone number. Max length is 15.
requestedShipment.shipper.deliveryInstructions -- Type: string | Example: Drop package at apartment Office | Optional. Provides delivery instructions.  MaxLength is 90.
requestedShipment.shipper.productInfo -- Type: object | Example: {'customsValueAndWeightSpecifiedAsUnit': True, 'quantity': 2, 'customsValue': 200, 'weightUnitOfMeasureCode': 'KG', 'description': 'Books', 'weight': {'units': 'KG', 'value': 68}, 'sedRequired': False, 'productType': 'COMMODITIES', 'unitOfMeasureCode': 'pieces', 'countryOfManufactureCode': 'CA'} | optional information aboutsender/recipient including Address, Contact, Account, TIN, DeliveryInstructions, Piece, ReferenceInfo, ProductInfo. Information about the contents of the shipment.
requestedShipment.shipper.productInfo.countryOfManufactureCode -- Type: string | Example: CA | Specify the country code of the product manufacturer.
requestedShipment.shipper.productInfo.customsValue -- Type: number | Example: 20 | Customs value of the product in the package/shipment.
requestedShipment.shipper.productInfo.customsValueAndWeightSpecifiedAsUnit -- Type: boolean | Example: True | The total value declared to the Bureau of Customs and Border Protection for all packages in the shipment along with the weight details.
requestedShipment.shipper.productInfo.description -- Type: string | Example: Books | Description of the product in the package/shipment.
requestedShipment.shipper.productInfo.productType -- Type: string | Valid values: DOCUMENTS, COMMODITIES | Example: COMMODITIES | Indicates the package/shipment contains documents or non-document commodities.
requestedShipment.shipper.productInfo.quantity -- Type: integer | Format: int32 | Example: 2 | Quantity of the product in the package/shipment.
requestedShipment.shipper.productInfo.sedRequired -- Type: boolean | Indicates if shippers export declaration is required or not.
requestedShipment.shipper.productInfo.unitOfMeasureCode -- Type: string | Example: pieces | Specifies if shippers export declaration is required.<br>Valid values: True, False.
requestedShipment.shipper.productInfo.weight -- Type: object | Example: {'units': 'LB', 'value': 10} | Describes the weight of the package/packageType. These are the weight details. Specify the total weight of the shipment. <br>This is only applies to International shipments and should be used on th...
requestedShipment.shipper.productInfo.weight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to weigh the shipment. The package and commodity weight unit should be the same else the request will result in an error. This is package weight type.<br> Examp...
requestedShipment.shipper.productInfo.weight.value -- Type: number | Format: double | Example: 10 | Specify the value of weight of shipment.<br>Example: 68.25 Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'...
requestedShipment.shipper.productInfo.weightUnitOfMeasureCode -- Type: string | Example: KG | Weight measurement unit code of the product in the package/shipment.
requestedShipment.shipper.referenceInfo -- Type: object | Example: {'regulatoryReferenceNumber': 'regulatoryReferenceNumber', 'yourReference': 'yourReference', 'countryCode': 'US', 'postalCode': '38654', 'purchaseOrderNumber': 789, 'departmentNumber': 456, 'invoiceNumber': 123, 'accountNbr': 'Your account number', 'shipDate': '2019-12-18', 'referenceValue': 'myref123'} | Customers configurable reference Information for the shipment
requestedShipment.shipper.referenceInfo.accountNbr -- Type: string | AccountNbr reference for the shipment
requestedShipment.shipper.referenceInfo.countryCode -- Type: string | Example: US | CountryCode of the ReferenceInfo
requestedShipment.shipper.referenceInfo.departmentNumber -- Type: string | Department Number reference for the shipment
requestedShipment.shipper.referenceInfo.invoiceNumber -- Type: string | Invoice Number reference for the shipment
requestedShipment.shipper.referenceInfo.postalCode -- Type: string | Example: 38654 | PostalCode of the ReferenceInfo
requestedShipment.shipper.referenceInfo.purchaseOrderNumber -- Type: string | Purchase Order Number reference for the shipment
requestedShipment.shipper.referenceInfo.referenceValue -- Type: string | Reference Value attached to the shipment
requestedShipment.shipper.referenceInfo.regulatoryReferenceNumber -- Type: string | Regulatory Reference Number for the shipment
requestedShipment.shipper.referenceInfo.shipDate -- Type: string | Example: 2019-12-29 | Ship Date for the shipment
requestedShipment.shipper.referenceInfo.yourReference -- Type: string | a customizable reference field for the shipment
requestedShipment.specialServicesRequested -- Type: object | Descriptive data regarding special services requested by the shipper for this shipment. These special services are available at the shipment level for some or all service types. Indicated if availa...
requestedShipment.specialServicesRequested.codDetail -- Type: object | Conditional <br> For Express-only COD, populate this object for COD detail information at the shipment level.  When data is provided in this object, the related COD enum will be populated automatic...
requestedShipment.specialServicesRequested.codDetail.codCollectionAmount -- Type: object | Example: {'currency': 'USD', 'amount': 100.5} | Optional, but if indicated 'amount' and 'currency' must be provided. Use this object to specify amount and currency details.
requestedShipment.specialServicesRequested.codDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Max length 18 including decimal.<br>Example: 12.45
requestedShipment.specialServicesRequested.codDetail.codCollectionAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("countrycodes")'>Click here to see Currency Codes</a>
requestedShipment.specialServicesRequested.codDetail.codCollectionType -- Type: string | Valid values: COMPANY_CHECK, ANY, CASH, GUARANTEED_FUNDS, PERSONAL_CHECK | Example: CASH | Identifies the type of funds FedEx should collect upon shipment delivery.
requestedShipment.specialServicesRequested.holdAtLocationDetail -- Type: object | Use this object to specify required information of a shipment to be held at FedEx destination location. <br><br><i>Note: This object HoldAtLocationDetail is <b>REQUIRED</b>, when HOLD_AT_LOCATION i...
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress -- Type: object | Example: {'contactAncillaryDetail': {'emailAddresses': [{'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}, {'emailNotificationFormatType': 'TEXT', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}], 'prefix': 'prefix', 'phoneNumberDetails': [{'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}, {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}], 'companyName': {'division': 'division', 'companyCd': 'companyCd', 'name': 'name', 'department': 'department', 'storeId': 'storeId'}, 'title': 'title'}, 'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}, 'addressAncillaryDetail': {'locationInCity': 'location in the city', 'suite': 'suite', 'locationInProperty': 'location in the property', 'addtionalDescriptions': 'addtional descriptions', 'department': 'department', 'roomFloor': 'room or floor', 'crossStreet': 'cross street', 'building': 'building', 'apartment': 'apartment', 'room': 'room', 'addressVerificationOverrideReason': 'CUSTOMER_PROVIDED_PROOF'}} | Specifies the contact and address details of a location.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.countryCode -- Type: object | Example: US | This is a Two-letter country code.Max length is two.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.postalCode -- Type: object | Example: 38127 | This is the Postal code. This is Optional for non postal-aware countries. Max length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal awar...
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.residential -- Type: boolean | Valid values: True, False | Indicate whether this address is Residential as opposed to Commercial.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code. <br> Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail -- Type: object | Example: {'locationInCity': 'Forester subdivision', 'suite': 'suite 201', 'addressVerificationOverrideReason': 'CUSTOMER_PROVIDED_PROOF', 'locationInProperty': 'south west of main office entrance', 'addtionalDescriptions': 'north door', 'department': 'Claims department', 'roomFloor': '5th floor', 'crossStreet': 'Union and Main', 'building': 'Building 300', 'apartment': 'Apartment 1503', 'room': 'Room B-23'} | specifies additional address details for the physical location
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.addressVerificationOverrideReason -- Type: string | Specifies the reason to override address verification.<br> Valid values:  CUSTOMER_PREFERENCE, CUSTOMER_PROVIDED_PROOF, MANUAL_VALIDATION
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.addtionalDescriptions -- Type: string | Specifies any additional information about the given address.<br>Example: north door
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.apartment -- Type: string | This is the apartment information for the given address.<br>Example: Apartment 1503
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.building -- Type: string | This is the building information for the given address.<br>Example: Building 300
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.crossStreet -- Type: string | This is the cross street information for the given address.<br>Example: Union and Main
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.department -- Type: string | This is the department for the given address.<br>Example: Claims department
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.locationInCity -- Type: string | This is the Subdivision or community within a city for the given address.<br> Forester subdivision
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.locationInProperty -- Type: string | This is location in a campus, such as exterior building annex A.<br> Example: south west of main office entrance.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.room -- Type: string | This is room specific information for the given address.<br>Example: Room B-23
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.roomFloor -- Type: string | This is to specify the room or floor information for the given address.<br>Example: 5th floor
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.suite -- Type: string | This is the suite information for the given address.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact -- Type: object | Indicate the contact details for this shipment.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Max length is 80.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact.faxNumber -- Type: string | Specify contact person's fax number. Max length is 15.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact name.Max Length is 70.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact.phoneExtension -- Type: string | Specify contact person's phone extension. Max length is 6.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact person's phone number. Max length is 15.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail -- Type: object | Example: {'emailAddresses': [{'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}, {'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}], 'prefix': 'prefix', 'phoneNumberDetails': [{'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}, {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}], 'companyName': {'division': 'division', 'companyCd': 'companyCd', 'name': 'name', 'department': 'department', 'storeId': 'storeId'}, 'title': 'title'} | Indicate additional contact details such as email and phone information.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName -- Type: object | Example: {'division': 'Research and Design', 'companyCd': 'ARMZD', 'name': 'Armor Co Incorporated', 'department': 'department', 'storeId': 'A1234'} | Use this to provide Company details.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName.companyCd -- Type: string | This is Company code.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName.department -- Type: string | This is department within a company
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName.division -- Type: string | This is division within a company.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName.name -- Type: string | This is company Name.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName.storeId -- Type: string | This is Store identifier within a company.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.emailAddresses -- Type: array | These are contact email addresses.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.emailAddresses[] -- Type: object | Example: {'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.emailAddresses[].address -- Type: string | This is the email address.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.emailAddresses[].emailNotificationFormatType -- Type: string | Valid values: TEXT, HTML | These are email notification format type.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.emailAddresses[].permissions -- Type: object | Indicate the Email Permission Type.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails -- Type: array | Phone Number Details
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[] -- Type: object | Example: {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number -- Type: object | Example: {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'} | A phone number for a party. Numeric only
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.areaCode -- Type: string | Indicate the Area Code for the phone number.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.countryCode -- Type: string | Example: US | The two-letter code used to identify a country.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.extension -- Type: string | Indicate the extension for the phone number.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.localNumber -- Type: string | Indicate the local phone number for contacting in the event of an emergency.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.personalIdentificationNumber -- Type: string | Indicate the Personal Identification Number associated with the phone number.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].permissions -- Type: object | This is to specify the phone permission.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].type -- Type: string | Valid values: FAX, HOME, MOBILE, PAGER, WORK | Indicate the Phone Number Type.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].usage -- Type: string | Valid values: PRIMARY, SECONDARY | Specify if the phone usage is Primary or Secondary.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.prefix -- Type: string | Specify the Prefix.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.title -- Type: string | Indicate the contact title.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationId -- Type: string | Example: YBZA | This is an alphanumeric identifier used for Location/Facility Identification.<br><br>Example: YBZA<br><br>Note: <i><ul><li>For HAL Shipment, Location ID is <b>REQUIRED</b> to ensure packages are de...
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationType -- Type: string | Valid values: FEDEX_AUTHORIZED_SHIP_CENTER, FEDEX_OFFICE, FEDEX_SELF_SERVICE_LOCATION, FEDEX_STAFFED, RETAIL_ALLICANCE_LOCATION, FEDEX_GROUND_TERMINAL, FEDEX_ONSITE, FEDEX_SHIP_AND_GET | Example: FEDEX_ONSITE | Type of facility at which package/shipment is to be held.<br> Example: FEDEX_ONSITE
requestedShipment.specialServicesRequested.homeDeliveryPremiumDetail -- Type: object | These are Special service elements for FedEx Ground Home Delivery shipments. If selected, element homedeliveryPremiumType is mandatory.
requestedShipment.specialServicesRequested.homeDeliveryPremiumDetail.homedeliveryPremiumType -- Type: string | Valid values: APPOINTMENT, DATE_CERTAIN, EVENING | Example: APPOINTMENT | This is Home Delivery Premium Type. It allows to specify additional premium service options for the home delivery shipment. Can specify Evening delivery or a Date certain, or can specify appointmen...
requestedShipment.specialServicesRequested.internationalControlledExportDetail -- Type: object | Use this object to specify International Controlled Export shipment Details.<br>Example: WAREHOUSE_WITHDRAWAL.
requestedShipment.specialServicesRequested.internationalControlledExportDetail.type -- Type: string | Valid values: DEA_036, DEA_236, DEA_486, DSP_05, DSP_61, DSP_73, DSP_85, DSP_94, DSP_LICENSE_AGREEMENT, FROM_FOREIGN_TRADE_ZONE, WAREHOUSE_WITHDRAWAL | Example: DEA_036 | Indicate International Controlled Export Type.
requestedShipment.specialServicesRequested.returnEmailDetail -- Type: object | These are Email details for the return shipment.
requestedShipment.specialServicesRequested.returnEmailDetail.allowedSpecialService -- Type: array | Example: ['SATURDAY_DELIVERY'] | Indicate the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created.<br>Only services represented in EmailLabelAllowedSpecialServiceType will b...
requestedShipment.specialServicesRequested.returnEmailDetail.allowedSpecialService[] -- Type: string | Valid values: SATURDAY_DELIVERY, SATURDAY_PICKUP
requestedShipment.specialServicesRequested.returnEmailDetail.merchantPhoneNumber -- Type: string | Example: 1234567890 | This is the merchant phone number. Is Required for Email Return Labels.<br>Example: 19012635656
requestedShipment.specialServicesRequested.returnShipmentDetail -- Type: object | Indicates the return shipment.
requestedShipment.specialServicesRequested.returnShipmentDetail.returnType -- Type: string | Valid values: FEDEX_TAG, NET_RETURN, PENDING, PRINT_RETURN_LABEL, EMAIL_LABEL, VOICE_CALL_TAG | Example: PENDING | 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 mu...
requestedShipment.specialServicesRequested.saturdayDeliveryDetail -- Type: object | These are service elements for Saturday Delivery special service.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': {'firstName': 'first name', 'lastName': 'last name', 'middleName': 'middle name', 'suffix': 'suffix'}, 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'companyName': 'company name', 'faxNumber': 'fax number', 'title': 'title'}} | These are contact and address details for this special service.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.countryCode -- Type: object | Example: US | This is a Two-letter country code.Max length is two.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.postalCode -- Type: object | Example: 38127 | This is the Postal code. This is Optional for non postal-aware countries. Max length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal awar...
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.residential -- Type: boolean | Valid values: True, False | Indicate whether this address is Residential as opposed to Commercial.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code. <br> Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact -- Type: object | Indicate the contact details for this shipment.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Max length is 80.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact.faxNumber -- Type: string | Specify contact person's fax number. Max length is 15.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact name.Max Length is 70.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact.phoneExtension -- Type: string | Specify contact person's phone extension. Max length is 6.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact person's phone number. Max length is 15.
requestedShipment.specialServicesRequested.shipmentDryIceDetail -- Type: object | This is the descriptive data required for the FedEx shipment containing dangerous materials. This element is required when SpecialServicetype DRY_ICE is selected in SpecialServicetype collection. N...
requestedShipment.specialServicesRequested.shipmentDryIceDetail.packageCount -- Type: integer | Format: int32 | Example: 12 | Indicates the total number of packages in the shipment that contain dry ice.<br>Example: 12
requestedShipment.specialServicesRequested.shipmentDryIceDetail.totalWeight -- Type: object | Example: {'units': 'LB', 'value': 10} | Specify the total weight of the shipment. <br>This is only applies to International shipments and should be used on the first package of a multiple piece shipment. This value contains 1 explicit de...
requestedShipment.specialServicesRequested.shipmentDryIceDetail.totalWeight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to weigh the shipment. The package and commodity weight unit should be the same else the request will result in an error. Identifies the unit of measure associa...
requestedShipment.specialServicesRequested.shipmentDryIceDetail.totalWeight.value -- Type: number | Format: double | Example: 10 | Specify the value of weight of shipment.<br>Example: 68.25 Identifies the weight <br> Example: 10.0
requestedShipment.specialServicesRequested.specialServiceTypes -- Type: array | Example: ['FEDEX_EXPRESS'] | Optional <br> The types of all special services requested for the enclosing shipment.<br> Example: FEDEX_EXPRESS<br><a onclick='loadDocReference("servicetypes")'>Click here to see Special Service T...
requestedShipment.specialServicesRequested.specialServiceTypes[] -- Type: string
systemOfMeasureType -- Type: string | Valid values: IMPERIAL, METRIC | Example: METRIC | This is system measurement type, such as Imperial or Metric.

Retrieve Special Service Options

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
accountNumber -- Type: object | Example: {'value': '123456789'} | Account number associated with a Payor object. Example: Your account number This is FedEx account number details.
accountNumber.value -- Type: string | This is the account number. Max Length is 9. Example: Your account number
carrierCodes -- Type: array | Example: ['FDXG', 'FDXE'] | Optionally supplied to restrict the results to services for a specific carrier. Valid values are: FDXE, FDXG, FXSP. <br> Example: ["FDXG", "FDXE"]
carrierCodes[] -- Type: string | Valid values: FDXE, FDXG, FXSP, FXFR
requestedShipment -- Type: object | The shipment details for which special service availability is requested. shipment information for the shipment being requested
requestedShipment.dropoffType -- Type: string | Valid values: REGULAR_PICKUP, REQUEST_COURIER, DROP_BOX, BUSINESS_SERVICE_CENTER, STATION | Example: DROP_BOX | Conditional <br> Required for Express and Ground, but optional for FREIGHT or SMARTPOST <br> Example: DROP_BOX
requestedShipment.freightShipmentDetail -- Type: object | Conditional<br> Required when using FEDEX_FREIGHT and FEDEX_NATIONAL_FREIGHT services or FXFR carrier code Conditional  Details specific to a FedEx Freight LTL shipment (i.e. FedEx Priority and Eco...
requestedShipment.freightShipmentDetail.aliasID -- Type: string | Example: 36839 | Conditional. <br> This is bill to alias identifier.
requestedShipment.freightShipmentDetail.alternateBilling -- Type: boolean | Valid values: True, False | Example: True | Optional : Designates a bill-to address <br> Example: true
requestedShipment.freightShipmentDetail.clientDiscountPercent -- Type: number | Format: double | Example: 10.5 | Conditional <br> This is only used for anonymous rate requests <br> Example: 10.5
requestedShipment.freightShipmentDetail.fedExFreightAccountNumber -- Type: object | Example: {'value': 'Your account number'} | Conditional  FedEx Freight account number used with FEDEX_FREIGHT or FEDEX_FREIGHT_PRIORITY service; required for account-specific Freight rates This is FedEx account number details.
requestedShipment.freightShipmentDetail.fedExFreightAccountNumber.value -- Type: string | This is the account number. Max Length is 9. Example: Your account number
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress -- Type: object | Example: {'contactAncillaryDetail': {'emailAddresses': [{'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}, {'emailNotificationFormatType': 'TEXT', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}], 'prefix': 'prefix', 'phoneNumberDetails': [{'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}, {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}], 'companyName': {'division': 'division', 'companyCd': 'companyCd', 'name': 'name', 'department': 'department', 'storeId': 'storeId'}, 'title': 'title'}, 'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}, 'addressAncillaryDetail': {'locationInCity': 'location in the city', 'suite': 'suite', 'locationInProperty': 'location in the property', 'addtionalDescriptions': 'addtional descriptions', 'department': 'department', 'roomFloor': 'room or floor', 'crossStreet': 'cross street', 'building': 'building', 'apartment': 'apartment', 'room': 'room', 'addressVerificationOverrideReason': 'CUSTOMER_PROVIDED_PROOF'}} | Conditional  Required if a FedEx Freight account number is specified Specifies the contact and address details of a location.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.countryCode -- Type: object | Example: US | This is a Two-letter country code.Max length is two.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.postalCode -- Type: object | Example: 38127 | This is the Postal code. This is Optional for non postal-aware countries. Max length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal awar...
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.residential -- Type: boolean | Valid values: True, False | Indicate whether this address is Residential as opposed to Commercial.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code. <br> Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail -- Type: object | Example: {'locationInCity': 'Forester subdivision', 'suite': 'suite 201', 'addressVerificationOverrideReason': 'CUSTOMER_PROVIDED_PROOF', 'locationInProperty': 'south west of main office entrance', 'addtionalDescriptions': 'north door', 'department': 'Claims department', 'roomFloor': '5th floor', 'crossStreet': 'Union and Main', 'building': 'Building 300', 'apartment': 'Apartment 1503', 'room': 'Room B-23'} | specifies additional address details for the physical location
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.addressVerificationOverrideReason -- Type: string | Specifies the reason to override address verification.<br> Valid values:  CUSTOMER_PREFERENCE, CUSTOMER_PROVIDED_PROOF, MANUAL_VALIDATION
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.addtionalDescriptions -- Type: string | Specifies any additional information about the given address.<br>Example: north door
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.apartment -- Type: string | This is the apartment information for the given address.<br>Example: Apartment 1503
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.building -- Type: string | This is the building information for the given address.<br>Example: Building 300
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.crossStreet -- Type: string | This is the cross street information for the given address.<br>Example: Union and Main
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.department -- Type: string | This is the department for the given address.<br>Example: Claims department
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.locationInCity -- Type: string | This is the Subdivision or community within a city for the given address.<br> Forester subdivision
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.locationInProperty -- Type: string | This is location in a campus, such as exterior building annex A.<br> Example: south west of main office entrance.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.room -- Type: string | This is room specific information for the given address.<br>Example: Room B-23
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.roomFloor -- Type: string | This is to specify the room or floor information for the given address.<br>Example: 5th floor
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.addressAncillaryDetail.suite -- Type: string | This is the suite information for the given address.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact -- Type: object | Indicate the contact details for this shipment. Billing contact information for FedEx Freight Shipment.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Max length is 80.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact.faxNumber -- Type: string | Specify contact person's fax number. Max length is 15.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact name.Max Length is 70.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact.phoneExtension -- Type: string | Specify contact person's phone extension. Max length is 6.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact person's phone number. Max length is 15.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail -- Type: object | Example: {'emailAddresses': [{'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}, {'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}], 'prefix': 'prefix', 'phoneNumberDetails': [{'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}, {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}], 'companyName': {'division': 'division', 'companyCd': 'companyCd', 'name': 'name', 'department': 'department', 'storeId': 'storeId'}, 'title': 'title'} | Indicate additional contact details such as email and phone information.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName -- Type: object | Example: {'division': 'Research and Design', 'companyCd': 'ARMZD', 'name': 'Armor Co Incorporated', 'department': 'department', 'storeId': 'A1234'} | Use this to provide Company details.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName.companyCd -- Type: string | This is Company code.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName.department -- Type: string | This is department within a company
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName.division -- Type: string | This is division within a company.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName.name -- Type: string | This is company Name.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.companyName.storeId -- Type: string | This is Store identifier within a company.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.emailAddresses -- Type: array | These are contact email addresses.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.emailAddresses[] -- Type: object | Example: {'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.emailAddresses[].address -- Type: string | This is the email address.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.emailAddresses[].emailNotificationFormatType -- Type: string | Valid values: TEXT, HTML | These are email notification format type.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.emailAddresses[].permissions -- Type: object | Indicate the Email Permission Type.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails -- Type: array | Phone Number Details
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[] -- Type: object | Example: {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number -- Type: object | Example: {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'} | A phone number for a party. Numeric only
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.areaCode -- Type: string | Indicate the Area Code for the phone number.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.countryCode -- Type: string | Example: US | The two-letter code used to identify a country.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.extension -- Type: string | Indicate the extension for the phone number.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.localNumber -- Type: string | Indicate the local phone number for contacting in the event of an emergency.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.personalIdentificationNumber -- Type: string | Indicate the Personal Identification Number associated with the phone number.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].permissions -- Type: object | This is to specify the phone permission.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].type -- Type: string | Valid values: FAX, HOME, MOBILE, PAGER, WORK | Indicate the Phone Number Type.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].usage -- Type: string | Valid values: PRIMARY, SECONDARY | Specify if the phone usage is Primary or Secondary.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.prefix -- Type: string | Specify the Prefix.
requestedShipment.freightShipmentDetail.fedExFreightBillingContactAndAddress.contactAncillaryDetail.title -- Type: string | Indicate the contact title.
requestedShipment.freightShipmentDetail.liabilityCoverageDetail -- Type: object | Specifies the Liability Coverage detail for Freight Shipment. This is used specify the line item level liability coverage.
requestedShipment.freightShipmentDetail.liabilityCoverageDetail.coverageAmount -- Type: object | Specifies the Liability Coverage Amount & Currency used for Freight Shipment. Optional, but if indicated 'amount' and 'currency' must be provided.
requestedShipment.freightShipmentDetail.liabilityCoverageDetail.coverageAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Max length 18 including decimal.<br>Example: 12.45
requestedShipment.freightShipmentDetail.liabilityCoverageDetail.coverageAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("countrycodes")'>Click here to see Currency Codes</a>
requestedShipment.freightShipmentDetail.liabilityCoverageDetail.coverageType -- Type: string | Valid values: NEW, USED_OR_RECONDITIONED | Optional  This is the liability coverage type.
requestedShipment.freightShipmentDetail.lineItem -- Type: array | Required  Class/weight pairs and associated details for a Freight shipment
requestedShipment.freightShipmentDetail.lineItem[] -- Type: object | Description of an individual commodity or class of content in a shipment.
requestedShipment.freightShipmentDetail.lineItem[].classProvidedByCustomer -- Type: boolean | Example: True | defaults to false. FEDEX INTERNAL USE ONLY for FedEx system that estimate freight class from customer-provided dimensions and weight <br> Example: true
requestedShipment.freightShipmentDetail.lineItem[].description -- Type: string | Example: Description | Customer-provided description of this line item <br> Example: Description
requestedShipment.freightShipmentDetail.lineItem[].dimensions -- Type: object | Example: {'length': 100, 'width': 50, 'height': 30, 'units': 'CM'} | Individual line item dimensions. Conditionally required. Need volume for intra mexico rates. Indicate the dimensions of the package. <br>Following conditions will apply: <ul><li>Dimensions are opti...
requestedShipment.freightShipmentDetail.lineItem[].dimensions.height -- Type: integer | Format: int32 | Example: 30 | Indicate the height of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.freightShipmentDetail.lineItem[].dimensions.length -- Type: integer | Format: int32 | Example: 100 | Indicate the length of the package. No implied decimal places. Maximum value: 999 <br> Example: 20
requestedShipment.freightShipmentDetail.lineItem[].dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Indicate the Unit of measure for the provided dimensions.<br>Valid Values are:<ul><li>IN - inches</li><li>CM - centimeters</li><br>Note: Any value other than CM including blank/null will default to...
requestedShipment.freightShipmentDetail.lineItem[].dimensions.width -- Type: integer | Format: int32 | Example: 50 | Indicate the width of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.freightShipmentDetail.lineItem[].freightClass -- Type: string | Valid values: CLASS_050, CLASS_055, CLASS_060, CLASS_065, CLASS_070, CLASS_077_5, CLASS_085, CLASS_092_5, CLASS_100, CLASS_110, CLASS_125, CLASS_150, CLASS_175, CLASS_200, CLASS_250, CLASS_300, CLASS_400, CLASS_500 | Example: CLASS_050 | Specify the freight class based on the item to be shipped and its weight measured per unit volume(Example: Kilograms per Cubic Meter) the shipment is categorized accordingly.<a href='http://www.fed...
requestedShipment.freightShipmentDetail.lineItem[].handlingUnits -- Type: integer | Format: int32 | Example: 1 | Optional<br>Number of individual handling units to which this line applies. (NOTE - Total of line-item-level handling units may not balance to shipment-level total handling units) <br> Example: 1
requestedShipment.freightShipmentDetail.lineItem[].hazardousMaterials -- Type: string | Valid values: HAZARDOUS_MATERIALS, BATTERY, ORM_D, REPORTABLE_QUANTITIES, SMALL_QUANTITY_EXCEPTION, LIMITED_QUANTITIES_COMMODITIES | Example: HAZARDOUS_MATERIALS | Indicates the kind of hazardous material content in this line item <br> Example: HAZARDOUS_MATERIALS
requestedShipment.freightShipmentDetail.lineItem[].packaging -- Type: string | Example: SELFPACKAGE | Packaging type for this line item <br> Example: SELFPACKAGE
requestedShipment.freightShipmentDetail.lineItem[].pieces -- Type: integer | Format: int32 | Example: 1 | Optional <br> Total number of pieces <br> Example: 1
requestedShipment.freightShipmentDetail.lineItem[].volume -- Type: object | Example: {'units': 'CUBIC_FT', 'value': 9.965781217890562} | Individual line item volume. <br>                Conditionally required. <br> Need volume for intra mexico rates Optional  Individual line item volume.  Conditional  Need Volume or Rate for intra m...
requestedShipment.freightShipmentDetail.lineItem[].volume.units -- Type: string | Valid values: CUBIC_FT, CUBIC_M | Example: CUBIC_FT | The unit is in Cubic Feet or Cubic Meters. <br> Example: CUBIC_FT
requestedShipment.freightShipmentDetail.lineItem[].volume.value -- Type: number | Format: double | Example: 9.965781217890562 | The amount of volume. <br> Example: 9.965781217890562
requestedShipment.freightShipmentDetail.lineItem[].weight -- Type: object | Example: {'units': 'LB', 'value': 10} | Total weight of items for this line item These are the weight details. Specify the total weight of the shipment. <br>This is only applies to International shipments and should be used on the first ...
requestedShipment.freightShipmentDetail.lineItem[].weight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to weigh the shipment. The package and commodity weight unit should be the same else the request will result in an error. This is package weight type.<br> Examp...
requestedShipment.freightShipmentDetail.lineItem[].weight.value -- Type: number | Format: double | Example: 10 | Specify the value of weight of shipment.<br>Example: 68.25 Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'...
requestedShipment.freightShipmentDetail.role -- Type: string | Valid values: CONSIGNEE, SHIPPER | Example: SHIPPER | Required <br> Indicates the role of the party submitting the transaction <br> Example: SHIPPER
requestedShipment.freightShipmentDetail.shipmentDimensions -- Type: object | Example: {'length': 100, 'width': 50, 'height': 30, 'units': 'CM'} | Optional  Overall Shipment Dimensions Value Indicate the dimensions of the package.<br> Following conditions will apply: <ul><li>Dimensions are optional but when added, then all three dimensions mu...
requestedShipment.freightShipmentDetail.shipmentDimensions.height -- Type: integer | Format: int32 | Example: 30 | Indicate the height of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.freightShipmentDetail.shipmentDimensions.length -- Type: integer | Format: int32 | Example: 100 | Indicate the length of the package. No implied decimal places. Maximum value: 999 <br> Example: 20
requestedShipment.freightShipmentDetail.shipmentDimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Indicate the Unit of measure for the provided dimensions.<br>Valid Values are:<ul><li>IN - inches</li><li>CM - centimeters</li><br>Note: Any value other than CM including blank/null will default to...
requestedShipment.freightShipmentDetail.shipmentDimensions.width -- Type: integer | Format: int32 | Example: 50 | Indicate the width of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.freightShipmentDetail.totalHandlingUnits -- Type: integer | Format: int32 | Optional  Total number of individual handling units in the entire shipment (for unit pricing). May not be negative
requestedShipment.packagingType -- Type: string | Example: FEDEX_BOX | Specifies packaging Type.<br><a onclick='loadDocReference("packagetypes")'>Click here to see Package Types</a>
requestedShipment.pickupType -- Type: string | Valid values: CONTACT_FEDEX_TO_SCHEDULE, DROPOFF_AT_FEDEX_LOCATION, USE_SCHEDULED_PICKUP | Example: DROPOFF_AT_FEDEX_LOCATION | Indicate the pickup type method by which the shipment to be tendered to FedEx.<br><i>Note: The value of this element does not specify dispatching the courier for package pickup.</i><br><a onclick='...
requestedShipment.recipient -- Type: object | Example: {'address': {'streetLines': ['Bldg. 10', '10 FedEx Parkway'], 'city': 'Collierville', 'stateOrProvinceCode': 'TN', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Ryan Taylor', 'emailAddress': 'sample@fedex.com', 'phoneNumber': '1234567890', 'phoneExtension': '91', 'companyName': 'Fedex', 'faxNumber': '123456789'}, 'accountNumber': {'value': '123456789'}} | Specifies the recipient details, such as postal code, state or province code, and country code of the recipient. Note: At least one recipient is required. optional information about sender/recipien...
requestedShipment.recipient.accountNumber -- Type: object | Example: {'value': '123456789'} | Specify the Account number. This is FedEx account number details.
requestedShipment.recipient.accountNumber.value -- Type: string | This is the account number. Max Length is 9. Example: Your account number
requestedShipment.recipient.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.recipient.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.recipient.address.countryCode -- Type: object | Example: US | This is a Two-letter country code.Max length is two.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.recipient.address.postalCode -- Type: object | Example: 38127 | This is the Postal code. This is Optional for non postal-aware countries. Max length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal awar...
requestedShipment.recipient.address.residential -- Type: boolean | Valid values: True, False | Indicate whether this address is Residential as opposed to Commercial.
requestedShipment.recipient.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code. <br> Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
requestedShipment.recipient.address.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
requestedShipment.recipient.address.streetLines[] -- Type: string
requestedShipment.recipient.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Contact details for the Party such as Name, Email, PhoneNumber
requestedShipment.recipient.contact.companyName -- Type: string | Example: Fedex | Specify contact person's company name. Max length is 35.<br>Example: FedEx
requestedShipment.recipient.contact.emailAddress -- Type: string | Example: sample@company.com | Contact person's email address. Max length is 80.<br>Example: sample@company.com
requestedShipment.recipient.contact.faxNumber -- Type: string | Example: 956123 | Contact person's fax number. Max length is 15.<br>Example: 956123
requestedShipment.recipient.contact.personName -- Type: string | Example: John Taylor | Specify the recipient contact person's name. Max Length is 70.<br>Example: John Taylor
requestedShipment.recipient.contact.phoneExtension -- Type: string | Example: 91 | contact person's phone extension. Max length is 6.<br>Example: 91
requestedShipment.recipient.contact.phoneNumber -- Type: string | Example: 1234567890 | Contact person's phone number. Max length is 15.<br>Example: 1234567890
requestedShipment.requestedPackageLineItems -- Type: array | Conditional.<br>Specifies the packaging type, weight, and dimensions of the package.  Applicable for  EXPRESS and GROUND but not for FREIGHT shipments.
requestedShipment.requestedPackageLineItems[] -- Type: object
requestedShipment.requestedPackageLineItems[].contentRecord -- Type: object | Specify in details the contents of the package. package/shipment content details
requestedShipment.requestedPackageLineItems[].contentRecord.description -- Type: string | Example: This is the part number. | This is the description of the package item.
requestedShipment.requestedPackageLineItems[].contentRecord.itemNumber -- Type: string | Example: 45673289 | This is a package item number.<br> Example: 45673289
requestedShipment.requestedPackageLineItems[].contentRecord.partNumber -- Type: string | Example: 123 | This is the part Number <br> Example: 123
requestedShipment.requestedPackageLineItems[].contentRecord.receivedQuantity -- Type: integer | Format: int32 | Example: 2 | This is the package item quantity.<br> Example: 2
requestedShipment.requestedPackageLineItems[].customerReferences -- Type: array | These are additional customer reference data for commercial invoice.
requestedShipment.requestedPackageLineItems[].customerReferences[] -- Type: object
requestedShipment.requestedPackageLineItems[].customerReferences[].customerReferenceType -- Type: string | Valid values: BILL_OF_LADING, CUSTOMER_REFERENCE, DEPARTMENT_NUMBER, INVOICE_NUMBER, P_O_NUMBER, SHIPMENT_INTEGRITY, INTRACOUNTRY_REGULATORY_REFERENCE, STORE_NUMBER, RMA_ASSOCIATION, SHIPPER_ID1, SHIPPER_ID2 | Example: DEPARTMENT_NUMBER | This is a customer reference type. Note: Use type as RMA_ASSOCIATION and value as the RMA Number to associate Ground Call Tag shipments to the outbound shipment.<br><a onclick='loadDocReference("cu...
requestedShipment.requestedPackageLineItems[].customerReferences[].value -- Type: string | Example: 3686 | This is a customer reference type value.<br>Example: 3686
requestedShipment.requestedPackageLineItems[].declaredValue -- Type: object | This is the Declared Value represents FedEx maximum liability in connection with a shipment of that Package, including but not limited to, any loss, damage, delay, misdelivery, any failure to provi...
requestedShipment.requestedPackageLineItems[].declaredValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Max length 18 including decimal.<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].declaredValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("countrycodes")'>Click here to see Currency Codes</a>
requestedShipment.requestedPackageLineItems[].dimensions -- Type: object | Example: {'length': 100, 'width': 50, 'height': 30, 'units': 'CM'} | Indicate the dimensions of the package. <br>Following conditions will apply: <ul><li>Dimensions are optional but when added, then all three dimensions must be indicated.</li><li>Dimensions are requ...
requestedShipment.requestedPackageLineItems[].dimensions.height -- Type: integer | Format: int32 | Example: 30 | Indicate the height of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].dimensions.length -- Type: integer | Format: int32 | Example: 100 | Indicate the length of the package. No implied decimal places. Maximum value: 999 <br> Example: 20
requestedShipment.requestedPackageLineItems[].dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Indicate the Unit of measure for the provided dimensions.<br>Valid Values are:<ul><li>IN - inches</li><li>CM - centimeters</li><br>Note: Any value other than CM including blank/null will default to...
requestedShipment.requestedPackageLineItems[].dimensions.width -- Type: integer | Format: int32 | Example: 50 | Indicate the width of the package. No implied decimal places. Maximum value: 999 <br> Example: 10
requestedShipment.requestedPackageLineItems[].groupPackageCount -- Type: integer | Format: int32 | Indicate the grouped package count. These are number of identical package(s) each with one or more commodities. <br> Example: 2
requestedShipment.requestedPackageLineItems[].itemDescriptionForClearance -- Type: string | Example: Item Description for Clearence | Describe the content of the package for customs clearance purposes. This applies to intra-UAE, intra-Columbia and intra-Brazil shipments.
requestedShipment.requestedPackageLineItems[].packageSpecialServices -- Type: object | These are special services that are available at the package level for some or all service types.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail -- Type: object | These are details for the package containing alcohol. This is required for alcohol special service. The alcoholRecipientType is required.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.alcoholRecipientType -- Type: string | Valid values: LICENSEE, CONSUMER | Example: LICENSEE | Specify the Alcohol Recipient Type of the shipment. <br> Example: <br> <ul><li>LICENSEE- FedEx approved alchol shipper having appropriate licenses. </li><li> CONSUMER- Individual consumer to whom t...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.shipperAgreementType -- Type: string | Example: Retailer | Specify the type of entity, the shipper for alcohol shipment is registered such as fulfillment house, retailer or a winery.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails -- Type: array | Indicates the battery details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[] -- Type: object | Provide details about the batteries or cells that are contained within this specific package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryMaterialType -- Type: string | Valid values: LITHIUM_METAL, LITHIUM_ION | Example: LITHIUM_METAL | Indicate the material composition of the battery or cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryPackingType -- Type: string | Valid values: CONTAINED_IN_EQUIPMENT, PACKED_WITH_EQUIPMENT | Example: CONTAINED_IN_EQUIPMENT | Describe the packing arrangement of the battery or cell with respect to other items within the same package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails[].batteryRegulatoryType -- Type: string | Valid values: IATA_SECTION_II | Example: IATA_SECTION_II | This is a regulation specific classification for the battery or the cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail -- Type: object | For Ground-only COD, populate this object for COD detail information at the package level. Conditional <br> For Express-only COD, populate this object for COD detail information at the shipment lev...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail.codCollectionAmount -- Type: object | Example: {'currency': 'USD', 'amount': 100.5} | Optional, but if indicated 'amount' and 'currency' must be provided. Use this object to specify amount and currency details.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Max length 18 including decimal.<br>Example: 12.45
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail.codCollectionAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("countrycodes")'>Click here to see Currency Codes</a>
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail.codCollectionType -- Type: string | Valid values: COMPANY_CHECK, ANY, CASH, GUARANTEED_FUNDS, PERSONAL_CHECK | Example: CASH | Identifies the type of funds FedEx should collect upon shipment delivery.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail -- Type: object | Use this object to provide Dangerous Goods Detail in the shipment.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.accessibility -- Type: string | Valid values: ACCESSIBLE, INACCESSIBLE | Example: ACCESSIBLE | Specify the Dangerous Goods Accessibility Type. Valid Values: <ul><li>INACCESSIBLE - It does not have to be accessible on the aircraft.</li><li>ACCESSIBLE - It must be fully accessible on the aircr...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options -- Type: array | Example: ['HAZARDOUS_MATERIALS', 'LIMITED_QUANTITIES_COMMODITIES'] | Indicate the kind of content being reported.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options[] -- Type: string | Valid values: HAZARDOUS_MATERIALS, BATTERY, ORM_D, REPORTABLE_QUANTITIES, SMALL_QUANTITY_EXCEPTION, LIMITED_QUANTITIES_COMMODITIES
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight -- Type: object | Example: {'units': 'LB', 'value': 10} | These are the weight details. Specify the total weight of the shipment. <br>This is only applies to International shipments and should be used on the first package of a multiple piece shipment. Thi...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to weigh the shipment. The package and commodity weight unit should be the same else the request will result in an error. This is package weight type.<br> Examp...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.value -- Type: number | Format: double | Example: 10 | Specify the value of weight of shipment.<br>Example: 68.25 Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.pieceCountVerificationBoxCount -- Type: integer | Format: int32 | Specify the count.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionDetail -- Type: object | These Signature option details.Required  if SignatureOptions is indicated.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionDetail.signatureReleaseNumber -- Type: string | Example: TX64739DL7564 | This is the release number. Required if signature option is NO_SIGNATURE_REQUIRED.<br> Example: 23456
requestedShipment.requestedPackageLineItems[].packageSpecialServices.signatureOptionType -- Type: string | Valid values: SERVICE_DEFAULT, NO_SIGNATURE_REQUIRED, INDIRECT, DIRECT, ADULT | Example: NO_SIGNATURE_REQUIRED | Indicate the Signature Type.<br>Valid Values:<ul><li>ADULT - Adult signature required, at recipient address.</li><li>DIRECT - Signature required, at recipient address.</li><li>INDIRECT - Signature ...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes -- Type: array | Example: ['BATTERY', 'DANGEROUS_GOODS'] | Special services requested for the shipment.<br>Example: <ul><li>RETURN_SHIPMENT</li><li>BROKER_SELECT_OPTION</li><li>CALL_BEFORE_DELIVERY</li><li>COD</li><li>CUSTOM_DELIVERY_WINDOW</li></ul><a onc...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes[] -- Type: string
requestedShipment.requestedPackageLineItems[].physicalPackaging -- Type: string | Example: FEDEX_ENVELOPE | Specify the packaging used.<br>Example: FEDEX_PAK<br><a onclick='loadDocReference("packagetypes")'>Click here to see Package Types</a>
requestedShipment.requestedPackageLineItems[].weight -- Type: object | Example: {'units': 'LB', 'value': 10} | These are the weight details. Specify the total weight of the shipment. <br>This is only applies to International shipments and should be used on the first package of a multiple piece shipment. Thi...
requestedShipment.requestedPackageLineItems[].weight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to weigh the shipment. The package and commodity weight unit should be the same else the request will result in an error. This is package weight type.<br> Examp...
requestedShipment.requestedPackageLineItems[].weight.value -- Type: number | Format: double | Example: 10 | Specify the value of weight of shipment.<br>Example: 68.25 Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'...
requestedShipment.serviceType -- Type: string | Example: STANDARD_OVERNIGHT | Indicate the FedEx service type used for the shipment. The result will be filtered by the serviceType value indicated.If a serviceType is not indicated, then all the applicable services and corresp...
requestedShipment.shipDateStamp -- Type: string | Example: 2020-10-13T11:00:00TZD | Conditional. Used to filter results to a specific ship date if populated on the request. Value will be defaulted to the current date/time.  Format: [YYYY-MM-DDThh:mm:ssTZD] <br>Example: 2020-10-13T...
requestedShipment.shipper -- Type: object | Example: {'address': {'streetLines': ['Bldg. 10', '10 FedEx Parkway'], 'city': 'Collierville', 'stateOrProvinceCode': 'TN', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'John Ryan Taylor', 'emailAddress': 'sample@fedex.com', 'phoneNumber': '1234567890', 'phoneExtension': '91', 'companyName': 'Fedex', 'faxNumber': '123456789'}, 'accountNumber': {'value': '123456789'}} | Required. <br>Indicate the Shipper contact details for this shipment. optional information about sender/recipient including Address, Contact, Account number.
requestedShipment.shipper.accountNumber -- Type: object | Example: {'value': '123456789'} | Specify the Account number. This is FedEx account number details.
requestedShipment.shipper.accountNumber.value -- Type: string | This is the account number. Max Length is 9. Example: Your account number
requestedShipment.shipper.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.shipper.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.shipper.address.countryCode -- Type: object | Example: US | This is a Two-letter country code.Max length is two.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.shipper.address.postalCode -- Type: object | Example: 38127 | This is the Postal code. This is Optional for non postal-aware countries. Max length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal awar...
requestedShipment.shipper.address.residential -- Type: boolean | Valid values: True, False | Indicate whether this address is Residential as opposed to Commercial.
requestedShipment.shipper.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code. <br> Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
requestedShipment.shipper.address.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
requestedShipment.shipper.address.streetLines[] -- Type: string
requestedShipment.shipper.contact -- Type: object | Example: {'personName': 'John Taylor', 'emailAddress': 'sample@company.com', 'phoneNumber': '1234567890', 'phoneExtension': 1234, 'faxNumber': '1234567890', 'companyName': 'Fedex'} | Contact details for the Party such as Name, Email, PhoneNumber
requestedShipment.shipper.contact.companyName -- Type: string | Example: Fedex | Specify contact person's company name. Max length is 35.<br>Example: FedEx
requestedShipment.shipper.contact.emailAddress -- Type: string | Example: sample@company.com | Contact person's email address. Max length is 80.<br>Example: sample@company.com
requestedShipment.shipper.contact.faxNumber -- Type: string | Example: 956123 | Contact person's fax number. Max length is 15.<br>Example: 956123
requestedShipment.shipper.contact.personName -- Type: string | Example: John Taylor | Specify the recipient contact person's name. Max Length is 70.<br>Example: John Taylor
requestedShipment.shipper.contact.phoneExtension -- Type: string | Example: 91 | contact person's phone extension. Max length is 6.<br>Example: 91
requestedShipment.shipper.contact.phoneNumber -- Type: string | Example: 1234567890 | Contact person's phone number. Max length is 15.<br>Example: 1234567890
requestedShipment.shippingDocumentSpecification -- Type: string | Example: shippingDocumentSpecification | Shipping Document Specification Details
requestedShipment.specialServicesRequested -- Type: object | Descriptive data regarding special services requested by the shipper for this shipment. These special services are available at the shipment level for some or all service types. Indicated if availa...
requestedShipment.specialServicesRequested.codDetail -- Type: object | Conditional <br> For Express-only COD, populate this object for COD detail information at the shipment level.  When data is provided in this object, the related COD enum will be populated automatic...
requestedShipment.specialServicesRequested.codDetail.codCollectionAmount -- Type: object | Example: {'currency': 'USD', 'amount': 100.5} | Optional, but if indicated 'amount' and 'currency' must be provided. Use this object to specify amount and currency details.
requestedShipment.specialServicesRequested.codDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Max length 18 including decimal.<br>Example: 12.45
requestedShipment.specialServicesRequested.codDetail.codCollectionAmount.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("countrycodes")'>Click here to see Currency Codes</a>
requestedShipment.specialServicesRequested.codDetail.codCollectionType -- Type: string | Valid values: COMPANY_CHECK, ANY, CASH, GUARANTEED_FUNDS, PERSONAL_CHECK | Example: CASH | Identifies the type of funds FedEx should collect upon shipment delivery.
requestedShipment.specialServicesRequested.holdAtLocationDetail -- Type: object | Use this object to specify required information of a shipment to be held at FedEx destination location. <br><br><i>Note: This object HoldAtLocationDetail is <b>REQUIRED</b>, when HOLD_AT_LOCATION i...
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress -- Type: object | Example: {'contactAncillaryDetail': {'emailAddresses': [{'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}, {'emailNotificationFormatType': 'TEXT', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}], 'prefix': 'prefix', 'phoneNumberDetails': [{'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}, {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}], 'companyName': {'division': 'division', 'companyCd': 'companyCd', 'name': 'name', 'department': 'department', 'storeId': 'storeId'}, 'title': 'title'}, 'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': 'person name', 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'phoneExtension': 'phone extension', 'companyName': 'company name', 'faxNumber': 'fax number'}, 'addressAncillaryDetail': {'locationInCity': 'location in the city', 'suite': 'suite', 'locationInProperty': 'location in the property', 'addtionalDescriptions': 'addtional descriptions', 'department': 'department', 'roomFloor': 'room or floor', 'crossStreet': 'cross street', 'building': 'building', 'apartment': 'apartment', 'room': 'room', 'addressVerificationOverrideReason': 'CUSTOMER_PROVIDED_PROOF'}} | Specifies the contact and address details of a location.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.countryCode -- Type: object | Example: US | This is a Two-letter country code.Max length is two.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.postalCode -- Type: object | Example: 38127 | This is the Postal code. This is Optional for non postal-aware countries. Max length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal awar...
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.residential -- Type: boolean | Valid values: True, False | Indicate whether this address is Residential as opposed to Commercial.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code. <br> Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail -- Type: object | Example: {'locationInCity': 'Forester subdivision', 'suite': 'suite 201', 'addressVerificationOverrideReason': 'CUSTOMER_PROVIDED_PROOF', 'locationInProperty': 'south west of main office entrance', 'addtionalDescriptions': 'north door', 'department': 'Claims department', 'roomFloor': '5th floor', 'crossStreet': 'Union and Main', 'building': 'Building 300', 'apartment': 'Apartment 1503', 'room': 'Room B-23'} | specifies additional address details for the physical location
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.addressVerificationOverrideReason -- Type: string | Specifies the reason to override address verification.<br> Valid values:  CUSTOMER_PREFERENCE, CUSTOMER_PROVIDED_PROOF, MANUAL_VALIDATION
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.addtionalDescriptions -- Type: string | Specifies any additional information about the given address.<br>Example: north door
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.apartment -- Type: string | This is the apartment information for the given address.<br>Example: Apartment 1503
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.building -- Type: string | This is the building information for the given address.<br>Example: Building 300
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.crossStreet -- Type: string | This is the cross street information for the given address.<br>Example: Union and Main
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.department -- Type: string | This is the department for the given address.<br>Example: Claims department
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.locationInCity -- Type: string | This is the Subdivision or community within a city for the given address.<br> Forester subdivision
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.locationInProperty -- Type: string | This is location in a campus, such as exterior building annex A.<br> Example: south west of main office entrance.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.room -- Type: string | This is room specific information for the given address.<br>Example: Room B-23
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.roomFloor -- Type: string | This is to specify the room or floor information for the given address.<br>Example: 5th floor
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.addressAncillaryDetail.suite -- Type: string | This is the suite information for the given address.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact -- Type: object | Indicate the contact details for this shipment.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Max length is 80.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact.faxNumber -- Type: string | Specify contact person's fax number. Max length is 15.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact name.Max Length is 70.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact.phoneExtension -- Type: string | Specify contact person's phone extension. Max length is 6.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact person's phone number. Max length is 15.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail -- Type: object | Example: {'emailAddresses': [{'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}, {'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}], 'prefix': 'prefix', 'phoneNumberDetails': [{'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}, {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}], 'companyName': {'division': 'division', 'companyCd': 'companyCd', 'name': 'name', 'department': 'department', 'storeId': 'storeId'}, 'title': 'title'} | Indicate additional contact details such as email and phone information.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName -- Type: object | Example: {'division': 'Research and Design', 'companyCd': 'ARMZD', 'name': 'Armor Co Incorporated', 'department': 'department', 'storeId': 'A1234'} | Use this to provide Company details.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName.companyCd -- Type: string | This is Company code.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName.department -- Type: string | This is department within a company
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName.division -- Type: string | This is division within a company.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName.name -- Type: string | This is company Name.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.companyName.storeId -- Type: string | This is Store identifier within a company.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.emailAddresses -- Type: array | These are contact email addresses.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.emailAddresses[] -- Type: object | Example: {'emailNotificationFormatType': 'EMAIL', 'address': 'address', 'permissions': {'EMAIL': 'GRANT'}}
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.emailAddresses[].address -- Type: string | This is the email address.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.emailAddresses[].emailNotificationFormatType -- Type: string | Valid values: TEXT, HTML | These are email notification format type.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.emailAddresses[].permissions -- Type: object | Indicate the Email Permission Type.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails -- Type: array | Phone Number Details
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[] -- Type: object | Example: {'number': {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'}, 'permissions': {'CALL': 'GRANT'}, 'usage': 'PRIMARY', 'type': 'FAX'}
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number -- Type: object | Example: {'areaCode': 'areaCode', 'extension': 'extension', 'countryCode': 'countryCode', 'personalIdentificationNumber': 'personalIdentificationNumber', 'localNumber': 'localNumber'} | A phone number for a party. Numeric only
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.areaCode -- Type: string | Indicate the Area Code for the phone number.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.countryCode -- Type: string | Example: US | The two-letter code used to identify a country.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.extension -- Type: string | Indicate the extension for the phone number.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.localNumber -- Type: string | Indicate the local phone number for contacting in the event of an emergency.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].number.personalIdentificationNumber -- Type: string | Indicate the Personal Identification Number associated with the phone number.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].permissions -- Type: object | This is to specify the phone permission.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].type -- Type: string | Valid values: FAX, HOME, MOBILE, PAGER, WORK | Indicate the Phone Number Type.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.phoneNumberDetails[].usage -- Type: string | Valid values: PRIMARY, SECONDARY | Specify if the phone usage is Primary or Secondary.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.prefix -- Type: string | Specify the Prefix.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationContactAndAddress.contactAncillaryDetail.title -- Type: string | Indicate the contact title.
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationId -- Type: string | Example: YBZA | This is an alphanumeric identifier used for Location/Facility Identification.<br><br>Example: YBZA<br><br>Note: <i><ul><li>For HAL Shipment, Location ID is <b>REQUIRED</b> to ensure packages are de...
requestedShipment.specialServicesRequested.holdAtLocationDetail.locationType -- Type: string | Valid values: FEDEX_AUTHORIZED_SHIP_CENTER, FEDEX_OFFICE, FEDEX_SELF_SERVICE_LOCATION, FEDEX_STAFFED, RETAIL_ALLICANCE_LOCATION, FEDEX_GROUND_TERMINAL, FEDEX_ONSITE, FEDEX_SHIP_AND_GET | Example: FEDEX_ONSITE | Type of facility at which package/shipment is to be held.<br> Example: FEDEX_ONSITE
requestedShipment.specialServicesRequested.homeDeliveryPremiumDetail -- Type: object | These are Special service elements for FedEx Ground Home Delivery shipments. If selected, element homedeliveryPremiumType is mandatory.
requestedShipment.specialServicesRequested.homeDeliveryPremiumDetail.homedeliveryPremiumType -- Type: string | Valid values: APPOINTMENT, DATE_CERTAIN, EVENING | Example: APPOINTMENT | This is Home Delivery Premium Type. It allows to specify additional premium service options for the home delivery shipment. Can specify Evening delivery or a Date certain, or can specify appointmen...
requestedShipment.specialServicesRequested.internationalControlledExportDetail -- Type: object | Use this object to specify International Controlled Export shipment Details.<br>Example: WAREHOUSE_WITHDRAWAL.
requestedShipment.specialServicesRequested.internationalControlledExportDetail.type -- Type: string | Valid values: DEA_036, DEA_236, DEA_486, DSP_05, DSP_61, DSP_73, DSP_85, DSP_94, DSP_LICENSE_AGREEMENT, FROM_FOREIGN_TRADE_ZONE, WAREHOUSE_WITHDRAWAL | Example: DEA_036 | Indicate International Controlled Export Type.
requestedShipment.specialServicesRequested.returnEmailDetail -- Type: object | These are Email details for the return shipment.
requestedShipment.specialServicesRequested.returnEmailDetail.allowedSpecialService -- Type: array | Example: ['SATURDAY_DELIVERY'] | Indicate the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created.<br>Only services represented in EmailLabelAllowedSpecialServiceType will b...
requestedShipment.specialServicesRequested.returnEmailDetail.allowedSpecialService[] -- Type: string | Valid values: SATURDAY_DELIVERY, SATURDAY_PICKUP
requestedShipment.specialServicesRequested.returnEmailDetail.merchantPhoneNumber -- Type: string | Example: 1234567890 | This is the merchant phone number. Is Required for Email Return Labels.<br>Example: 19012635656
requestedShipment.specialServicesRequested.returnShipmentDetail -- Type: object | Indicates the return shipment.
requestedShipment.specialServicesRequested.returnShipmentDetail.returnType -- Type: string | Valid values: FEDEX_TAG, NET_RETURN, PENDING, PRINT_RETURN_LABEL, EMAIL_LABEL, VOICE_CALL_TAG | Example: PENDING | 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 mu...
requestedShipment.specialServicesRequested.saturdayDeliveryDetail -- Type: object | These are service elements for Saturday Delivery special service.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress -- Type: object | Example: {'address': {'streetLines': ['10 FedEx Parkway', 'Suite 302'], 'city': 'Beverly Hills', 'stateOrProvinceCode': 'CA', 'postalCode': '38127', 'countryCode': 'US', 'residential': False}, 'contact': {'personName': {'firstName': 'first name', 'lastName': 'last name', 'middleName': 'middle name', 'suffix': 'suffix'}, 'emailAddress': 'email address', 'phoneNumber': 'phone number', 'companyName': 'company name', 'faxNumber': 'fax number', 'title': 'title'}} | These are contact and address details for this special service.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address -- Type: object | This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (suc...
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.city -- Type: string | Example: Beverly Hills | This is a placeholder for City Name. <br> Example: Beverly Hills
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.countryCode -- Type: object | Example: US | This is a Two-letter country code.Max length is two.<br>Example: US<br><a onclick='loadDocReference("countrycodes")'>Click here to see Country Codes</a>
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.postalCode -- Type: object | Example: 38127 | This is the Postal code. This is Optional for non postal-aware countries. Max length is 10.<br> Example: 65247<br><a onclick='loadDocReference("postalawarecountries")'>Click here to see Postal awar...
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.residential -- Type: boolean | Valid values: True, False | Indicate whether this address is Residential as opposed to Commercial.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: CA | This is a placeholder for State or Province code. <br> Example: CA<br><a onclick='loadDocReference("canadaprovincecodes")'>Click here to see State/Province Code</a>
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.streetLines -- Type: array | This is a combination of number, street name, etc. <br>Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.<br>Example: [\"10 FedEx P...
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.address.streetLines[] -- Type: string
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact -- Type: object | Indicate the contact details for this shipment.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Max length is 80.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact.faxNumber -- Type: string | Specify contact person's fax number. Max length is 15.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact name.Max Length is 70.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact.phoneExtension -- Type: string | Specify contact person's phone extension. Max length is 6.
requestedShipment.specialServicesRequested.saturdayDeliveryDetail.locationContactAndAddress.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact person's phone number. Max length is 15.
requestedShipment.specialServicesRequested.shipmentDryIceDetail -- Type: object | This is the descriptive data required for the FedEx shipment containing dangerous materials. This element is required when SpecialServicetype DRY_ICE is selected in SpecialServicetype collection. N...
requestedShipment.specialServicesRequested.shipmentDryIceDetail.packageCount -- Type: integer | Format: int32 | Example: 12 | Indicates the total number of packages in the shipment that contain dry ice.<br>Example: 12
requestedShipment.specialServicesRequested.shipmentDryIceDetail.totalWeight -- Type: object | Example: {'units': 'LB', 'value': 10} | Specify the total weight of the shipment. <br>This is only applies to International shipments and should be used on the first package of a multiple piece shipment. This value contains 1 explicit de...
requestedShipment.specialServicesRequested.shipmentDryIceDetail.totalWeight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to weigh the shipment. The package and commodity weight unit should be the same else the request will result in an error. Identifies the unit of measure associa...
requestedShipment.specialServicesRequested.shipmentDryIceDetail.totalWeight.value -- Type: number | Format: double | Example: 10 | Specify the value of weight of shipment.<br>Example: 68.25 Identifies the weight <br> Example: 10.0
requestedShipment.specialServicesRequested.specialServiceTypes -- Type: array | Example: ['FEDEX_EXPRESS'] | Optional <br> The types of all special services requested for the enclosing shipment.<br> Example: FEDEX_EXPRESS<br><a onclick='loadDocReference("servicetypes")'>Click here to see Special Service T...
requestedShipment.specialServicesRequested.specialServiceTypes[] -- Type: string
requestedShipment.variableHandlingChargeDetail -- Type: object | Optional  Provide any Variable Handling Charge details Specifies Variable Handling Charge details
requestedShipment.variableHandlingChargeDetail.fixedValue -- Type: object | Rate charge fixed value Optional, but if indicated 'amount' and 'currency' must be provided.
requestedShipment.variableHandlingChargeDetail.fixedValue.amount -- Type: number | Format: double | Example: 12.45 | This is the amount. Max length 18 including decimal.<br>Example: 12.45
requestedShipment.variableHandlingChargeDetail.fixedValue.currency -- Type: string | Example: USD | This is the currency code for the amount.<br>Example: USD<br><a onclick='loadDocReference("countrycodes")'>Click here to see Currency Codes</a>
requestedShipment.variableHandlingChargeDetail.percentValue -- Type: number | Format: double | Example: 25.67 | variable handling percentage <br> Example: 25.67
requestedShipment.variableHandlingChargeDetail.rateElementBasis -- Type: string | Valid values: NET_CHARGE, NET_FREIGHT, BASE_CHARGE, NET_CHARGE_EXCLUDING_TAXES | Example: NET_CHARGE | Description of the percentage <br> Example: NET_CHARGE
requestedShipment.variableHandlingChargeDetail.rateTypeBasis -- Type: string | Valid values: ACCOUNT, ACTUAL, CURRENT, CUSTOM, LIST | Example: ACCOUNT | Optional <br> RateType Basis <br> Example: ACCOUNT

Retrieve Services and Transit Times

[header] authorization -- Type: string | This indicates the authorization token for the input request.
[header] content-type -- Type: string | This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
[header] x-customer-transaction-id -- Type: string | Example: 0e671149-016f-1000-941f-ef4dbabadd2e | This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. It also helps you to track the tr...
[header] x-locale -- Type: string | This indicates the combination of language code and country code.  <a onclick='loadDocReference("locales")'>Click here to see Locales</a>
carrierCodes -- Type: array | Example: ['FDXG'] | Specify the four letter code of a FedEx operating company that meets your requirements<br>Examples of FedEx Operating Companies are:<ul><li>FDXE - FedEx Express</li><li>FDXG - FedEx Ground</li><li>...
carrierCodes[] -- Type: string | Valid values: FDXE, FDXG, FXSP
requestedShipment -- Type: object | Provide shipment data details for which a transit time is desired.
requestedShipment.customsClearanceDetail -- Type: object | This is Customs clearance data associated with the shipment. This is used for both international and intra-country shipping and rating. Customs commodity data is required for international and intr...
requestedShipment.customsClearanceDetail.commodities -- Type: array | Specify the commodity details.
requestedShipment.customsClearanceDetail.commodities[] -- Type: object
requestedShipment.customsClearanceDetail.commodities[].countryOfManufacture -- Type: string | Example: US | This is a manufacturing country. Maximum field Length is 4.<br>Example: IN
requestedShipment.customsClearanceDetail.commodities[].customsValue -- Type: object | Indicate the amount details. This is optional, but if indicated, amount and currency must be provided.
requestedShipment.customsClearanceDetail.commodities[].customsValue.amount -- Type: number | Format: double | Example: 12.45 | Indicate the amount.
requestedShipment.customsClearanceDetail.commodities[].customsValue.currency -- Type: string | Example: USD | Indicate the three-character ISO currency code. <br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency Codes</a>
requestedShipment.customsClearanceDetail.commodities[].description -- Type: string | Example: DOCUMENTS | Indicate the description of the dutiable packages.<br> Maximum Length is 450. <br> Example: DOCUMENTS <br><a onclick='loadDocReference("vaguecommoditydescriptions")'>Click here to see Vague commodi...
requestedShipment.customsClearanceDetail.commodities[].harmonizedCode -- Type: string | Example: 080211 | This is to specify the Harmonized Tariff System (HTS) code to meet U.S. and foreign governments' customs requirements. These are mainly used to estimate the duties and taxes.<br>Example: A six digi...
requestedShipment.customsClearanceDetail.commodities[].name -- Type: string | Example: DOCUMENTS | Indicate the Commodity name.<br>Example: DOCUMENTS
requestedShipment.customsClearanceDetail.commodities[].numberOfPieces -- Type: integer | Format: int32 | Example: 1 | Specifies the number of pieces for this commodity.<br>Example: 10
requestedShipment.customsClearanceDetail.commodities[].partNumber -- Type: string | Example: P1 | Specify the part number if any. Example: P1
requestedShipment.customsClearanceDetail.commodities[].quantity -- Type: integer | Format: int32 | Example: 1 | Specify the total number of units (using quantityUnits as the unit of measure) of this commodity present in the shipment. This element is used to estimate duties and taxes. <br>Example: 1
requestedShipment.customsClearanceDetail.commodities[].quantityUnits -- Type: string | Example: PCS | Indicate unit quantity used to estimate duties and taxes.<br>Example: PCS
requestedShipment.customsClearanceDetail.commodities[].unitPrice -- Type: object | Indicate the amount details. This is optional, but if indicated, amount and currency must be provided.
requestedShipment.customsClearanceDetail.commodities[].unitPrice.amount -- Type: number | Format: double | Example: 12.45 | Indicate the amount.
requestedShipment.customsClearanceDetail.commodities[].unitPrice.currency -- Type: string | Example: USD | Indicate the three-character ISO currency code. <br>Example: USD<br><a onclick='loadDocReference("currencycodes")'>Click here to see Currency Codes</a>
requestedShipment.customsClearanceDetail.commodities[].weight -- Type: object | These are the weight details.
requestedShipment.customsClearanceDetail.commodities[].weight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to  weigh the package. For Dry Ice the unit of measure is KG.
requestedShipment.customsClearanceDetail.commodities[].weight.value -- Type: number | Format: double | Example: 10 | Specify the value of the weight of the package.<br> Example: 68.25
requestedShipment.packagingType -- Type: string | Example: YOUR_PACKAGING | Specify the packaging used.
requestedShipment.pickupType -- Type: string | Valid values: CONTACT_FEDEX_TO_SCHEDULE, DROPOFF_AT_FEDEX_LOCATION, USE_SCHEDULED_PICKUP | Example: DROPOFF_AT_FEDEX_LOCATION | Indicate the pickup type method by which the shipment to be tendered to FedEx.<br><i>Note: The value of this element does not specify dispatching the courier for package pickup.</i><br><a onclick='...
requestedShipment.recipients -- Type: array | Provide recipients physical location/address details to where the shipment delivered.
requestedShipment.recipients[] -- Type: object | Indicate the descriptive data for the recipient location to which the shipment is to be received.
requestedShipment.recipients[].address -- Type: object | Descriptive data on physical location. May be used as an actual physical address (place where one could go), or as a container of address parts, which should be handled as a unit (such as a city-st...
requestedShipment.recipients[].address.city -- Type: string | Example: Collierville | The name of city, town, etc. <br>Example: Collierville
requestedShipment.recipients[].address.countryCode -- Type: string | Example: US | The two-letter code used to identify a country. Max length is two.<br>Example: US<br><a href="/developer-portal/en-us/reference-guide.html#countrycodes" target="_blank">Click here to see Country Co...
requestedShipment.recipients[].address.postalCode -- Type: string | Example: 38127 | Identification of a region for mail/package delivery. Format and presence of this field will vary, depending on the country.Optional for non postal-aware countries. Max length is 10.<br> Example: 3...
requestedShipment.recipients[].address.residential -- Type: boolean | Indicates whether the address is residential (as opposed to commercial).<br> Example: false
requestedShipment.recipients[].address.stateOrProvinceCode -- Type: string | Example: TN | Identifying abbreviation for US state, Canada province. Format and presence of this field will vary, depending on the country. Conditional: Not used for Ground/SmartPost. Max length is 2.<br>      ...
requestedShipment.requestedPackageLineItems -- Type: array | 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 pa...
requestedShipment.requestedPackageLineItems[] -- Type: object
requestedShipment.requestedPackageLineItems[].declaredValue -- Type: object | This is the Declared Value - represents FedEx Maximum liability in connection with a shipment of that Package, including but not limited to, any loss, damage, delay, misdelivery, any failure to pro...
requestedShipment.requestedPackageLineItems[].declaredValue.amount -- Type: number | Format: double | Example: 12 | Indicates the details of the charges are to be added.
requestedShipment.requestedPackageLineItems[].declaredValue.currency -- Type: string | Example: USD | Three-character ISO currency code. <br>Example: USD<br><a href="/developer-portal/en-us/reference-guide.html#currencycodes" target="_blank">Click here to see Currency Codes</a>
requestedShipment.requestedPackageLineItems[].dimensions -- Type: object | Specify the dimensions of this package and the unit type used for the measurements. Valid measurements are whole numbers greater than zero.
requestedShipment.requestedPackageLineItems[].dimensions.height -- Type: integer | Format: int32 | Example: 30 | Height of a package or shipment. Maximum Length is 999. <br> Example: 30
requestedShipment.requestedPackageLineItems[].dimensions.length -- Type: integer | Format: int32 | Example: 100 | Length of a package or shipment. Maximum Length is 999. <br> Example: 100
requestedShipment.requestedPackageLineItems[].dimensions.units -- Type: string | Valid values: CM, IN | Example: CM | Unit of measure for the provided dimensions.<br> Valid Values: IN - inches, CM - centimeters <br>Example: CM
requestedShipment.requestedPackageLineItems[].dimensions.width -- Type: integer | Format: int32 | Example: 50 | Width dimensions of a package or shipment. Maximum Length is 999. <br> Example: 50
requestedShipment.requestedPackageLineItems[].packageSpecialServices -- Type: object | Optional.<br>These special services are available at the package level for some or all service types.  Indicated if rate data is being requested for the special services.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail -- Type: object | Provides information about the RecipientType and ShipperAgreementType. This object is manadatory if alcohol special service is selected.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.alcoholRecipientType -- Type: string | Valid values: LICENSEE, CONSUMER | Example: LICENSEE | Specify the Alcohol Recipient Type of the shipment. <br> Example:<br> <ul><li> LICENSEE- FedEx approved alchol shipper having appropriate licenses.</li> <li> CONSUMER- Individual consumer to whom t...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.alcoholDetail.shipperAgreementType -- Type: string | Example: retailer | Specify the shipper entity type. <br>Example: Fulfillment house, Retailer or a Winery.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails -- Type: object | Describes attributes of a battery or cell that are used for classification purposes. Typically this structure would be used to allow customers to declare batteries or cells for which full dangerous...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails.batteryMaterialType -- Type: string | Valid values: LITHIUM_METAL, LITHIUM_ION | Example: LITHIUM_METAL | Describes the material composition of the battery or cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails.batteryPackingType -- Type: string | Valid values: CONTAINED_IN_EQUIPMENT, PACKED_WITH_EQUIPMENT | Example: CONTAINED_IN_EQUIPMENT | Describes the packing arrangement of the battery or cell with respect to other items within the same package.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.batteryDetails.batteryRegulatoryType -- Type: string | Valid values: IATA_SECTION_II | Example: IATA_SECTION_II | A regulation specific classification for the battery or cell.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail -- Type: object | Package COD Detail.  COD main information is set in shipment level.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail.codCollectionAmount -- Type: object | Optional, but if indicated 'amount' and 'currency' must be provided.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | Indicates the details of the charges are to be added to the COD collect amount.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.codDetail.codCollectionAmount.currency -- Type: string | Example: USD | Three-character ISO currency code. <br>Example: USD<br><a href="/developer-portal/en-us/reference-guide.html#currencycodes" target="_blank">Click here to see Currency Codes</a>
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail -- Type: object | Use this object to specify Dangerous Goods shipment Detail.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.accessibility -- Type: string | Valid values: ACCESSIBLE, INACCESSIBLE | Example: ACCESSIBLE | Dangerous Goods Accessibility Type. Inaccessible means it does not have to be accessable on the aircraft.  Accessible means it must be fully accessible on the aircraft, and is more strictly control...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options -- Type: array | Optional  Specify the dangerous goods' detail from the list of available options.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dangerousGoodsDetail.options[] -- Type: string | Valid values: HAZARDOUS_MATERIALS, BATTERY, ORM_D, REPORTABLE_QUANTITIES, SMALL_QUANTITY_EXCEPTION, LIMITED_QUANTITIES_COMMODITIES | Example: BATTERY
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight -- Type: object | Specify weight of dry ice used in packaging.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to weigh the dry ice used in packaging.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.dryIceWeight.value -- Type: number | Format: double | Example: 10 | Specify the value of weight of dry ice used in packaging. <br> Example: 10.0
requestedShipment.requestedPackageLineItems[].packageSpecialServices.pieceCountVerificationBoxCount -- Type: integer | Format: int32 | Example: 2 | Indicates the box count used for piece count verification.
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes -- Type: array | Example: ['DANGEROUS_GOODS', 'COD'] | Optional.<br>Specify special services requested for the package.<br>Example: ["DANGEROUS_GOODS"]<br><a href="/developer-portal/en-us/reference-guide.html#packagespecialservicetypes" target="_blank"...
requestedShipment.requestedPackageLineItems[].packageSpecialServices.specialServiceTypes[] -- Type: string
requestedShipment.requestedPackageLineItems[].weight -- Type: object | Weight of the packages or shipment
requestedShipment.requestedPackageLineItems[].weight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to weigh. <br> Example: LB
requestedShipment.requestedPackageLineItems[].weight.value -- Type: number | Format: double | Example: 68.25 | Weight Value.<br> Example: 68.25<br><a href='https://developer.fedex.com/api/en-us/guides/api-reference.html#packagetypes' target='_blank'>Click here to see Weight Values</a>
requestedShipment.serviceType -- Type: string | Example: FEDEX_GROUND | Provide FedEx service type for the shipment. The results will be filtered by the serviceType value indicated.  If no serviceType is indicated then all the applicable services and corresponding tran...
requestedShipment.shipDatestamp -- Type: string | Example: 2021-06-16 | This is the Shipment date. Required for future ship date rates.Default is current date if not indicated or date is in the past.<br>Required Format is YYYY-MM-DD<br> Example: 2019-09-06
requestedShipment.shipmentSpecialServices -- Type: object | Indicate special services for which the rate data is being requested. Special Services are available at the shipment level for some or all service types.<br>Example: [BROKER_SELECT_OPTION]
requestedShipment.shipmentSpecialServices.codDetail -- Type: object | Use this object to specify Collect On Delivery (COD) shipment details.
requestedShipment.shipmentSpecialServices.codDetail.codCollectionAmount -- Type: object | Amount to be charged for COD collection
requestedShipment.shipmentSpecialServices.codDetail.codCollectionAmount.amount -- Type: number | Format: double | Example: 12.45 | Indicates the details of the charges are to be added to the COD collect amount.
requestedShipment.shipmentSpecialServices.codDetail.codCollectionAmount.currency -- Type: string | Example: USD | Three-character ISO currency code. <br>Example: USD<br><a href="/developer-portal/en-us/reference-guide.html#currencycodes" target="_blank">Click here to see Currency Codes</a>
requestedShipment.shipmentSpecialServices.codDetail.codCollectionType -- Type: string | Valid values: ANY, CASH, COMPANY_CHECK, GUARANTEED_FUNDS, PERSONAL_CHECK | Example: PERSONAL_CHECK | Indicate the type of funds FedEx should collect upon shipment delivery.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail -- Type: object | Use this object to specify required information of a shipment to be held at FedEx destination location. <br><br><i>Note: This object HoldAtLocationDetail is <b>REQUIRED</b>, when HOLD_AT_LOCATION i...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress -- Type: object | Specify the contact and address details of a location.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address -- Type: object | Descriptive data on physical location. May be used as an actual physical address (place where one could go), or as a container of address parts, which should be handled as a unit (such as a city-st...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.city -- Type: string | Example: Collierville | The name of city, town, etc. <br>Example: Beverly Hills
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.countryCode -- Type: string | Example: US | The two-letter code used to identify a country. Max length is two.<br>Example: US<br><a href="/developer-portal/en-us/reference-guide.html#countrycodes" target="_blank">Click here to see Country Co...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.postalCode -- Type: string | Example: 38127 | Identification of a region for mail/package delivery. Format and presence of this field will vary, depending on the country. Optional for non postal-aware countries. Maximum length is 10. <br>Examp...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.residential -- Type: boolean | Indicates whether this address is residential (as opposed to commercial).<br>Example: false
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.address.stateOrProvinceCode -- Type: string | Example: TN | Identifying abbreviation for US state, Canada province. Format and presence of this field will vary, depending on the country. Conditional: Not used for Ground/SmartPost. Max length is 2.<br>Exampl...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact -- Type: object | Specify the Hold at location contact details.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.companyName -- Type: string | Example: Fedex | Specify contact company name. Maximum length is 35.
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.emailAddress -- Type: string | Example: sample@company.com | Specify contact email address. Maximum length is 80. <br> Example: sample@company.com
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.faxNumber -- Type: string | Example: 1234567890 | Specify contact fax number. Maximum length is 15. <br> Example: 1234567890
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.personName -- Type: string | Example: John Taylor | Specify contact name.<br>Note: Recommended Length is 70. There's no specific validation for the length.<br> Example: John Taylor
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneExtension -- Type: string | Example: 1234 | Specify contact phone extension. Maximum length is 6. <br> Example: 1234
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationContactAndAddress.contact.phoneNumber -- Type: string | Example: 1234567890 | Specify contact phone number. Maximum length is 15. <br> Example: 1234567890
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationId -- Type: string | Example: YBZA | This is an alphanumeric identifier used for Location/Facility Identification.<br><br>Example: YBZA<br><br>Note: <i><ul><li>For HAL Shipment, Location ID is <b>REQUIRED</b> to ensure packages are de...
requestedShipment.shipmentSpecialServices.holdAtLocationDetail.locationType -- Type: string | Valid values: FEDEX_AUTHORIZED_SHIP_CENTER, FEDEX_OFFICE, FEDEX_SELF_SERVICE_LOCATION, FEDEX_STAFFED, RETAIL_ALLICANCE_LOCATION, FEDEX_GROUND_TERMINAL, FEDEX_ONSITE | Example: FEDEX_ONSITE | Specify the Hold at location type.<br> Example: FEDEX_ONSITE
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail -- Type: object | These are Special service elements for FedEx Ground Home Delivery shipments. If selected, element homedeliveryPremiumType is mandatory.
requestedShipment.shipmentSpecialServices.homeDeliveryPremiumDetail.homedeliveryPremiumType -- Type: string | Valid values: APPOINTMENT, DATE_CERTAIN, EVENING | Example: EVENING | This is Home Delivery Premium Type. It allows to specify additional premium service options for the home delivery shipment. Can specify Evening delivery or a Date certain, or can specify appointmen...
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail -- Type: object | Use this object to specify International Controlled Export shipment Details.
requestedShipment.shipmentSpecialServices.internationalControlledExportDetail.type -- Type: string | Valid values: DEA_036, DEA_236, DEA_486, DSP_05, DSP_61, DSP_73, DSP_85, DSP_94, DSP_LICENSE_AGREEMENT, FROM_FOREIGN_TRADE_ZONE, WAREHOUSE_WITHDRAWAL | Example: DSP_LICENSE_AGREEMENT | Indicate International Controlled Export Type.<br>Example: WAREHOUSE_WITHDRAWAL
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail -- Type: object | Use this object to indicate package count with weight for this shipment containing dry ice. Dry ice is supported in both shipment level and package level services.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.packageCount -- Type: integer | Format: int32 | Example: 12 | Specify dry ice shipment package count.<br>Example: 12
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight -- Type: object | These are the weight details.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.units -- Type: string | Valid values: KG, LB | Example: LB | Specify the unit of measurement used to  weigh the package. For Dry Ice the unit of measure is KG.
requestedShipment.shipmentSpecialServices.shipmentDryIceDetail.totalWeight.value -- Type: number | Format: double | Example: 10 | Specify the value of the weight of the package.<br> Example: 68.25
requestedShipment.shipmentSpecialServices.specialServiceTypes -- Type: array | Example: ['BROKER_SELECT_OPTION'] | Indicate special services for which the rate data is being requested. Special Services are available at the shipment level for some or all service types.<br>Example: BROKER_SELECT_OPTION <br><a onc...
requestedShipment.shipmentSpecialServices.specialServiceTypes[] -- Type: string
requestedShipment.shipper -- Type: object | The descriptive data on the physical location of shipment origin.
requestedShipment.shipper.address -- Type: object | Descriptive data on physical location. May be used as an actual physical address (place where one could go), or as a container of address parts, which should be handled as a unit (such as a city-st...
requestedShipment.shipper.address.city -- Type: string | Example: Collierville | The name of city, town, etc. <br>Example: Beverly Hills
requestedShipment.shipper.address.countryCode -- Type: string | Example: US | The two-letter code used to identify a country. Max length is two.<br>Example: US<br><a href="/developer-portal/en-us/reference-guide.html#countrycodes" target="_blank">Click here to see Country Co...
requestedShipment.shipper.address.postalCode -- Type: string | Example: 38127 | Identification of a region for mail/package delivery. Format and presence of this field will vary, depending on the country. Optional for non postal-aware countries. Maximum length is 10. <br>Examp...
requestedShipment.shipper.address.residential -- Type: boolean | Indicates whether this address is residential (as opposed to commercial).<br>Example: false
requestedShipment.shipper.address.stateOrProvinceCode -- Type: string | Example: TN | Identifying abbreviation for US state, Canada province. Format and presence of this field will vary, depending on the country. Conditional: Not used for Ground/SmartPost. Max length is 2.<br>Exampl...
requestedShipment.shippingChargesPayment -- Type: object | Details about who and how the shipment will be paid for. 'payor' is optional when 'paymentType' provided is SENDER.
requestedShipment.shippingChargesPayment.paymentType -- Type: string | Valid values: SENDER, RECIPIENT, THIRD_PARTY, COLLECT | Example: COLLECT | Applicable for Express and Ground rates.<br> Indicates who and how the shipment will be paid for.
requestedShipment.shippingChargesPayment.payor -- Type: object | Information about the person who is paying for the shipment.  Not applicable for credit card payment.
requestedShipment.shippingChargesPayment.payor.responsibleParty -- Type: object | Conditional. The descriptive data for the payor of the shipment and their physical address, contact and account number information.
requestedShipment.shippingChargesPayment.payor.responsibleParty.accountNumber -- Type: object | Specifies the FedEx customer account information of the responsible paty.
requestedShipment.shippingChargesPayment.payor.responsibleParty.accountNumber.value -- Type: string | Example: 60xxxxxx2 | Conditionally required.<br>Account number is required for ACCOUNT based rates. Account number value max length is 9. <br> Example: 60xxxxxx2
requestedShipment.shippingChargesPayment.payor.responsibleParty.address -- Type: object | Descriptive data on physical location. May be used as an actual physical address (place where one could go), or as a container of address parts, which should be handled as a unit (such as a city-st...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.city -- Type: string | Example: Collierville | The name of city, town, etc. <br>Example: Beverly Hills
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.countryCode -- Type: string | Example: US | The two-letter code used to identify a country. Max length is two.<br>Example: US<br><a href="/developer-portal/en-us/reference-guide.html#countrycodes" target="_blank">Click here to see Country Co...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.postalCode -- Type: string | Example: 38127 | Identification of a region for mail/package delivery. Format and presence of this field will vary, depending on the country. Optional for non postal-aware countries. Maximum length is 10. <br>Examp...
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.residential -- Type: boolean | Indicates whether this address is residential (as opposed to commercial).<br>Example: false
requestedShipment.shippingChargesPayment.payor.responsibleParty.address.stateOrProvinceCode -- Type: string | Example: TN | Identifying abbreviation for US state, Canada province. Format and presence of this field will vary, depending on the country. Conditional: Not used for Ground/SmartPost. Max length is 2.<br>Exampl...