External DocumentationTo learn more, visit the FedEx documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Account Number | The FedEx account number associated with the shipment. |
| Image Type | The image type for the shipping document image. |
| Label Response Options | The desired format for returning the shipping label and related documents in the response. |
| Label Stock Type | The label stock format to be used for printing the shipping label. |
| Package Line Items | An array of package attribute objects. Each object represents an individual package, a group of identical packages, or the shared characteristics of all packages in a multi-piece shipment. Each package have to include weight and dimensions. For example: For more information visit FedEx documentation. |
| Packaging Type | The packaging used for the shipment. For more information, visit FedEx documentation. |
| Pickup Type | The type of the pickup (e.g., drop off, scheduled pickup, or contact FedEx). |
| Recipients Address And Contact Details | A List of recipient locations where the shipment is to be delivered. Each recipient object must contain both address and contact information, providing full delivery and communication details for the destination. For example: For more information, visit FedEx documentation. |
| Service Type | The FedEx service type used for the shipment. For more information, visit FedEx documentation. |
| Shipper Address City | The city or town name for the shipper’s address. |
| Shipper Address Country Code | The two-letter country code associated with the shipper’s address. |
| Shipper Address Street Lines | The street address of the shipper’s location, including the street number, name, and any apartment or suite details. |
| Shipper Contact Phone Number | The shipper’s primary contact phone number. |
| Shipping Charges Payment Type | Select who and how the shipment charges will be paid. |
| Total Weight | The total weight of the entire shipment in pounds. Required for international shipments and should be specified on the first package of a multi-piece shipment. Note: Must be a number with one decimal place. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Additional Parameters | A JSON object for additional body parameters. Values specified in this parameter will override equivalent parameters. For example: |
| Customer Transaction ID | An ID to assign to the customer transaction. |
| Language Codes | The language and country code to use in the request. |
Example Output
{
"customerTransactionId": "AnyCo_order123456789",
"output": {
"alerts": [
{
"alertType": "NOTE",
"code": "SHIPMENT.VALIDATION.SUCCESS",
"message": "Shipment validated successfully. No errors found."
}
],
"jobId": "abc123456",
"transactionShipments": [
{
"alerts": [
{
"code": "RECIPIENTCONTACT.PHONENUMBER.INVALID",
"message": "Recipient’s phone number format is not matching with recipient's country code; hence, recipient will not receive Convenient Delivery Options. Moving forward, please provide valid mobile phone number."
}
],
"completedShipmentDetail": {
"accessDetail": {
"accessorDetails": [
{
"emailLabelUrl": "emailLabelUrl",
"password": "password",
"role": "role",
"userId": "userId"
}
]
},
"carrierCode": "FDXE",
"completedEtdDetail": {
"folderId": "0b0493e580dc1a1b",
"type": "COMMERCIAL_INVOICE",
"uploadDocumentReferenceDetails": [
{
"description": "PRO FORMA INVOICE",
"documentId": "090927d680038c61",
"documentReference": "DocumentReference",
"documentType": "PRO_FORMA_INVOICE"
}
]
},
"completedHoldAtLocationDetail": {
"holdingLocation": {
"address": {
"city": "Beverly Hills",
"countryCode": "US",
"postalCode": "38127",
"residential": false,
"stateOrProvinceCode": "CA",
"streetLines": [
"10 FedEx Parkway",
"Suite 302"
]
},
"contact": {
"companyName": "Specify company name.",
"emailAddress": "Specify email address.\u003cbr\u003eExample: sample@company.com",
"personName": "John",
"phoneExtension": "The shipper's phone extension. Max length is 6.\u003cbr\u003eExample: 91",
"phoneNumber": "The shippers phone number. \u003cbr\u003eMinimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers.\u003cbr\u003eNote: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of 1 or +1.\u003cbr\u003eExample: 918xxxxx890"
}
},
"holdingLocationType": "FEDEX_STAFFED"
},
"completedPackageDetails": [
{
"dryIceWeight": {
"units": "KG",
"value": 68
},
"groupNumber": 567,
"hazardousPackageDetail": {
"accessibility": "ACCESSIBLE",
"cargoAircraftOnly": true,
"containers": [
{
"QValue": 2,
"hazardousCommodities": [
{
"description": {
"attributes": [
"attributes"
],
"authorization": "authorization",
"hazardClass": "hazardClass",
"id": "1234",
"labelText": "labelText",
"packingGroup": "packingGroup",
"packingInstructions": "packingInstructions",
"properShippingName": "properShippingName",
"properShippingNameAndDescription": "properShippingNameAndDescription",
"sequenceNumber": 876,
"specialProvisions": "specialProvisions",
"subsidiaryClasses": [
"Subsidiary Classes"
],
"symbols": "symbols",
"technicalName": "technicalName",
"tunnelRestrictionCode": "UN2919"
},
"massPoints": 2,
"netExplosiveDetail": {
"amount": 10,
"type": "NET_EXPLOSIVE_WEIGHT",
"units": "units"
},
"options": {
"customerSuppliedLabelText": "Customer Supplied Label Text",
"labelTextOption": "STANDARD"
},
"quantity": {
"amount": 24.56,
"quantityType": "GROSS",
"units": "Kg"
}
}
]
}
],
"labelType": "II_YELLOW",
"radioactiveTransportIndex": 2.45,
"referenceId": "123456",
"regulation": "IATA"
},
"operationalDetail": {
"astraHandlingText": "astraHandlingText",
"barcodes": {
"binaryBarcodes": [
{
"type": "COMMON-2D",
"value": "This is the value."
}
],
"stringBarcodes": [
{
"type": "ADDRESS",
"value": "1010062512241535917900794953544894"
}
]
},
"operationalInstructions": [
{
"content": "content",
"number": 17
}
]
},
"oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
"packageRating": {
"actualRateType": "PAYOR_ACCOUNT_PACKAGE",
"effectiveNetDiscount": 0,
"packageRateDetails": [
{
"baseCharge": 45.67,
"billingWeight": {
"units": "KG",
"value": 68
},
"currency": "USD",
"minimumChargeType": "CUSTOMER",
"netCharge": 121.56,
"netFedExCharge": 12.56,
"netFreight": 4.89,
"rateType": "PAYOR_RETAIL_PACKAGE",
"ratedWeightMethod": "DIM",
"surcharges": [
{
"amount": "56.22",
"description": "description",
"level": "PACKAGE, or SHIPMENT",
"surchargeType": "APPOINTMENT_DELIVERY"
}
],
"totalFreightDiscounts": 44.55,
"totalRebates": 4.56,
"totalSurcharges": 22.56,
"totalTaxes": 3.45
}
]
},
"sequenceNumber": 256,
"signatureOption": "DIRECT",
"trackingIds": [
{
"formId": "0201",
"trackingIdType": "EXPRESS",
"trackingNumber": "49092000070120032835",
"uspsApplicationId": "92"
}
]
}
],
"documentRequirements": {
"generationDetails": [
{
"electronicSignature": "OPTIONAL",
"letterhead": "OPTIONAL",
"minimumCopiesRequired": 3,
"type": "COMMERCIAL_INVOICE"
}
],
"prohibitedDocuments": [
"CERTIFICATE_OF_ORIGIN"
],
"requiredDocuments": [
"COMMERCIAL_OR_PRO_FORMA_INVOICE",
"AIR_WAYBILL"
]
},
"exportComplianceStatement": "12345678901234567",
"hazardousShipmentDetail": {
"adrLicense": {
"licenseOrPermitDetail": {
"effectiveDate": "2019-08-09",
"expirationDate": "2019-04-09",
"number": "12345"
}
},
"dryIceDetail": {
"packageCount": 10,
"processingOptions": {
"options": [
"options"
]
},
"totalWeight": {
"units": "KG",
"value": 68
}
},
"hazardousSummaryDetail": {
"smallQuantityExceptionPackageCount": 10
}
},
"masterTrackingId": {
"formId": "0201",
"trackingIdType": "EXPRESS",
"trackingNumber": "49092000070120032835",
"uspsApplicationId": "92"
},
"operationalDetail": {
"airportId": "DFW",
"astraDescription": "SMART POST",
"astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
"commitDate": "2019-10-15",
"commitDay": "TUE",
"countryCode": "US",
"customTransitTime": "ONE_DAY",
"deliveryDate": "2001-04-05",
"deliveryDay": "TUE",
"deliveryEligibilities": [
"deliveryEligibilities"
],
"destinationLocationId": "DALA",
"destinationLocationNumber": 876,
"destinationLocationStateOrProvinceCode": "GA",
"destinationServiceArea": "A1",
"ineligibleForMoneyBackGuarantee": true,
"maximumTransitTime": "SEVEN_DAYS",
"originLocationId": "678",
"originLocationNumber": 243,
"originServiceArea": "A1",
"packagingCode": "03",
"postalCode": "38010",
"publishedDeliveryTime": "10:30A",
"scac": "scac",
"serviceCode": "010",
"stateOrProvinceCode": "GA",
"transitTime": "TWO_DAYS",
"ursaPrefixCode": "XH",
"ursaSuffixCode": "Ga"
},
"packagingDescription": "Customer Packaging",
"serviceDescription": {
"astraDescription": "2 DAY FRT",
"code": "80",
"description": "description",
"names": [
{
"encoding": "UTF-8",
"type": "long",
"value": "F-2"
}
],
"operatingOrgCodes": [
"FXE"
],
"serviceCategory": "freight",
"serviceId": "EP1000000027",
"serviceType": "FEDEX_1_DAY_FREIGHT"
},
"shipmentRating": {
"actualRateType": "PAYOR_LIST_SHIPMENT",
"pickupRateDetail": {
"ancillaryFeesAndTaxes": [
{
"amount": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"description": "description",
"type": "CLEARANCE_ENTRY_FEE"
}
],
"currencyExchangeRate": {
"fromCurrency": "Rupee",
"intoCurrency": "USD",
"rate": 25.6
},
"dutiesAndTaxes": [
{
"harmonizedCode": "harmonizedCode",
"taxes": {
"amount": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"appliedPreferentialTradeAgreement": {
"description": "description",
"id": "description",
"name": "description"
},
"description": "Christmas",
"effectiveDate": "2019-12-06",
"formula": "VAT Payable = Output VAT – Input VAT",
"name": "VAT",
"taxRates": [
{
"currency": "string",
"quantity": 0,
"unitOfMeasure": "string",
"value": "string"
}
],
"taxType": "INCENTIVE",
"taxableValue": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"taxcode": "taxcode"
},
"total": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
}
}
],
"freightDiscounts": [
{
"amount": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"description": "description",
"percent": 0,
"rateDiscountType": "INCENTIVE"
}
],
"fuelSurchargePercent": 121,
"minimumChargeType": "EARNED_DISCOUNT",
"pickupBaseChargeDescription": "Pickup Area Surcharge",
"pricingCode": "ACTUAL",
"rateScale": "*USER IMS20160104 LD067110",
"rateType": "PAYOR_ACCOUNT_PACKAGE",
"rateZone": "CA003O",
"ratingBasis": "SHIPMENT_WEIGHT_BASED",
"rebates": [
{
"amount": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"description": "description",
"percent": 0,
"rebateType": "EARNED"
}
],
"specialRatingApplied": "FEDEX_ONE_RATE",
"surcharges": [
{
"amount": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"description": "description",
"level": "PACKAGE",
"surchargeType": "COD"
}
],
"taxes": [
{
"amount": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"description": "description",
"taxType": "VAT"
}
],
"totalAncillaryFeesAndTaxes": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalBaseCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalDutiesAndTaxes": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalDutiesTaxesAndFees": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalFreightDiscounts": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalNetCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalNetChargeWithDutiesAndTaxes": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalNetFedExCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalNetFreight": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalRebates": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalSurcharges": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalTaxes": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalVariableHandlingCharges": {
"fixedVariableHandlingCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"percentVariableHandlingCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalCustomerCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"variableHandlingCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
}
},
"variableHandlingCharges": {
"fixedVariableHandlingCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"percentVariableHandlingCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalCustomerCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"variableHandlingCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
}
}
},
"shipmentRateDetails": [
{
"currency": "USD",
"currencyExchangeRate": {
"fromCurrency": "Rupee",
"intoCurrency": "USD",
"rate": 25.6
},
"dimDivisor": 0,
"freightDiscounts": [
{
"amount": 8.9,
"description": "description",
"percent": 28.9,
"rateDiscountType": "COUPON"
}
],
"fuelSurchargePercent": 4.56,
"pricingCode": "LTL_FREIGHT",
"rateScale": "00000",
"rateType": "RATED_ACCOUNT_SHIPMENT",
"rateZone": "US001O",
"ratedWeightMethod": "ACTUAL",
"shipmentLegRateDetails": [
{
"currency": "USD",
"currencyExchangeRate": {
"fromCurrency": "Rupee",
"intoCurrency": "USD",
"rate": 25.6
},
"dimDivisor": 6,
"dimDivisorType": "dimDivisorType",
"freightDiscounts": [
{
"amount": 8.9,
"description": "description",
"percent": 28.9,
"rateDiscountType": "COUPON"
}
],
"fuelSurchargePercent": 6,
"legDestinationLocationId": "legDestinationLocationId",
"minimumChargeType": "minimumChargeType",
"pricingCode": "pricingCode",
"rateScale": "6702",
"rateType": "PAYOR_RETAIL_PACKAGE",
"rateZone": "rateZone",
"ratedWeightMethod": "ratedWeightMethod",
"surcharges": [
{
"amount": "56.22",
"description": "description",
"level": "PACKAGE, or SHIPMENT",
"surchargeType": "APPOINTMENT_DELIVERY"
}
],
"taxes": [
{
"amount": 10,
"description": "description",
"level": "level",
"type": "type"
}
],
"totalBaseCharge": 6,
"totalBillingWeight": {
"units": "KG",
"value": 68
},
"totalDimWeight": {
"units": "KG",
"value": 68
},
"totalDutiesAndTaxes": 17.78,
"totalFreightDiscounts": 9,
"totalNetCharge": 253,
"totalNetChargeWithDutiesAndTaxes": 25.67,
"totalNetFedExCharge": 3.2,
"totalNetFreight": 6,
"totalRebates": 2,
"totalSurcharges": 5,
"totalTaxes": 12.6
}
],
"surcharges": [
{
"amount": "56.22",
"description": "description",
"level": "PACKAGE, or SHIPMENT",
"surchargeType": "APPOINTMENT_DELIVERY"
}
],
"taxes": [
{
"amount": 10,
"description": "description",
"level": "level",
"type": "type"
}
],
"totalAncillaryFeesAndTaxes": 5.67,
"totalBaseCharge": 234.56,
"totalBillingWeight": {
"units": "KG",
"value": 68
},
"totalDutiesAndTaxes": 6.78,
"totalDutiesTaxesAndFees": 24.56,
"totalFreightDiscounts": 1.56,
"totalNetCharge": 3.78,
"totalNetChargeWithDutiesAndTaxes": 222.56,
"totalNetFedExCharge": 88.56,
"totalNetFreight": 9.56,
"totalRebates": 1.98,
"totalSurcharges": 9.88,
"totalTaxes": 3.45
}
],
"totalNetFedExTransportationAndPickupCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
},
"totalNetTransportationAndPickupCharge": {
"currency": "USD",
"value": "CUSTOMS_VALUE"
}
},
"usDomestic": true
},
"masterTrackingNumber": "794953535000",
"pieceResponses": [
{
"acceptanceTrackingNumber": "794953535000",
"acceptanceType": "acceptanceType",
"additionalChargesDiscount": 621.45,
"baseRateAmount": 321.45,
"codCollectionAmount": 231.45,
"customerReferences": [
{
"customerReferenceType": "DEPARTMENT_NUMBER",
"value": "3686"
}
],
"deliveryTimestamp": "2012-09-23",
"listCustomerTotalCharge": "listCustomerTotalCharge",
"listRateAmount": 1.45,
"masterTrackingNumber": "794953535000",
"netChargeAmount": 21.45,
"netDiscountAmount": 121.45,
"packageDocuments": [
{
"alerts": [
{
"alertType": "NOTE",
"code": "SHIPMENT.VALIDATION.SUCCESS",
"message": "Shipment validated successfully. No errors found."
}
],
"contentKey": "content key",
"contentType": "COMMERCIAL_INVOICE",
"copiesToPrint": 10,
"docType": "PDF",
"encodedLabel": "encoded label",
"trackingNumber": "794953535000",
"url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true\u0026autoPrint=false"
}
],
"packageSequenceNumber": 215,
"serviceCategory": "EXPRESS",
"trackingIdType": "FEDEX",
"trackingNumber": "794953535000"
}
],
"serviceCategory": "EXPRESS",
"serviceName": "FedEx 2 Day Freight",
"serviceType": "STANDARD_OVERNIGHT",
"shipDatestamp": "2010-03-04",
"shipmentAdvisoryDetails": {
"regulatoryAdvisory": {
"prohibitions": [
{
"advisory": {
"code": "code",
"localizedText": "localizedText",
"parameters": [
{
"id": "message ID",
"value": "Message value"
}
],
"text": "Text"
},
"categories": [
"categories"
],
"commodityIndex": 12,
"derivedHarmonizedCode": "01",
"source": "source",
"status": "status",
"type": "type",
"waiver": {
"advisories": [
{
"code": "code",
"localizedText": "localizedText",
"parameters": [
{
"id": "message ID",
"value": "Message value"
}
],
"text": "Text"
}
],
"description": "description",
"id": "id"
}
}
]
}
},
"shipmentDocuments": [
{
"alerts": [
{
"alertType": "NOTE",
"code": "SHIPMENT.VALIDATION.SUCCESS",
"message": "Shipment validated successfully. No errors found."
}
],
"contentKey": "content key",
"contentType": "COMMERCIAL_INVOICE",
"copiesToPrint": 10,
"docType": "PDF",
"encodedLabel": "encoded label",
"trackingNumber": "794953535000",
"url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true\u0026autoPrint=false"
}
]
}
]
},
"transactionId": "624deea6-b709-470c-8c39-4b5511281492"
}
Workflow Library Example
Create Shipment with Fedex and Send Results Via Email