Returns (Inbound) Email Label Elements

Basic information is required in a CreatePendingShipment Request:

Element Required Description
CreatePendingShipment Required The web service inside the Ship Service WSDL file used to create all Email Return Labels
WebAuthenticationDetail/ UserCredential/Key Required The value for the Key was provided by FedEx upon your request through the FedEx Developer Resource Center. It is an alphanumeric mixed-case string.
WebAuthenticationDetail/ UserCredential/Password Required The value for the Password was provided by FedEx upon your request through the FedEx Developer Resource Center. It is an alphanumeric mixed-case string.
ClientDetail/AccountNumber Required The FedEx Express nine-digit meter number that was provided by FedEx upon your request through the FedEx Developer Resource Center.
ClientDetail/MeterNumber Required The FedEx Express meter number that was provided by FedEx upon your request through the FedEx Developer Resource Center.
Version/ServiceId Required The value is “ship”
Version/Major Required The current value is "9".
Version/Intermediate Required The current value is "0".
Version/Minor Required The current value is "0".
RequestedShipment/ ServiceType Required For this transaction the valid value is SMART_POST
RequestedShipment/ Shipper/Contact/ PersonName Optional and/or Required Required if Contact name is blank.
RequestedShipment/ Shipper/Contact/ CompanyName Optional and/or Required Required if Company name is blank.
RequestedShipment/ Shipper/Contact/ PhoneNumber Required Required. Shipper phone number. Numeric only.
RequestedShipment/ Shipper/Contact/ Optional and/or Required There are additional fields available. They are optional.
RequestedShipment/ Shipper/Address/ StreetLines Optional and/or Required At least one street address line is required. This is a multiple occurrence field.
RequestedShipment/ Shipper/Address/City Required Required. Shipper city.
RequestedShipment/ Shipper/Address/ StateOrProvinceCode Required Required. Please refer to Appendix B for a list of State Codes.
RequestedShipment/ Shipper/Address/ PostalCode Required Required. Shipper postal code.
RequestedShipment/ Shipper/Address/ CountryCode Required Required. Valid value - US
RequestedShipment/ Shipper/Address/ Optional and/or Required There are additional fields available. They are optional.
RequestedShipment/ Recipient/Contact/ PersonName Optional and/or Required Required if Contact name is blank.
RequestedShipment/ Recipient/Contact/ CompanyName Optional and/or Required Required if Company name is blank.
RequestedShipment/ Recipient/Contact/ PhoneNumber Required Required. Recipient phone number. Numeric only.
RequestedShipment/ Recipient/Contact/ Optional and/or Required There are additional fields available. They are optional.
RequestedShipment/ Recipient/Address/ StreetLines Optional and/or Required At least one street address line is required. This is a multiple occurrence field.
RequestedShipment/ Recipient/Address/City Required Required. Recipient city.
RequestedShipment/ Recipient/Address/ StateOrProvinceCode Required Required. Please refer to Appendix B for a list of State Codes.
RequestedShipment/ Recipient/Address/ PostalCode Required Required. Recipient postal code.
RequestedShipment/ Recipient/Address/ CountryCode Required Required. Valid value - US
RequestedShipment/ Recipient/Address/ Optional and/or Required There are additional fields available. They are optional.

In addition to the basic shipping elements, the following elements must be included in the CreatePendingShipmentRequest to trigger an Email Return Label through fedex.com:

Element Required Description
RequestedShipment/ SpecialServicesRequested/ SpecialServiceTypes Required Required. Specify the type of special service. Both of these Service Types must be included for a returns email label:
  • PENDING_SHIPMENT
  • RETURN_SHIPMENT
RequestedShipment/ SpecialServicesRequested/ ReturnShipmentDetail Optional and/or Required Required. Specify the Return Type. Use the following value:

PENDING

RequestedShipment/ SpecialServicesRequested/ ReturnShipmentDetail/Rma Optional and/or Required Optional. This value is a string. It will be printed on the label as both a barcode and in human-readable text.
Note: That if an Rma Number is specified, the package can also be tracked by this value.
RequestedShipment/ SpecialServicesRequested/ ReturnShipmentDetail/ ReturnEmailDetail/ MerchantPhoneNumber Optional and/or Required Required. Include the phone number for the merchant, such as a general customer service phone number.

Max 10 characters, numeric-only string.

RequestedShipment/ SpecialServicesRequested/ PendingShipmentDetail/ Type Required Required. Specify the Pending Shipment Type. Include the following value:
  • EMAIL
RequestedShipment/ SpecialServicesRequested/ PendingShipmentDetail/ ExpirationDate Required Required. Specify the email label expiration date: for example, 2009-01-31.

The maximum expiration date must be greater or equal to the day of the label request and not greater than 30 days in the future.

RequestedShipment/ SpecialServicesRequested/ PendingShipmentDetail/ EmailLabelDetail/ NotificationEmailAddress Required Required. Email address of the end-user to be notified of the return label. This element has a 200-character maximum.
RequestedShipment/ SpecialServicesRequested/ PendingShipmentDetail/ EmailLabelDetail/ NotificationMessage Optional and/or Required Optional. Notification message included in the email to the end-user.

Finally, the following elements are included in a request for the email return label to be a FedEx SmartPost® Email Return Label:

Element Required Description
SmartPostDetail Required Required. Specify the appropriate details for a FedEx SmartPost shipment.
SmartPostDetail/Indicia Required Required. Specify the indicia type. The value for this transaction is PARCEL_RETURN.
SmartPostDetail/ AncillaryEndorsement Optional and/or Required Optional. Specify an endorsement type from the following valid values:
  • ADDRESS_CORRECTION
  • CARRIER_LEAVE_IF_NO_RESPONSE
  • CHANGE_SERVICE
  • FORWARDING_SERVICE
  • RETURN_SERVICE
Note: These services are of little practical use for a return package, but they will not cause the transaction to fail.
SmartPostDetail/HubId Required Required. Specify the HubID. Valid values are:
  • 5185 ALPA Allentown
  • 5303 ATGA Atlanta
  • 5281 CHNC Charlotte
  • 5602 CIIL Chicago
  • 5929 COCA Chino
  • 5751 DLTX Dallas
  • 5802 DNCO Denver
  • 5481 DTMI Detroit
  • 5087 EDNJ Edison
  • 5431 GCOH Grove City
  • 5771 HOTX Houston
  • 5465 ININ Indianapolis
  • 5648 KCKS Kansas City
  • 5902 LACA Los Angeles
  • 5254 MAWV Martinsburg
  • 5379 METN Memphis
  • 5552 MPMN Minneapolis
  • 5531 NBWI New Berlin
  • 5110 NENY Newburgh
  • 5015 NOMA Northborough
  • 5327 ORFL Orlando
  • 5194 PHPA Philadelphia
  • 5854 PHAZ Phoenix
  • 5150 PTPA Pittsburgh
  • 5958 SACA Sacramento
  • 5843 SCUT Salt Lake City
  • 5983 SEWA Seattle
  • 5631 STMO St. Louis
Note: Include only the numeric HubID value in your request.
SmartPostDetail/ CustomerManifestId Optional and/or Required Optional. This field is of little practical use for a returns package.

The CustomerManifestId is used to group FedEx SmartPost packages onto a manifest for each trailer that is being prepared.

If you have multiple trailers, you must assign a Manifest Id to each FedEx SmartPost package as determined by its trailer. The Manifest Id must be unique to your account number for a minimum of 6 months and cannot exceed 8 characters in length.

We recommend that you use the day of year, the trailer id (a sequential number for that trailer). For example, if there are 3 trailers that you started loading on Feb 10, then the 3 Manifest Ids would be 041001, 041002, 041003 (this example includes leading zeros on the trailer numbers).

The maximum length is 8 characters.

RequestedShipment/ RequestedPackageLineItems/ PhysicalPackaging Optional and/or Required Optional. Provides additional detail on how the customer has physically packaged this item. Required for FedEx SmartPost services.