FedEx
App · 20 actions
Track shipments, quote rates, validate addresses, manage labels and shipments, and schedule or cancel pickups.
Actions
| Action | What it does |
|---|---|
| Cancel pickup | Cancel a scheduled FedEx pickup. |
| Cancel return tag | Cancel a FedEx Express or Ground return tag and its pickup, if the courier hasn't collected the package yet. |
| Cancel shipment | Cancel a FedEx Express or Ground shipment that hasn't been handed to FedEx yet. |
| Create pickup | Schedule a FedEx courier pickup for a package. |
| Create return tag | Create a FedEx return tag: FedEx brings a return label to your customer and collects the item. |
| Create shipment | Create a FedEx shipment after checking its details. |
| Get package and service options | List the FedEx Express or FedEx Ground services and packaging types available between an origin and a destination, with subpackaging details. |
| Get pickup availability | Check whether FedEx pickup service is available. |
| Get shipment results | Get the results of a large shipment (more than 40 packages) that was processed in the background, using its job ID. |
| Get special service options | List the FedEx services, special service options, delivery signature options and return shipment types available between an origin and a destination. |
| Get transit times | Get the estimated transit times for a shipment. |
| Rate and transit times | Get rate quotes and, optionally, transit times for a shipment, based on where it goes from and to. |
| Track by references | Get tracking details for a FedEx shipment using a reference other than its tracking number, such as a customer reference number. |
| Track by tracking control number | Get tracking details for a FedEx shipment using its transportation control number. |
| Track by tracking number | Get tracking details for up to 30 FedEx packages by tracking number, across FedEx shipping services. |
| Track document | Request a signature proof of delivery: a letter that shows the recipient's signature. |
| Track multiple piece shipment | Get tracking details for the shipments linked to a tracking number, such as the pieces of a multiple-piece shipment or a return shipment linked to an outbound one. |
| Validate address | Check addresses against FedEx's reference data. |
| Validate postal | Check that a postal code is valid and see the service commitments for it, including city, country and origin-to-destination lookups. |
| Validate shipment | Check a shipment for errors before you create it, so its details can be corrected before a label is printed. |
Cancel pickup
Cancel a scheduled FedEx pickup. If the courier has already been sent to the pickup location, the cancellation fails and you are notified.
Inputs
- Associated account number
associated_account_numberobjectRequired - This is the FedEx account number. Example: Your account number
- Pickup confirmation code
pickup_confirmation_codetextRequired - The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested. Example: 7
- Remarks
remarkstext - Placeholder for any message to be passed to the FedEx pickup courier. Note:Maximum length is 60 characters. Example: Please ring bell at loading dock.
- Carrier code
carrier_codetext - This is a placeholder to provide the FedEx operating company (transportation) code used for package delivery. Required for FedEx Ground. Optional for FedEx Express. The Default is FedEx Express i.e. FDXE.One of:
FDXE,FDXG. - Scheduled date
scheduled_datedateRequired - Indicates the date the pickup dispatch occurs. Format YYYY-MM-DD Example: 2019-10-15
- Location
locationtext - 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 for FedEx Express Pickups. Optional for FedEx Ground. Example: LOSA
- Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- This is a wrapper class for outputVO
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"cancelConfirmationMessage": "example",
"pickupConfirmationCode": "example"
},
"transactionId": "example"
}
}Cancel return tag
Cancel a FedEx Express or Ground return tag and its pickup, if the courier hasn't collected the package yet.
Inputs
- Shipmentid
shipmentidtext - Shipmentid.
- Account number
account_numberobjectRequired - Returned value.
- Service type
service_typetextRequired - This is the FedEx service type associated with the shipment. Example: PRIORITY_OVERNIGHT Click here to see Service Types
- Tracking number
tracking_numbertext - The tracking number for the Express or Ground Tag to the cancelled. Example: 301025281523 Click here to see mock tracking numbers for FedEx Express and FedEx Ground.
- Version
versionobject - Returned value.
- Completed tag detail
completed_tag_detailobjectRequired - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- Wrapper class for CancelTagOuputVO. It holds transactionId and output.
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"cancelledTag": false,
"successMessage": "example"
},
"transactionId": "example"
}
}Cancel shipment
Cancel a FedEx Express or Ground shipment that hasn't been handed to FedEx yet. Every package in the shipment is cancelled.
Inputs
- Account number
account_numberobjectRequired - Returned value.
- Email shipment
email_shipmenttrue/false - A boolean flag passed by Clients to indicate that whether a shipment is a EMAIL shipment(Pending Shipment) or not. Once a shipment is confirmed, it can no longer be cancelled by having this flag as True.
- Sender country code
sender_country_codetext - The two-letter sender Country code(Ex: US, CA, GB..etc). Example: US Click here to see Country Codes
- Deletion control
deletion_controltext - Specifies which packages in a shipment to be canceled DELETE_ALL_PACKAGES which will cancel all tracking numbers associated to the shipment.One of:
DELETE_ALL_PACKAGES(Delete all packages). - Tracking number
tracking_numbertextRequired - This is an unique number assigned by FedEx to the packages for tracking. Example: "794953555571"
- Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- This is a wrapper class for outputVO
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"cancelledHistory": false,
"cancelledShipment": false,
"message": "example"
},
"transactionId": "example"
}
}Create pickup
Schedule a FedEx courier pickup for a package. This may incur carrier charges, so use Sandbox when testing.
Inputs
- Associated account number
associated_account_numberobjectRequired - This is the FedEx account number. Example: Your account number
- Associated account number type
associated_account_number_typetext - This enumeration represents a kind of legacy account number from a FedEx operating entity for the account number associated to the pickup. Valid values are: FEDEX_EXPRESS FEDEX_GROUND
- Total weight
total_weightobject - Returned value.
- Package count
package_countnumber - Specify the total number of packages for the pickup. Example: 5
- Carrier code
carrier_codetextRequired - Specify the four letter code of a FedEx operating company that meets your requirements. Examples of FedEx Operating Comapnies are : FDXE- FedEx Express FDXG- FedEx GroundOne of:
FDXE,FDXG. - Requested express pickup detail
requested_express_pickup_detailobject - Returned value.
- Account address of record
account_address_of_recordobject - Returned value.
- Remarks
remarkstext - Placeholder for any message to be passed to the FedEx pickup courier. Note:Maximum length is 60 characters. Example: Please ring bell at loading dock.
- Country relationships
country_relationshipstext - 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 incorrect values will result in to errors.One of:
DOMESTIC,INTERNATIONAL. - Pickup type
pickup_typetext - Indicate the pickup type method by which the shipment to be tendered to FedEx. Note: The value of this element does not specify dispatching the courier for package pickup. Example: ON_CALL, PACKAGE_RETURN_PROGRAM, REGULAR_STOP Click here for more information on Pickup Types.
- Tracking number
tracking_numbertext - This is a Tracking number for FedEx packages used for tracking a single package or group of packages. Example: 795803657326 Click here to see mock tracking numbers for FedEx Express and FedEx Ground.
- Commodity description
commodity_descriptiontext - Description of the commodity being shipped. Example:This field contains Commodity Description. Click here to see Vague commodity descriptions
- Express freight detail
express_freight_detailobject - Returned value.
- Oversize package count
oversize_package_countnumber - Specify the number of oversize packages that are tendered to FedEx Ground.
- Pickup notification detail
pickup_notification_detailobject - Returned value.
- Pickup charges payment
pickup_charges_paymentobject - Returned value.
- Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
- Origin pickup address type
origin_pickup_address_typetext - Indicates the type of pickup address being used whether it is account address, shipper address or alternate address. Note: The default value is OTHER.One of:
ACCOUNT,SHIPPER,OTHER. - Origin pickup location
origin_pickup_locationobjectRequired - Returned value.
- Origin customer close time
origin_customer_close_timetimeRequired - The latest time the driver can collect the package, in the pickup location’s local time.
- Origin pickup date type
origin_pickup_date_typetext - Indicates whether the pickup request is for the same day or on a future date.One of:
SAME_DAY(Same day),FUTURE_DAY(Future day). - Origin package location
origin_package_locationtext - This provides a location description from where the courier/driver must pick up the package. It is mandatory for Ground Pickup. Example: FRONTOne of:
FRONT,NONE,REAR,SIDE. - Origin building part
origin_building_parttext - This is the building type.One of:
APARTMENT,BUILDING,DEPARTMENT,FLOOR,ROOM,SUITE. - Origin building part description
origin_building_part_descriptiontext - Indicates the building part such as floor suite or apartment number or an identifier of the building. Example: 111
- Origin early pickup
origin_early_pickuptrue/false - Indicates if it is an early pickup. This applies only to Europe.
- Origin supplies requested
origin_supplies_requestedtext - Indicates if any shipping supplies are requested at the pickup origin required to pack the shipment such as FedEx Box, Large Box, FedEx Tube. Example: Supplies requested by customer
- Origin geographical postal code
origin_geographical_postal_codetext - This is the alternate postal code associated with pickup location. (Applicable only for European pickups)
- Pickup date
pickup_datedateRequired - The pickup date at the pickup location.
- Ready time
ready_timetimeRequired - The earliest pickup time at the pickup location.
Outputs
dataobject- This is a wrapper class for outputVO
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"location": "example",
"pickupConfirmationCode": "example"
},
"transactionId": "example"
}
}Create return tag
Create a FedEx return tag: FedEx brings a return label to your customer and collects the item. Works for FedEx Express and FedEx Ground. This may incur carrier charges, so use Sandbox when testing.
Inputs
- Requested shipment
requested_shipmentobjectRequired - Returned value.
- Account number
account_numberobjectRequired - Returned value.
- Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- Wrapper class for ShipShipmentOutputVO. It holds transactionId and output.
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"completedTagDetail": {
"confirmationNumber": "example",
"dispatchDate": "example",
"location": "example"
},
"masterTrackingNumber": "example",
"serviceType": "example",
"shipTimestamp": "example"
},
"transactionId": "example"
}
}Create shipment
Create a FedEx shipment after checking its details. Returns the labels, or a job ID when the shipment is processed in the background. This may incur carrier charges, so use Sandbox when testing.
Inputs
- Merge label doc option
merge_label_doc_optiontext - 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. If the value is 'LABELS_AND_DOCS', then merged (all shipping labels and shipping documents) pdf URL will be returned. If the value is 'LABELS_ONLY', merged (all shipping labels only) pdf URL will be returned. If the value is 'NONE', then no merged pdf URL will be returned. This is optional field and will default to LABELS_AND_DOCS. Note: If the value is 'LABELS_ONLY', then the returned merged pdf label will not be in the Base64 encoded format.One of:
NONE,LABELS_AND_DOCS(Labels and docs),LABELS_ONLY(Labels only). - Requested shipment
requested_shipmentobjectRequired - The descriptive data of the requested shipment.
- Label response options
label_response_optionstextRequired - LABEL - Indicates request is for encoded bytecode (Base64). URL_ONLY - Indicates label URL request. Note: For asynchronous shipment (more than 40 packages) requests only the value LABEL is supported. With URL_ONLY option, the URL once created will be active for 12 hours.One of:
URL_ONLY(Url only),LABEL. - Account number
account_numberobjectRequired - The account number associated with the shipment.
- Ship action
ship_actiontext - Indicate shipment action for the Shipment. CONFIRM - used in case of shipment submission TRANSFER - used in case of Email Label Shipment or Pending Shipment submission.One of:
CONFIRM,TRANSFER. - Processing option type
processing_option_typetext - Indicate the processing option for submitting a Single shot MPS shipment. The value indicates if the MPS to be processed synchronously or asynchronously. Note: Default value is SYNCHRONOUS_ONLY. Value or element is not needed when groupPackageCount is less than or equal to 40. Must provide element with value ALLOW_ASYNCHRONOUS when groupPackageCount is greater than 40. Example:ALLOW_ASYNCHRONUSOne of:
SYNCHRONOUS_ONLY(Synchronous only),ALLOW_ASYNCHRONOUS(Allow asynchronous). - One label at atime
one_label_at_atimetrue/false - 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.
- Version
versionobject - Returned value.
- Processing options
processing_optionslist - For shipments within the US and Canada: If you want the response to include pickup cost details (pickupRateDetail), make sure to: Set processingOptions to INCLUDE_PICKUPRATES For all other countries: Pickup charges are automatically included in the standard surcharge fields, so no extra setup is needed.One or more of:
INCLUDE_PICKUPRATES(Include pickuprates). - X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- Wrapper class for ShipShipmentOutputVO. It holds transactionId and output.
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"jobId": "example",
"transactionShipments": []
},
"transactionId": "example"
}
}Get package and service options
List the FedEx Express or FedEx Ground services and packaging types available between an origin and a destination, with subpackaging details.
Inputs
- Requested shipment
requested_shipmentobjectRequired - Returned value.
- Carrier codes
carrier_codeslist - "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. "One or more of:
FDXE,FDXG,FXFR,FXSP. - Account number
account_numberobject - Returned value.
- System of measure type
system_of_measure_typetext - This is system measurement type, such as Imperial or Metric.One of:
IMPERIAL,METRIC. - Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- This is a wrapper class for outputVO
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"advancedRegulatoryPackages": [],
"alerts": [],
"oneRate": false,
"packageOptions": [],
"serviceOptions": []
},
"transactionId": "example"
}
}Get pickup availability
Check whether FedEx pickup service is available.
Inputs
- Pickup address
pickup_addressobjectRequired - Returned value.
- Dispatch date
dispatch_datetext - 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. Example: 2020-01-01
- Package ready time
package_ready_timetext - 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. Example: 15:00:00
- Customer close time
customer_close_timetext - 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 time. Example: 18:00:00
- Pickup type
pickup_typetext - Indicate the pickup type method by which the shipment to be tendered to FedEx. Note: The value of this element does not specify dispatching the courier for package pickup. Click here for more information on Pickup Types.One of:
ON_CALL(On call),TAG. - Pickup request type
pickup_request_typelistRequired - Specify pickup request type.One or more of:
SAME_DAY(Same day),FUTURE_DAY(Future day). - Shipment attributes
shipment_attributesobject - Returned value.
- Number of business days
number_of_business_daysnumber - Specify number of business days to consider when checking availability. For example if you are indicating pickupDate for a Saturday and you indicate 3, Saturday, Sunday and Monday will be considered. Example: 3
- Package details
package_detailslist - This object is used to specify the package details.
- Associated account number
associated_account_numbertext - The associated account number, which will be invoiced for the pickup. Example:613787364.
- Associated account number type
associated_account_number_typetext - This represents a kind of legacy account number from a FedEx operating entity for the account number associated to the pickup. Valid values are: FEDEX_EXPRESS FEDEX_GROUNDOne of:
FEDEX_EXPRESS(Fedex express),FEDEX_GROUND(Fedex ground). - Carriers
carrierslistRequired - Specify the four letter code of a FedEx operating company thet meets your requirements. Examples of FedEx Operating Companies are: FDXE - FedEx Express FDXG - FedEx GroundOne or more of:
FDXE,FDXG. - Country relationship
country_relationshiptextRequired - Specify the country relationship among the shipments being picked up. Empty or incorrect values will result in to errors. Note: shipmentAttributes/serviceType is required for domestic or international pickup availabilities.One of:
DOMESTIC,INTERNATIONAL. - Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- This is a wrapper class for outputVO
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"options": [],
"requestTimestamp": "example"
},
"transactionId": "example"
}
}Get shipment results
Get the results of a large shipment (more than 40 packages) that was processed in the background, using its job ID.
Inputs
- Account number
account_numberobjectRequired - Returned value.
- Job ID
job_idtextRequired - Indicates the job under which the deferred shipment artifacts must be identified in the subsequent retrieval request. Example: 89sxxxxx233ae24ff31xxxxx
- Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - This transaction Id helps the customers to track the transaction with APIF.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- Wrapper class for GetOpenshipmentResultsOutputVo. It holds transactionId and output.
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"transactionShipments": []
},
"transactionId": "example"
}
}Get special service options
List the FedEx services, special service options, delivery signature options and return shipment types available between an origin and a destination. You can narrow the results by carrier or service type.
Inputs
- Requested shipment
requested_shipmentobjectRequired - Returned value.
- Account number
account_numberobject - Returned value.
- Carrier codes
carrier_codeslist - Optionally supplied to restrict the results to services for a specific carrier. Valid values are: FDXE, FDXG, FXSP. Example: ["FDXG", "FDXE"]One or more of:
FDXE,FDXG,FXSP,FXFR. - Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- This is a wrapper class for outputVO
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"serviceOptionsList": []
},
"transactionId": "example"
}
}Get transit times
Get the estimated transit times for a shipment.
Inputs
- Requested shipment
requested_shipmentobject - Provide shipment data details for which a transit time is desired.
- Carrier codes
carrier_codeslist - 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.One or more of:
FDXE,FDXG,FXSP. - Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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 transaction with APIF.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- Gives the transit time details of the shipment based on the request provided.
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"encoded": false,
"transitTimes": []
},
"transactionId": "example"
}
}Rate and transit times
Get rate quotes and, optionally, transit times for a shipment, based on where it goes from and to. Covers FedEx Ground and FedEx Express but not FedEx Freight. You can narrow the quotes by carrier, service type or service option.
Inputs
- Account number
account_numberobjectRequired - This is the Account number details. Note: If the paymentType is Sender, then the account number is optional in shippingChargesPayment.
- Rate request control parameters
rate_request_control_parametersobject - 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.
- Requested shipment
requested_shipmentobjectRequired - This is shipment data for which a rate quote (or rate-shipping comparison) is requested.
- Processing options
processing_optionslist - For shipments within the US and Canada: If you want the response to include pickup cost details (pickupRateDetail), make sure to: Set processingOptions to INCLUDE_PICKUPRATES For all other countries: Pickup charges are automatically included in the standard surcharge fields, so no extra setup is needed. .One or more of:
INCLUDE_PICKUPRATES(Include pickuprates). - Carrier codes
carrier_codeslist - Specify the four letter code of a FedEx operating company that meets your requirements. Example: FDXE FDXE - FedEx Express FDXG - FedEx Ground FXSP - FedEx SmartPost FXCC - FedEx Custom Critical.
- Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- This is a wrapper class for outputVO.
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"isEncoded": false,
"quoteDate": "example",
"rateReplyDetails": []
},
"transactionId": "example"
}
}Track by references
Get tracking details for a FedEx shipment using a reference other than its tracking number, such as a customer reference number.
Inputs
- References information
references_informationobjectRequired - Specifies the reference details for the tracked shipment. The following rules apply - Either shipper.AccountNumber or Destination.countryCode(and postal for postal aware countries) are required - If ShipDateRangeBegin and End are not present, shipDateRangeBegin will be set to the current date minus 30 days, and shipDdateRangeEnd will default to current date plus one day.
- Include detailed scans
include_detailed_scanstrue/false - Indicates if the detailed scans are being requested or not. If true, the detailed scans will be included in the response returned. Valid values are True or False.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- This is a wrapper class for outputVO
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"completeTrackResults": [],
"cxsErrors": [],
"successful": false
},
"transactionId": "example"
}
}Track by tracking control number
Get tracking details for a FedEx shipment using its transportation control number.
Inputs
- Tcn info
tcn_infoobjectRequired - Returned value.
- Include detailed scans
include_detailed_scanstrue/false - Indicates if detailed scans are requested or not. Valid values are True, or False.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- This is a wrapper class for outputVO
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"completeTrackResults": []
},
"transactionId": "example"
}
}Track by tracking number
Get tracking details for up to 30 FedEx packages by tracking number, across FedEx shipping services.
Inputs
- Tracking numbers
tracking_numberslistRequired - Returned value.
- Include detailed scans
include_detailed_scanstrue/false - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- This is a wrapper class for outputVO
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"completeTrackResults": []
},
"tracking_records": [],
"transactionId": "example"
}
}Track document
Request a signature proof of delivery: a letter that shows the recipient's signature.
Inputs
- Track document detail
track_document_detailobjectRequired - Returned value.
- Track document specification
track_document_specificationlistRequired - 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 number. At least one trackDocumentSpecification is required. Maximum limit is 30.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- This is a wrapper class for outputVO
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"document": [],
"documentFormat": "example",
"documentType": "example",
"localization": {
"languageCode": "example",
"localeCode": "example"
}
},
"transactionId": "example"
}
}Track multiple piece shipment
Get tracking details for the shipments linked to a tracking number, such as the pieces of a multiple-piece shipment or a return shipment linked to an outbound one.
Inputs
- Include detailed scans
include_detailed_scanstrue/false - Indicates if detailed scans are requested or not. Valid values are True, or False.
- Master tracking number info
master_tracking_number_infoobjectRequired - Returned value.
- Associated type
associated_typetextRequired - The associated shipment type, such as MPS, Group MPS, or an outbound shipment which is linked to a return shipment. Example: STANDARD_MPS STANDARD_MPS: Single shipment with multiple packages, where tracking number got assigned to all pieces, one tracking number is treated as master tracking number while others are child tracking numbers. Group MPS: Behavior is just like standard MPS but it’s created differently. The shipper must be enrolled for this by a particular reference type like ‘PO’ (purchase order).Then any package order create on the same day going to the same place that has the reference number will get grouped into GMPS relationships. OUTBOUND_LINK_TO_RETURN: is an RTRN relationship.Same concept as an MPS.the OUTBOUND_LINK_TO_RETURN is the Master outbound package tracking number, that when tracked with this indicator you can get all the child return pieces.One of:
OUTBOUND_LINK_TO_RETURN(Outbound link to return),STANDARD_MPS(Standard mps),GROUP_MPS(Group mps). - Paging details
paging_detailsobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- This is a wrapper class for outputVO
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"completeTrackResults": []
},
"transactionId": "example"
}
}Validate address
Check addresses against FedEx's reference data. Returns each address as FedEx resolves it and whether it matched a known address.
Inputs
- In effect as of timestamp
in_effect_as_of_timestamptext - 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 AddressValidation database is dynamic and stores historical data. Characteristics such as Business/Residential indicator may change over time. Example: 2019-09-06
- Validate address control parameters
validate_address_control_parametersobject - Specify the parameters applied to validate the address.
- Addresses to validate
addresses_to_validatelistRequired - 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. Note: Up to 100 of these can be submitted in a single request.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- Wrapper class for AddressResolutionOutputVO. It holds transactionId and output.
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"resolvedAddresses": []
},
"transactionId": "example"
}
}Validate postal
Check that a postal code is valid and see the service commitments for it, including city, country and origin-to-destination lookups.
Inputs
- Carrier code
carrier_codetextRequired - 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.One of:
FDXE,FDXG,FXSP,FDXC,FXCC. - Country code
country_codetextRequired - The two-letter code used to identify a country. Example:US Click here to see Country Codes
- State or province code
state_or_province_codetextRequired - This is the state or province code. Format and presence of this field will vary, depending on country. Example: US Click here to see State Or Province Code
- Postal code
postal_codetextRequired - 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 Click here to see Postal aware countries
- Ship date
ship_datedateRequired - 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
- Routing code
routing_codetext - 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
- Check for mismatch
check_for_mismatchtrue/false - 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.
- City
citytext - Name of the city associated with the postal code. Required when `countryCode` is `AU` (Australia).
- Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- Returned value.
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": [],
"cityFirstInitials": "example",
"cleanedPostalCode": "example",
"countryCode": "example",
"locationDescriptions": [],
"stateOrProvinceCode": "example"
},
"transactionId": "example"
}
}Validate shipment
Check a shipment for errors before you create it, so its details can be corrected before a label is printed. Works for single-piece Express, Ground and SmartPost shipments, domestic or international, but not Freight LTL.
Inputs
- Requested shipment
requested_shipmentobjectRequired - This is the detailed shipment request data to be validated before being submitted to FedEx.
- Account number
account_numberobject - The account number associated with the shipment.
- Version
versionobject - Returned value.
- X customer transaction ID
x_customer_transaction_idtext - 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.
- X locale
x_localetext - This indicates the combination of language code and country code. Click here to see Locales
Outputs
dataobject- Wrapper class for VerifyShipmentOutputVO. It holds transactionId and output.
Example output
{
"data": {
"customerTransactionId": "example",
"output": {
"alerts": []
},
"transactionId": "example"
}
}