{
"openapi": "3.0.0",
"info": {
"title": "Rates and Transit Times API",
"version": "1.0.0"
},
"servers": [
{
"url": "/"
}
],
"paths": {
"/rate/v1/rates/quotes": {
"post": {
"summary": "Rate and Transit times",
"description": "This endpoint provides the ability to retrieve rate quotes and optionalll transit information. The rate is calculated based on the origin and destination of the shipment. Additional information such as carrier code, service type, or service option can be used to filter the results. If carrier code is provided, the response includes the rate quotes for the specific transportation carrier. This endpoint provides the rates for FedEx Ground and FedEx Express and does not offer rates for FedEx Freight.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.",
"operationId": "Rate and Transit times",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/body"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RatcResponseVO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO"
},
"example": {
"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"errors": [
{
"code": "ACCOUNT.NUMBER.MISMATCH",
"message": "When payment Type is SENDER, ShippingChargesPayment Payor AccountNumber should match the shipper account number."
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO401"
},
"example": {
"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"errors": [
{
"code": "NOT.AUTHORIZED.ERROR",
"message": "Access token expired. Please modify your request and try again."
}
]
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO403"
},
"example": {
"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"errors": [
{
"code": "FORBIDDEN.ERROR",
"message": "We could not authorize your credentials. Please check your permissions and try again."
}
]
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO404"
},
"example": {
"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"errors": [
{
"code": "NOT.FOUND.ERROR",
"message": "The resource you requested is no longer available. Please modify your request and try again."
}
]
}
}
}
},
"500": {
"description": "Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO500"
},
"example": {
"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"errors": [
{
"code": "INTERNAL.SERVER.ERROR",
"message": "We encountered an unexpected error and are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
}
]
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseVO503"
},
"example": {
"transactionId": "08f37269-2fcf-4a52-8f02-01c8349d143f",
"errors": [
{
"code": "SERVICE.UNAVAILABLE.ERROR",
"message": "The service is currently unavailable and we are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
}
]
}
}
}
}
},
"parameters": [
{
"in": "header",
"name": "x-customer-transaction-id",
"description": "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.",
"required": false,
"schema": {
"type": "string",
"example": "624deea6-b709-470c-8c39-4b5511281492"
}
},
{
"in": "header",
"name": "content-type",
"description": "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.",
"required": true,
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"in": "header",
"name": "x-locale",
"description": "This indicates the combination of language code and country code. Click here to see Locales",
"required": false,
"schema": {
"type": "string",
"example": "en_US"
}
},
{
"in": "header",
"name": "authorization",
"description": "This indicates the authorization token for the input request.",
"required": true,
"schema": {
"type": "string",
"example": "Bearer XXX"
}
}
],
"x-code-samples": [
{
"lang": "C#",
"source": "var client = new RestClient(\"https://apis-sandbox.fedex.com/rate/v1/rates/quotes\");\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Bearer \");\nrequest.AddHeader(\"X-locale\", \"en_US\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\n// 'input' refers to JSON Payload\nrequest.AddParameter(\"application/x-www-form-urlencoded\", input, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\n\n\n\n\n"
},
{
"lang": "JAVA",
"source": "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\n// 'input' refers to JSON Payload\nRequestBody body = RequestBody.create(mediaType, input);\nRequest request = new Request.Builder()\n .url(\"https://apis-sandbox.fedex.com/rate/v1/rates/quotes\")\n .post(body)\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"X-locale\", \"en_US\")\n .addHeader(\"Authorization\", \"Bearer \")\n .build();\n \nResponse response = client.newCall(request).execute();"
},
{
"lang": "JAVASCRIPT",
"source": "// 'input' refers to JSON Payload\nvar data = JSON.stringify(input);\n \n var xhr = new XMLHttpRequest();\n xhr.withCredentials = true;\n \n xhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === 4) {\n console.log(this.responseText);\n }\n });\n \n xhr.open(\"POST\", \"https://apis-sandbox.fedex.com/rate/v1/rates/quotes\");\n xhr.setRequestHeader(\"Content-Type\", \"application/json\");\n xhr.setRequestHeader(\"X-locale\", \"en_US\");\n xhr.setRequestHeader(\"Authorization\", \"Bearer \");\n \n xhr.send(data);"
},
{
"lang": "PHP",
"source": "setUrl('https://apis-sandbox.fedex.com/rate/v1/rates/quotes');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders(array(\n 'Authorization' => 'Bearer ',\n 'X-locale' => 'en_US',\n 'Content-Type' => 'application/json'\n));\n\n$request->setBody(input); // 'input' refers to JSON Payload\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"
},
{
"lang": "PYTHON",
"source": "import requests\n\nurl = \"https://apis-sandbox.fedex.com/rate/v1/rates/quotes\"\n\npayload = input # 'input' refers to JSON Payload\nheaders = {\n 'Content-Type': \"application/json\",\n 'X-locale': \"en_US\",\n 'Authorization': \"Bearer \"\n }\n\nresponse = requests.post(url, data=payload, headers=headers)\n\nprint(response.text)"
},
{
"lang": "RUST",
"source": "extern crate reqwest;\n\nuse std::io::Read;\n\nfn construct_headers() -> HeaderMap {\n let mut headers = HeaderMap::new();\n headers.insert(\"Content-Type\", \"application/json\");\n headers.insert(\"X-locale\", \"en_US\");\n headers.insert(\"Authorization\", \"Bearer \");\n headers\n}\n\nfn run() -> Result<()> {\n let client = reqwest::Client::new();\n let mut res = client.post(\"https://apis-sandbox.fedex.com/rate/v1/rates/quotes\")\n .body(input) // 'input' refers to JSON Payload\n .headers(construct_headers())\n .send()?;\n let mut body = String::new();\n res.read_to_string(&mut body)?;\n\n println!(\"Status: {}\", res.status());\n println!(\"Headers:\\n{:#?}\", res.headers());\n println!(\"Body:\\n{}\", body);\n\n Ok(())\n}"
},
{
"lang": "SWIFT",
"source": "import Foundation\n\nlet headers = [\n \"Content-Type\": \"application/json\",\n \"X-locale\": \"en_US\",\n \"Authorization\": \"Bearer \"\n]\nlet parameters = [\n input // 'input' refers to JSON Payload\n] as [String : Any]\n\nlet postData = JSONSerialization.data(withJSONObject: parameters, options: [])\n\nlet request = NSMutableURLRequest(url: NSURL(string: \"https://apis-sandbox.fedex.com/rate/v1/rates/quotes\")! as URL,\n cachePolicy: .useProtocolCachePolicy,\n timeoutInterval: 10.0)\nrequest.httpMethod = \"POST\"\nrequest.allHTTPHeaderFields = headers\nrequest.httpBody = postData as Data\n\nlet session = URLSession.shared\nlet dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in\n if (error != nil) {\n print(error)\n } else {\n let httpResponse = response as? HTTPURLResponse\n print(httpResponse)\n }\n})\n\ndataTask.resume()"
}
]
}
}
},
"components": {
"schemas": {
"EdtCommodityTax": {
"description": "The shipment/package Duties and taxes.",
"type": "object",
"properties": {
"harmonizedCode": {
"description": "Harmonized code is used by customer to classify the product being shipped and define the duties and taxes to be paid.",
"type": "string",
"example": "harmonizedCode"
},
"taxes": {
"$ref": "#/components/schemas/EdtTaxDetail_1"
},
"total": {
"description": "Total of Duties and taxes",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
}
}
},
"EdtTaxDetail_1": {
"description": "Estimated duties and taxes detail.",
"type": "object",
"properties": {
"taxType": {
"description": "Estimated taxes type",
"type": "string",
"enum": [
"ADDITIONAL_TAXES",
"CONSULAR_INVOICE_FEE",
"CUSTOMS_SURCHARGES",
"DUTY",
"EXCISE_TAX",
"FOREIGN_EXCHANGE_TAX",
"GENERAL_SALES_TAX",
"IMPORT_LICENSE_FEE",
"INTERNAL_ADDITIONAL_TAXES",
"INTERNAL_SENSITIVE_PRODUCTS_TAX",
"OTHER",
"SENSITIVE_PRODUCTS_TAX",
"STAMP_TAX",
"STATISTICAL_TAX",
"TRANSPORT_FACILITIES_TAX"
],
"example": "INCENTIVE"
},
"taxcode": {
"type": "string",
"example": "taxcode"
},
"effectiveDate": {
"description": "Estimated duties and taxes effective date. Format [YYYY-MM-DD].",
"type": "string",
"example": "2019-12-06"
},
"name": {
"description": "The localized name of the surcharge.",
"type": "string",
"example": "VAT"
},
"taxableValue": {
"description": "Estimated duties and taxes taxable Value.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"description": {
"description": "FedEx pays the Duty and Tax charges on your behalf to ensure we can deliver your shipment as quickly as possible",
"type": "string",
"example": "Christmas"
},
"formula": {
"description": "Indicates the formula.",
"type": "string",
"example": "VAT Payable = Output VAT – Input VAT"
},
"amount": {
"description": "Amount for the estimated duties and taxes type.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"taxRates": {
"description": "Estimated duties and taxes taxRates",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": null
},
"currency": {
"type": "string",
"example": null
},
"quantity": {
"format": "double",
"type": "number",
"example": null
},
"unitOfMeasure": {
"type": "string",
"example": null
}
}
}
},
"appliedPreferentialTradeAgreement": {
"description": "provides details about PTA applied between countries for specific product. ",
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"example": "description"
},
"name": {
"description": "",
"type": "string",
"example": "description"
},
"description": {
"description": "",
"type": "string",
"example": "description"
}
}
}
}
},
"VariableHandlingCharges_1": {
"description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail.",
"type": "object",
"properties": {
"variableHandlingCharge": {
"description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"fixedVariableHandlingCharge": {
"description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"percentVariableHandlingCharge": {
"description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalCustomerCharge": {
"description": "Specifies the total customer assessed handling charges.
Example: 445.54",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
}
}
},
"AncillaryFeeAndTax": {
"description": "Identifies the total amount of the shipment-lvel fees and taxes that are not based on transportation charges of commodity-level estimated duties and taxes.",
"type": "object",
"properties": {
"type": {
"description": "Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.",
"type": "string",
"enum": [
"CLEARANCE_ENTRY_FEE",
"GOODS_AND_SERVICES_TAX",
"HARMONIZED_SALES_TAX",
"OTHER"
],
"example": "CLEARANCE_ENTRY_FEE"
},
"description": {
"description": "Identifies the amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.",
"type": "string",
"example": "description"
},
"amount": {
"description": "list of AncillaryFees And Taxes",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
}
}
},
"RateDiscount_2": {
"type": "object",
"properties": {
"rateDiscountType": {
"description": "Indicates the type.",
"type": "string",
"enum": [
"BONUS",
"COUPON",
"EARNED",
"INCENTIVE",
"OTHER",
"VOLUME"
],
"example": "INCENTIVE"
},
"description": {
"description": "Indicates the description for the rate discount.",
"type": "string",
"example": "description"
},
"amount": {
"description": "Indicates the amount for the rate discount.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"percent": {
"format": "double",
"type": "number",
"example": 0
}
}
},
"Rebate": {
"type": "object",
"properties": {
"rebateType": {
"description": "The type of rebate.",
"type": "string",
"enum": [
"BONUS",
"EARNED",
"OTHER"
],
"example": "EARNED"
},
"description": {
"description": "The description of the rebate",
"type": "string",
"example": "description"
},
"amount": {
"description": "provides the calculated rebate amount based on customer details, transaction information, and applicable rules. ",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"percent": {
"format": "double",
"type": "number",
"example": 0
}
}
},
"Surcharge_2": {
"type": "object",
"properties": {
"surchargeType": {
"description": "The type of surcharge.",
"type": "string",
"enum": [
"ACCOUNT_NUMBER_PROCESSING_FEE",
"ADDITIONAL_HANDLING",
"ADDRESS_CORRECTION",
"ANCILLARY_FEE",
"APPOINTMENT_DELIVERY",
"BLIND_SHIPMENT",
"BROKER_SELECT_OPTION",
"CANADIAN_DESTINATION",
"CHARGEABLE_PALLET_WEIGHT",
"COD",
"CUT_FLOWERS",
"DANGEROUS_GOODS",
"DELIVERY_AREA",
"DELIVERY_CONFIRMATION",
"DELIVERY_ON_INVOICE_ACCEPTANCE",
"DEMAND",
"DEMAND_ADDITIONAL_HANDLING",
"DEMAND_OVERSIZE",
"DEMAND_RESIDENTIAL_DELIVERY",
"DETENTION",
"DOCUMENTATION_FEE",
"DRY_ICE",
"EMAIL_LABEL",
"ENHANCED_SECURITY",
"EUROPE_FIRST",
"EXCESS_VALUE",
"EXCLUSIVE_USE",
"EXHIBITION",
"EXPEDITED",
"EXPORT",
"EXTRA_LABOR",
"EXTRA_SURFACE_HANDLING_CHARGE",
"EXTREME_LENGTH",
"FEDEX_INTRACOUNTRY_FEES",
"FEDEX_TAG",
"FICE",
"FLATBED",
"FREIGHT_DIRECT_BASIC_BY_APPOINTMENT_DELIVERY",
"FREIGHT_DIRECT_BASIC_BY_APPOINTMENT_PICKUP",
"FREIGHT_DIRECT_BASIC_DELIVERY",
"FREIGHT_DIRECT_BASIC_PICKUP",
"FREIGHT_DIRECT_PREMIUM_DELIVERY",
"FREIGHT_DIRECT_PREMIUM_PICKUP",
"FREIGHT_DIRECT_STANDARD_DELIVERY",
"FREIGHT_DIRECT_STANDARD_PICKUP",
"FREIGHT_GUARANTEE",
"FREIGHT_ON_VALUE",
"FREIGHT_TO_COLLECT",
"FUEL",
"HIGH_COST_SERVICE_AREA_DESTINATION",
"HIGH_COST_SERVICE_AREA_ORIGIN",
"HIGH_DENSITY",
"HOLD_AT_LOCATION",
"HOLIDAY_DELIVERY",
"HOLIDAY_GUARANTEE",
"HOME_DELIVERY_APPOINTMENT",
"HOME_DELIVERY_DATE_CERTAIN",
"HOME_DELIVERY_EVENING",
"INSIDE_DELIVERY",
"INSIDE_PICKUP",
"INSURED_VALUE",
"INTERHAWAII",
"LIFTGATE_DELIVERY",
"LIFTGATE_PICKUP",
"LIMITED_ACCESS_DELIVERY",
"LIMITED_ACCESS_PICKUP",
"MARKING_OR_TAGGING",
"METRO_DELIVERY",
"METRO_PICKUP",
"MONITORING_AND_INTERVENTION",
"NON_BUSINESS_TIME",
"NON_MACHINABLE",
"OFFSHORE",
"ON_CALL_PICKUP",
"ON_DEMAND_CARE",
"OTHER",
"OUT_OF_DELIVERY_AREA",
"OUT_OF_PICKUP_AREA",
"OVER_DIMENSION",
"OVER_LENGTH",
"OVERSIZE",
"OVERWEIGHT",
"PALLET_SHRINKWRAP",
"PALLETS_PROVIDED",
"PEAK",
"PEAK_ADDITIONAL_HANDLING",
"PEAK_OVERSIZE",
"PEAK_RESIDENTIAL_DELIVERY",
"PERMIT",
"PIECE_COUNT_VERIFICATION",
"PORT",
"PRE_DELIVERY_NOTIFICATION",
"PRIORITY_ALERT",
"PROTECTION_FROM_FREEZING",
"REGIONAL_MALL_DELIVERY",
"REGIONAL_MALL_PICKUP",
"REROUTE",
"RESCHEDULE",
"RESIDENTIAL_DELIVERY",
"RESIDENTIAL_PICKUP",
"RETURN_LABEL",
"SATURDAY_DELIVERY",
"SATURDAY_PICKUP",
"SHIPMENT_ASSEMBLY",
"SIGNATURE_OPTION",
"SINGLE_PIECE",
"SORT_AND_SEGREGATE",
"SPECIAL_DELIVERY",
"SPECIAL_EQUIPMENT",
"STORAGE",
"SUNDAY_DELIVERY",
"TARP",
"THIRD_PARTY_BILLING",
"THIRD_PARTY_CONSIGNEE",
"TRANSMART_SERVICE_FEE",
"USPS",
"WEIGHING"
],
"example": "COD"
},
"level": {
"description": "The level of surcharge.",
"type": "string",
"enum": [
"PACKAGE",
"SHIPMENT"
],
"example": "PACKAGE"
},
"description": {
"description": "The description of the surcharge.",
"type": "string",
"example": "description"
},
"amount": {
"description": "Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
}
}
},
"PickupDetail": {
"type": "object",
"description": "- 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.
.",
"properties": {
"readyDateTime": {
"type": "string",
"format": "date",
"description": "Pickup ready date in YYYY-MM-DD format.",
"example": "2025-06-17"
},
"latestPickupDateTime": {
"type": "string",
"format": "date",
"description": "Latest pickup date in YYYY-MM-DD format.",
"example": "2025-06-17"
},
"courierInstructions": {
"type": "string",
"description": "Special instructions for the courier",
"example": "Leave package at reception"
},
"requestType": {
"$ref": "#/components/schemas/PickupRequestType"
},
"requestSource": {
"$ref": "#/components/schemas/PickupRequestSourceType"
}
}
},
"PickupRequestType": {
"type": "string",
"description": "Type of pickup request",
"enum": [
"FUTURE_DAY",
"SAME_DAY"
],
"example": "FUTURE_DAY"
},
"PickupRequestSourceType": {
"type": "string",
"description": "Source of the pickup request",
"enum": [
"AUTOMATION",
"CUSTOMER_SERVICE"
],
"example": "AUTOMATION"
},
"Tax_2": {
"description": "Tax surcharge details",
"type": "object",
"properties": {
"taxType": {
"description": "Specifies the type of Surcharge/Tax.",
"type": "string",
"enum": [
"EXPORT",
"GST",
"HST",
"INTRACOUNTRY",
"OTHER",
"PST",
"SST",
"VAT"
],
"example": "VAT"
},
"description": {
"description": "Specifies the description of the Surcharge/Tax.",
"type": "string",
"example": "description"
},
"amount": {
"description": "Specifies the list of tax amounts.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
}
}
},
"RatcResponseVO": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "The transaction ID is a special set of numbers that defines each transaction.
Example: 624deea6-b709-470c-8c39-4b5511281492",
"example": "624deea6-b709-470c-8c39-4b5511281492"
},
"customerTransactionId": {
"type": "string",
"description": "This element has a unique identifier added in your request, helps you match the request to the reply.
Example: XXXX_XXX123XXXXX",
"example": "AnyCo_order123456789"
},
"output": {
"$ref": "#/components/schemas/BaseProcessOutputVO"
}
},
"description": "This is a wrapper class for outputVO."
},
"BaseProcessOutputVO": {
"$ref": "#/components/schemas/RateOutputVO"
},
"RateOutputVO": {
"type": "object",
"properties": {
"rateReplyDetails": {
"type": "array",
"description": "This object will hold the rate and shipment data returned for a request.",
"items": {
"$ref": "#/components/schemas/RateReplyDetail"
}
},
"quoteDate": {
"type": "string",
"description": "The date on which the rate is quoted.
Example: 2019-09-18",
"example": "2019-12-18"
},
"isEncoded": {
"type": "boolean",
"description": "Specifies the encoded form of the rate.
Example: false",
"example": false
},
"alerts": {
"type": "array",
"description": "The alert code, alert type, and alert message obtained when a rate quote is requested.",
"items": {
"$ref": "#/components/schemas/Alert"
}
}
},
"description": "This is the response object for a rate quote request.",
"example": {
"rateReplyDetails": [
{
"serviceType": "INTERNATIONAL_FIRST",
"serviceName": "FedEx International First",
"packagingType": "YOUR_PACKAGING",
"customerMessages": [
{
"code": "SERVICE.TYPE.INTERNATIONAL.MESSAGE",
"message": "Rate does not include duties & taxes, clearance entry fees or other import fees. The payor of duties/taxes/fees will be responsible for any applicable Clearance Entry Fees."
},
{
"code": "EDT.DETAILS.MISSING",
"message": "The harmonized code for the commodity at array index 1 is missing or invalid; estimated duties and taxes were not returned."
}
],
"ratedShipmentDetails": [
{
"rateType": "ACCOUNT",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 403.2,
"totalNetCharge": 445.54,
"totalVatCharge": 0,
"totalNetFedExCharge": 445.54,
"totalDutiesAndTaxes": 0,
"totalNetTransportationAndPickupCharge": {
"amount": 12.45,
"currency": "USD"
},
"totalNetFedExTransportationAndPickupCharge": {
"amount": 12.45,
"currency": "USD"
},
"pickupRateDetail": {
"rateType": "INCENTIVE",
"ratingBasis": "PACK_WEIGHT_BASED",
"pricingCode": "ACTUAL",
"fuelSurchargePercent": 90.8
},
"totalNetChargeWithDutiesAndTaxes": 445.54,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA003O",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 42.34,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 42.34
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "CAD",
"rate": 1
},
"totalBillingWeight": {
"units": "LB",
"valu": 22
},
"currency": "CAD"
},
"currency": "CAD"
},
{
"rateType": "LIST",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 403.2,
"totalNetCharge": 445.54,
"totalVatCharge": 0,
"totalNetFedExCharge": 445.54,
"totalDutiesAndTaxes": 0,
"totalNetTransportationAndPickupCharge": {
"amount": 12.45,
"currency": "USD"
},
"totalNetFedExTransportationAndPickupCharge": {
"amount": 12.45,
"currency": "USD"
},
"pickupRateDetail": {
"rateType": "INCENTIVE",
"ratingBasis": "PACK_WEIGHT_BASED",
"pricingCode": "ACTUAL",
"fuelSurchargePercent": 90.8
},
"totalNetChargeWithDutiesAndTaxes": 445.54,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA003O",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 42.34,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 42.34
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "CAD",
"rate": 1
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "CAD"
},
"currency": "CAD"
},
{
"rateType": "PREFERRED_INCENTIVE",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 308.71,
"totalNetCharge": 341.13,
"totalVatCharge": 0,
"totalNetFedExCharge": 341.13,
"totalDutiesAndTaxes": 0,
"totalNetTransportationAndPickupCharge": {
"amount": 12.45,
"currency": "USD"
},
"totalNetFedExTransportationAndPickupCharge": {
"amount": 12.45,
"currency": "USD"
},
"pickupRateDetail": {
"rateType": "INCENTIVE",
"ratingBasis": "PACK_WEIGHT_BASED",
"pricingCode": "ACTUAL",
"fuelSurchargePercent": 90.8
},
"totalNetChargeWithDutiesAndTaxes": 341.13,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA003O",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 32.42,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 32.42
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "USD",
"rate": 0.77
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "USD"
},
"currency": "USD"
},
{
"rateType": "PREFERRED_CURRENCY",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 308.71,
"totalNetCharge": 341.13,
"totalVatCharge": 0,
"totalNetFedExCharge": 341.13,
"totalDutiesAndTaxes": 0,
"totalNetTransportationAndPickupCharge": {
"amount": 12.45,
"currency": "USD"
},
"totalNetFedExTransportationAndPickupCharge": {
"amount": 12.45,
"currency": "USD"
},
"pickupRateDetail": {
"rateType": "INCENTIVE",
"ratingBasis": "PACK_WEIGHT_BASED",
"pricingCode": "ACTUAL",
"fuelSurchargePercent": 90.8
},
"totalNetChargeWithDutiesAndTaxes": 341.13,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA003O",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 32.42,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 32.42
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "USD",
"rate": 0.77
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "USD"
},
"currency": "USD"
}
],
"anonymouslyAllowable": true,
"operationalDetail": {
"originLocationIds": "COSA",
"commitDays": "",
"serviceCode": "92",
"airportId": "MEM",
"scac": "",
"originServiceAreas": "AM",
"deliveryDay": "TUE",
"originLocationNumbers": 1162,
"destinationPostalCode": "38125",
"commitDate": "2019-07-22T08:30:00",
"astraDescription": "INTL1ST",
"deliveryDate": "",
"deliveryEligibilities": "",
"ineligibleForMoneyBackGuarantee": false,
"maximumTransitTime": "",
"astraPlannedServiceLevel": "",
"destinationLocationIds": "EHTA",
"destinationLocationStateOrProvinceCodes": "CT",
"transitTime": "THREE_DAYS",
"packagingCode": "02",
"destinationLocationNumbers": 892,
"publishedDeliveryTime": "06:30:00",
"countryCodes": "US",
"stateOrProvinceCodes": "TX",
"ursaPrefixCode": "82",
"ursaSuffixCode": "EHTA",
"destinationServiceAreas": "AA",
"originPostalCodes": "75063",
"customTransitTime": ""
},
"signatureOptionType": "SERVICE_DEFAULT",
"serviceDescription": {
"serviceId": "EP1000000007",
"serviceType": "INTERNATIONAL_FIRST",
"code": "06",
"names": [
{
"type": "long",
"encoding": "utf-8",
"value": "FedEx International First®"
},
{
"type": "long",
"encoding": "ascii",
"value": "FedEx International First"
},
{
"type": "medium",
"encoding": "utf-8",
"value": "FedEx International First®"
},
{
"type": "medium",
"encoding": "ascii",
"value": "FedEx International First"
},
{
"type": "short",
"encoding": "utf-8",
"value": "FO"
},
{
"type": "short",
"encoding": "ascii",
"value": "FO"
},
{
"type": "abbrv",
"encoding": "ascii",
"value": "FO"
}
],
"operatingOrgCodes": [
"FXE"
],
"serviceCategory": "parcel",
"description": "International First",
"astraDescription": "INTL1ST"
},
"commit": {
"dateDetail": {
"dayOfWeek": "THU",
"dayCxsFormat": "2020-07-16T10:30:00"
}
}
},
{
"serviceType": "INTERNATIONAL_PRIORITY",
"serviceName": "FedEx International Priority",
"packagingType": "YOUR_PACKAGING",
"customerMessages": [
{
"code": "SERVICE.TYPE.INTERNATIONAL.MESSAGE",
"message": "Rate does not include duties & taxes, clearance entry fees or other import fees. The payor of duties/taxes/fees will be responsible for any applicable Clearance Entry Fees."
},
{
"code": "EDT.DETAILS.MISSING",
"message": "The harmonized code for the commodity at array index 1 is missing or invalid; estimated duties and taxes were not returned."
}
],
"ratedShipmentDetails": [
{
"rateType": "ACCOUNT",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 312.35,
"totalNetCharge": 345.15,
"totalVatCharge": 0,
"totalNetFedExCharge": 345.15,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 345.15,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA003O",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 32.8,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 32.8
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "CAD",
"rate": 1
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "CAD"
},
"currency": "CAD"
},
{
"rateType": "LIST",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 78.99,
"totalNetCharge": 87.28,
"totalVatCharge": 0,
"totalNetFedExCharge": 87.28,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 87.28,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA1520",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 8.29,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 8.29
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "CAD",
"rate": 1
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "CAD"
},
"currency": "CAD"
},
{
"rateType": "PREFERRED_INCENTIVE",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 60.48,
"totalNetCharge": 66.83,
"totalVatCharge": 0,
"totalNetFedExCharge": 66.83,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 66.83,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA1520",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 6.3,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 6.35
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "USD",
"rate": 0.77
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "USD"
},
"currency": "USD"
},
{
"rateType": "PREFERRED_CURRENCY",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 239.15,
"totalNetCharge": 264.26,
"totalVatCharge": 0,
"totalNetFedExCharge": 264.26,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 264.26,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA003O",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 25.11,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 25.11
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "USD",
"rate": 0.77
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "USD"
},
"currency": "USD"
}
],
"anonymouslyAllowable": true,
"operationalDetail": {
"ineligibleForMoneyBackGuarantee": false,
"astraDescription": "IP",
"airportId": "MEM",
"serviceCode": "01",
"originLocationIds": "COSA",
"commitDays": "",
"scac": "",
"originServiceAreas": "AM",
"deliveryDay": "TUE",
"originLocationNumbers": 1162,
"destinationPostalCode": "38125",
"commitDate": "2019-07-22T08:30:00",
"deliveryDate": "",
"deliveryEligibilities": "",
"maximumTransitTime": "",
"astraPlannedServiceLevel": "",
"destinationLocationIds": "EHTA",
"destinationLocationStateOrProvinceCodes": "CT",
"transitTime": "THREE_DAYS",
"packagingCode": "02",
"destinationLocationNumbers": 892,
"publishedDeliveryTime": "06:30:00",
"countryCodes": "US",
"stateOrProvinceCodes": "TX",
"ursaPrefixCode": "82",
"ursaSuffixCode": "EHTA",
"destinationServiceAreas": "AA",
"originPostalCodes": "75063",
"customTransitTime": ""
},
"signatureOptionType": "SERVICE_DEFAULT",
"serviceDescription": {
"serviceId": "EP1000000001",
"serviceType": "INTERNATIONAL_PRIORITY",
"code": "01",
"names": [
{
"type": "long",
"encoding": "utf-8",
"value": "FedEx International Priority®"
},
{
"type": "long",
"encoding": "ascii",
"value": "FedEx International Priority"
},
{
"type": "medium",
"encoding": "utf-8",
"value": "FedEx International Priority®"
},
{
"type": "medium",
"encoding": "ascii",
"value": "FedEx International Priority"
},
{
"type": "short",
"encoding": "utf-8",
"value": "IP"
},
{
"type": "short",
"encoding": "ascii",
"value\"": "IP"
},
{
"type": "abbrv",
"encoding": "ascii",
"value": "IP"
}
],
"operatingOrgCodes": [
"FXE"
],
"serviceCategory": "parcel",
"description": "International Priority",
"astraDescription": "IP"
},
"commit": {
"dateDetail": {
"dayOfWeek": "FRI",
"dayCxsFormat": "2020-07-16T10:30:00"
}
}
},
{
"serviceType": "INTERNATIONAL_ECONOMY",
"serviceName": "FedEx International Economy",
"packagingType": "YOUR_PACKAGING",
"customerMessages": [
{
"code": "SERVICE.TYPE.INTERNATIONAL.MESSAGE",
"message": "Rate does not include duties & taxes, clearance entry fees or other import fees. The payor of duties/taxes/fees will be responsible for any applicable Clearance Entry Fees."
},
{
"code": "EDT.DETAILS.MISSING",
"message": "The harmonized code for the commodity at array index 1 is missing or invalid; estimated duties and taxes were not returned."
}
],
"ratedShipmentDetails": [
{
"rateType": "ACCOUNT",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 189.65,
"totalNetCharge": 209.56,
"totalVatCharge": 0,
"totalNetFedExCharge": 209.56,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 209.56,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA003O",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 19.91,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 19.91
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "CAD",
"rate": 1
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "CAD"
},
"currency": "CAD"
},
{
"rateType": "LIST",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 48.56,
"totalNetCharge": 53.66,
"totalVatCharge": 0,
"totalNetFedExCharge": 53.66,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 53.66,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA1520",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 5.1,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 5.1
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "CAD",
"rate": 1
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "CAD"
},
"currency": "CAD"
},
{
"rateType": "PREFERRED_INCENTIVE",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 37.18,
"totalNetCharge": 41.08,
"totalVatCharge": 0,
"totalNetFedExCharge": 41.08,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 41.08,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA1520",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 3.9,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 3.9
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "USD",
"rate": 0.77
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "USD"
},
"currency": "USD"
},
{
"rateType": "PREFERRED_CURRENCY",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 145.21,
"totalNetCharge": 160.45,
"totalVatCharge": 0,
"totalNetFedExCharge": 160.45,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 160.45,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "CA003O",
"dimDivisor": 0,
"fuelSurchargePercent": 10.5,
"totalSurcharges": 15.24,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"amount": 15.24
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "USD",
"rate": 0.77
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "USD"
},
"currency": "USD"
}
],
"anonymouslyAllowable": true,
"operationalDetail": {
"ineligibleForMoneyBackGuarantee": false,
"astraDescription": "IE",
"airportId": "MEM",
"serviceCode": "03",
"originLocationIds": "COSA",
"originServiceAreas": "AM",
"deliveryDay": "TUE",
"originLocationNumbers": 1162,
"destinationPostalCode": "38125",
"destinationLocationIds": "EHTA",
"destinationLocationStateOrProvinceCodes": "CT",
"transitTime": "THREE_DAYS",
"packagingCode": "02",
"destinationLocationNumbers": 892,
"publishedDeliveryTime": "06:30:00",
"countryCodes": "US",
"stateOrProvinceCodes": "TX",
"ursaPrefixCode": "82",
"ursaSuffixCode": "EHTA",
"destinationServiceAreas": "AA",
"originPostalCodes": "75063"
},
"signatureOptionType": "SERVICE_DEFAULT",
"serviceDescription": {
"serviceId": "EP1000000004",
"serviceType": "INTERNATIONAL_ECONOMY",
"code": "03",
"names": [
{
"type": "long",
"encoding": "utf-8",
"value": "FedEx International Economy®"
},
{
"type": "long",
"encoding": "ascii",
"value": "FedEx International Economy"
},
{
"type": "medium",
"encoding": "utf-8",
"value": "FedEx International Economy®"
},
{
"type": "medium",
"encoding": "ascii",
"value": "FedEx International Economy"
},
{
"type": "short",
"encoding": "utf-8",
"value": "IE"
},
{
"type": "short",
"encoding": "ascii",
"value": "IE"
},
{
"type": "abbrv",
"encoding": "ascii",
"value": "IE"
}
],
"operatingOrgCodes": [
"FXE"
],
"serviceCategory": "parcel",
"description": "International Two Day",
"astraDescription": "IE"
}
},
{
"serviceType": "FEDEX_GROUND",
"serviceName": "FedEx International Ground ",
"packagingType": "YOUR_PACKAGING",
"customerMessages": [
{
"code": "SERVICE.TYPE.INTERNATIONAL.MESSAGE",
"message": "Rate does not include duties & taxes, clearance entry fees or other import fees. The payor of duties/taxes/fees will be responsible for any applicable Clearance Entry Fees."
},
{
"code": "EDT.DETAILS.MISSING",
"message": "The harmonized code for the commodity at array index 1 is missing or invalid; estimated duties and taxes were not returned."
}
],
"ratedShipmentDetails": [
{
"rateType": "ACCOUNT",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 2.79,
"totalBaseCharge": 49.85,
"totalNetCharge": 53.59,
"totalVatCharge": 0,
"totalNetFedExCharge": 53.59,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 53.59,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "52",
"dimDivisor": 0,
"fuelSurchargePercent": 7.5,
"totalSurcharges": 3.74,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount": 3.74
}
],
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "CAD"
},
"ratedPackages": [
{
"groupNumber": 0,
"effectiveNetDiscount": 2.79,
"packageRateDetail": {
"rateType": "PAYOR_ACCOUNT_PACKAGE",
"ratedWeightMethod": "ACTUAL",
"baseCharge": 49.85,
"netFreight": 49.85,
"totalSurcharges": 3.74,
"netFedExCharge": 53.59,
"totalTaxes": 0,
"netCharge": 53.59,
"totalRebates": 0,
"billingWeight": {
"units": "LB",
"value": 22
},
"totalFreightDiscounts": 0,
"surcharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount": 3.74
}
],
"currency": "CAD"
}
}
],
"currency": "CAD"
},
{
"rateType": "PREFERRED_INCENTIVE",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 40.16,
"totalNetCharge": 43.17,
"totalVatCharge": 0,
"totalNetFedExCharge": 43.17,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 43.17,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "52",
"dimDivisor": 0,
"fuelSurchargePercent": 7.5,
"totalSurcharges": 3.01,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount": 3.01
}
],
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "USD",
"rate": 0.77
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "USD"
},
"ratedPackages": [
{
"groupNumber": 0,
"effectiveNetDiscount": 0,
"packageRateDetail": {
"rateType": "PREFERRED_LIST_PACKAGE",
"ratedWeightMethod": "ACTUAL",
"baseCharge": 40.16,
"netFreight": 40.16,
"totalSurcharges": 3.01,
"netFedExCharge": 43.17,
"totalTaxes": 0,
"netCharge": 43.17,
"totalRebates": 0,
"billingWeight": {
"units": "LB",
"value": 22
},
"totalFreightDiscounts": 0,
"surcharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount\"": 3.01
}
],
"currency": "USD"
}
}
]
},
{
"rateType": "PREFERRED_CURRENCY",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 38.17,
"totalNetCharge": 41.03,
"totalVatCharge": 0,
"totalNetFedExCharge": 41.03,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 41.03,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "52",
"dimDivisor": 0,
"fuelSurchargePercent": 7.5,
"totalSurcharges": 2.86,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount": 2.86
}
],
"currencyExchangeRate": {
"fromCurrency": "CAD",
"intoCurrency": "USD",
"rate": 0.77
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "USD"
},
"ratedPackages": [
{
"groupNumber": 0,
"effectiveNetDiscount": 0,
"packageRateDetail": null,
"rateType": "PREFERRED_ACCOUNT_PACKAGE",
"ratedWeightMethod": "ACTUAL",
"baseCharge": 38.17,
"netFreight": 38.17,
"totalSurcharges": 2.86,
"netFedExCharge": 41.03,
"totalTaxes": 0,
"netCharge": 41.03,
"totalRebates": 0,
"billingWeight\"": {
"units": "LB",
"value": 22
},
"totalFreightDiscounts": 0,
"surcharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount": 2.86
}
],
"currency": "USD"
}
],
"currency": "USD"
},
{
"rateType": "LIST",
"ratedWeightMethod": "ACTUAL",
"totalDiscounts": 0,
"totalBaseCharge": 52.45,
"totalNetCharge": 56.38,
"totalVatCharge": 0,
"totalNetFedExCharge": 56.38,
"totalDutiesAndTaxes": 0,
"totalNetChargeWithDutiesAndTaxes": 56.38,
"totalDutiesTaxesAndFees": 0,
"totalAncillaryFeesAndTaxes": 0,
"shipmentRateDetail": {
"rateZone": "52",
"dimDivisor": 0,
"fuelSurchargePercent": 7.5,
"totalSurcharges": 3.93,
"totalFreightDiscount": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount": 3.93
}
],
"totalBillingWeight\"": {
"units": "LB",
"value": 2
},
"currency": "CAD"
},
"ratedPackages": [
{
"groupNumber": 0,
"effectiveNetDiscount": 0,
"packageRateDetail": null,
"rateType": "PAYOR_LIST_PACKAGE",
"ratedWeightMethod": "ACTUAL",
"baseCharge": 52.45,
"netFreight": 52.45,
"totalSurcharges": 3.93,
"netFedExCharge": 56.38,
"totalTaxes": 0,
"netCharge": 56.38,
"totalRebates": 0,
"billingWeight": {
"units": "LB",
"value": 22
},
"totalFreightDiscounts": 0,
"surcharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount": 3.93
}
],
"currency": "CAD"
}
],
"currency": "CAD",
"anonymouslyAllowable": true,
"operationalDetail": {
"ineligibleForMoneyBackGuarantee": false,
"astraDescription": "FXG",
"airportId": "MEM",
"serviceCode": "92",
"originLocationIds": "COSA",
"commitDays": "",
"scac": "",
"originServiceAreas": "AM",
"deliveryDay": "TUE",
"originLocationNumbers": 1162,
"destinationPostalCode": "38125",
"commitDate": "2019-07-22T08:30:00",
"deliveryDate": "",
"deliveryEligibilities": "",
"maximumTransitTime": "",
"astraPlannedServiceLevel": "",
"destinationLocationIds": "EHTA",
"destinationLocationStateOrProvinceCodes": "CT",
"transitTime": "THREE_DAYS",
"packagingCode": "02",
"destinationLocationNumbers": 892,
"publishedDeliveryTime": "06:30:00",
"countryCodes": "US",
"stateOrProvinceCodes": "TX",
"ursaPrefixCode": "82",
"ursaSuffixCode": "EHTA",
"destinationServiceAreas": "AA",
"originPostalCodes": "75063",
"customTransitTime": ""
},
"signatureOptionType": "SERVICE_DEFAULT",
"serviceDescription": {
"serviceId": "EP1000000135",
"serviceType": "FEDEX_GROUND",
"code": "92",
"names": [
{
"type": "long",
"encoding": "utf-8",
"value": "FedEx International Ground®"
},
{
"type": "long",
"encoding": "ascii",
"value": "FedEx International Ground"
},
{
"type": "medium",
"encoding": "utf-8",
"value": "International Ground®"
},
{
"type": "medium",
"encoding": "ascii",
"value": "International Ground"
},
{
"type": "short",
"encoding": "utf-8",
"value": "IG"
},
{
"type": "short",
"encoding": "ascii",
"value": "IG"
},
{
"type": "abbrv",
"encoding": "ascii",
"value": "SG"
}
],
"operatingOrgCodes": [
"FXG"
],
"description": "FedEx Ground",
"astraDescription": "FXG"
}
}
]
}
],
"quoteDate": "2019-09-06",
"encoded": false,
"alerts": [
{
"code": "MONEYBACKGUARANTEE.NOT.ELIGIBLE",
"message": "We are unable to process this request. Please try again later or contact FedEx Customer Service.",
"alertType": "NOTE"
}
]
}
},
"RateReplyDetail": {
"type": "object",
"properties": {
"serviceType": {
"type": "string",
"description": "This is the service type associated with this rate (i.e. Priority Overnight, Home Delivery, etc.)
For Ground/SmartPost this will be a direct copy of the service specified in the request. For domestic Express, the service may have been bumped, so it may not match the value specified on the request. For International Express the service may be bumped and not mapped.
Example: FEDEX_GROUND
Click here to see Service Types",
"example": "FEDEX_GROUND"
},
"serviceName": {
"type": "string",
"description": "This is the service name associated with this rate.
Example: FedEx Ground",
"example": "FedEx Ground®"
},
"packagingType": {
"type": "string",
"description": "Packaging type associated with this particular rate. For Ground/SmartPost will always be YOUR_PACKAGING. For domestic Express, the packaging may have been bumped so it may not match the value specified on the request. For international Express the packaging may be bumped and not mapped.
Example: YOUR_PACKAGING
Click here to see Package Types",
"example": "YOUR_PACKAGING"
},
"customerMessages": {
"type": "array",
"description": "These are messages concerning the ability to provide an accurate delivery commitment on an International commit quote. These could be providing information about why a commitment could not be returned or a successful message
Example:
- REQUEST_COMPLETED
Request completed successfully - SERVICE.TYPE.INTERNATIONAL.MESSAGE:
Rate does not include duties & taxes, clearance entry fees or other import fees. The payor of duties/taxes/fees will be responsible for any applicable Clearance Entry Fees. - NATIONAL.HOLIDAY.OBSERVED:
National Holiday Observed on Ship Date. - INCONSISTENT.COMMODITY.DESCRIPTION:
The description and harmonized code for the specified commodity are not consistent.
",
"items": {
"$ref": "#/components/schemas/CustomerMessage"
}
},
"ratedShipmentDetails": {
"type": "array",
"description": "This object provides the shipment and package rating data in a rate request reply.",
"items": {
"$ref": "#/components/schemas/RatedShipmentDetail"
}
},
"operationalDetail": {
"$ref": "#/components/schemas/OperationalDetail"
},
"signatureOptionType": {
"type": "string",
"description": "Indicates the signature Option for this service.
Example: SERVICE_DEFAULT",
"example": "SERVICE_DEFAULT"
},
"serviceDescription": {
"$ref": "#/components/schemas/ServiceDescription"
},
"brokerDetail": {
"$ref": "#/components/schemas/BrokerDetail_RateReply"
},
"commit": {
"$ref": "#/components/schemas/Commit"
},
"serviceSubOptionDetail": {
"$ref": "#/components/schemas/ServiceSubOptionDetail"
}
},
"description": "This objcet lists the rate data by service. If a service was specified in the request, there will be a single entry; if service was omitted in the request, there will be a separate entry in this for each service being compared.",
"example": {
"serviceType": "INTERNATIONAL_FIRST",
"serviceName": "FedEx International First®",
"packagingType\"": "YOUR_PACKAGING",
"commit": {
"transitDays": {
"minimumTransitTime": "TWO_DAYS",
"description": "2 Business Days"
},
"derivedOriginDetail": {
"countryCode": "US",
"stateOrProvinceCode": "MO",
"postalCode": "65247",
"locationNumber": 646
},
"derivedDestinationDetail": {
"countryCode": "US",
"stateOrProvinceCode\"": "AR",
"postalCode\"": "72348",
"locationNumber": 380,
"airportId\"": "MEM"
},
"saturdayDelivery": false
},
"ratedShipmentDetails": [
{
"rateType": "ACCOUNT",
"ratedWeightMethod\"": "ACTUAL",
"totalDiscounts\"": 0,
"totalBaseCharge\"": 403.2,
"totalNetCharge\"": 445.54,
"totalNetFedExCharge\"": 445.54,
"totalNetChargeWithDutiesAndTaxes\"": 445.54,
"totalDutiesTaxesAndFees\"": 0,
"totalAncillaryFeesAndTaxes\"": 0,
"shipmentRateDetail": {
"rateZone": "CA003O",
"dimDivisor\"": 0,
"fuelSurchargePercent\"": 10.5,
"totalSurcharges\"": 42.34,
"totalFreightDiscount\"": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount": 42.34
}
],
"pricingCode": "ACTUAL",
"currencyExchangeRate\"": {
"fromCurrency\"": "CAD",
"intoCurrency\"": "CAD",
"rate\"": 1
},
"totalBillingWeight": {
"units": "LB",
"value": 22
},
"currency": "USD"
},
"ratedPackages": [
{
"groupNumber": 0,
"effectiveNetDiscount": 0,
"packageRateDetail": {
"rateType\"": "PAYOR_ACCOUNT_PACKAGE",
"ratedWeightMethod\"": "ACTUAL",
"baseCharge\"": 12.32,
"netFreight\"": 12.32,
"totalSurcharges\"": 3.49,
"netFedExCharge\"": 15.81,
"totalTaxes\"": 0,
"netCharge\"": 15.81,
"totalRebates\"": 0,
"billingWeight": {
"units": "LB",
"value": 10
},
"totalFreightDiscounts": 0,
"surcharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount": 0.79
},
{
"type": "DELIVERY_AREA",
"description": "DAS Extended Comm",
"level": "PACKAGE",
"amount": 2.7
}
],
"currency": "USD"
}
}
],
"currency": "USD"
},
{
"rateType": "LIST",
"ratedWeightMethod\"": "ACTUAL",
"totalDiscounts\"": 0,
"totalBaseCharge\"": 11.51,
"totalNetCharge\"": 14.99,
"totalNetFedExCharge\"": 14.99,
"totalNetChargeWithDutiesAndTaxes\"": 14.99,
"totalDutiesTaxesAndFees\"": 0,
"totalAncillaryFeesAndTaxes\"": 0,
"shipmentRateDetail": {
"rateZone": "3",
"dimDivisor\"": 0,
"fuelSurchargePercent\"": 5.5,
"totalSurcharges\"": 3.48,
"totalFreightDiscount\"": 0,
"surCharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount": 0.78
},
{
"type": "DELIVERY_AREA",
"description": "DAS Extended Comm",
"level": "PACKAGE",
"amount": 2.7
}
],
"totalBillingWeight": {
"units": "LB",
"value": 10
},
"currency": "USD"
},
"ratedPackages": [
{
"groupNumber": 0,
"effectiveNetDiscount": 0,
"packageRateDetail": {
"rateType\"": "PAYOR_LIST_PACKAGE",
"ratedWeightMethod\"": "ACTUAL",
"baseCharge\"": 11.51,
"netFreight\"": 11.51,
"totalSurcharges\"": 3.48,
"netFedExCharge\"": 14.99,
"totalTaxes\"": 0,
"netCharge\"": 14.99,
"totalRebates\"": 0,
"billingWeight": {
"units": "LB",
"value": 10
},
"totalFreightDiscounts": 0,
"surcharges": [
{
"type": "FUEL",
"description": "Fuel Surcharge",
"level": "PACKAGE",
"amount": 0.78
},
{
"type": "DELIVERY_AREA",
"description": "DAS Extended Comm",
"level": "PACKAGE",
"amount": 2.7
}
],
"currency": "USD"
}
}
],
"currency": "USD"
}
],
"anonymouslyAllowable": true,
"operationalDetail": {
"originLocationNumbers": [
646
],
"destinationLocationNumbers": [
380
],
"destinationLocationStateOrProvinceCodes": [
"AR"
],
"transitTime": "TWO_DAYS",
"ineligibleForMoneyBackGuarantee": false,
"astraDescription": "FXG",
"originPostalCodes": [
"65247"
],
"stateOrProvinceCodes": [
"MO"
],
"countryCodes": [
"US"
],
"airportId": "MEM",
"serviceCode": "92",
"destinationPostalCodes": "72348",
"signatureOptionType": "SERVICE_DEFAULT",
"serviceDescription": {
"serviceId": "EP1000000134",
"serviceType": "FEDEX_GROUND",
"code": "92",
"names": [
{
"type": "long",
"encoding": "utf-8",
"value": "FedEx Ground®"
},
{
"type": "long",
"encoding": "ascii",
"value": "FedEx Ground"
},
{
"type": "medium",
"encoding": "utf-8",
"value": "Ground®"
},
{
"type": "medium",
"encoding": "ascii",
"value": "Ground"
},
{
"type": "short",
"encoding": "utf-8",
"value": "FG"
},
{
"type": "short",
"encoding": "ascii",
"value": "FG"
},
{
"type": "abbrv",
"encoding": "ascii",
"value": "SG"
}
],
"operatingOrgCodes": [
"FXG"
],
"description": "FedEx Ground",
"astraDescription": "FXG"
}
}
}
},
"CustomerMessage": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "This is a message code.
Example:SERVICE.TYPE.INTERNATIONAL.MESSAGE",
"example": "SERVICE.TYPE.INTERNATIONAL.MESSAGE"
},
"message": {
"type": "string",
"description": "This is a message description.
Example: Rate does not include duties & taxes, clearance entry fees or other import fees. The payor of duties/taxes/fees will be responsible for any applicable Clearance Entry Fees",
"example": "Rate does not include dities & taxes, clearance entry fees or other import fees. The payor of duties/taxes/fees will be responsible for any applicable Clearance Entry Fees"
}
},
"description": "This the Customer Message returned in the reply."
},
"RatedShipmentDetail": {
"type": "object",
"properties": {
"rateType": {
"type": "string",
"description": "Type used for this specific set of rate data.
Example: ACCOUNT",
"example": "ACCOUNT",
"enum": [
"ACCOUNT",
"ACTUAL",
"CURRENT",
"CUSTOM",
"LIST",
"INCENTIVE",
"PREFERRED",
"PREFERRED_INCENTIVE",
"PREFERRED_CURRENCY"
]
},
"totalNetTransportationAndPickupCharge": {
"description": "Sum of totalNetCharge from pickupRateDetail and shipmentRateDetail. This charge will be populated regardless of pickup.",
"allOf": [
{
"$ref": "#/components/schemas/Money"
}
]
},
"totalNetFedExTransportationAndPickupCharge": {
"description": "Sum of totalNetFedExCharge from pickupRateDetail and shipmentRateDetail. This charge will be populated regardless of a pickup.",
"allOf": [
{
"$ref": "#/components/schemas/Money"
}
]
},
"pickupRateDetail": {
"description": "Charges associated with a scheduled shipment pickup",
"type": "object",
"properties": {
"rateType": {
"description": "Type used for this specific set of rate data.",
"type": "string",
"enum": [
"INCENTIVE",
"NEGOTIATED",
"PAYOR_ACCOUNT_PACKAGE",
"PAYOR_ACCOUNT_SHIPMENT",
"PAYOR_CUSTOM_PACKAGE",
"PAYOR_CUSTOM_SHIPMENT",
"PAYOR_LIST_PACKAGE",
"PAYOR_LIST_SHIPMENT",
"PAYOR_RETAIL_PACKAGE",
"PAYOR_RETAIL_SHIPMENT",
"PREFERRED_ACCOUNT_PACKAGE",
"PREFERRED_ACCOUNT_SHIPMENT",
"PREFERRED_CUSTOM_PACKAGE",
"PREFERRED_CUSTOM_SHIPMENT",
"PREFERRED_INCENTIVE",
"PREFERRED_LIST_PACKAGE",
"PREFERRED_LIST_SHIPMENT",
"PREFERRED_NEGOTIATED",
"PREFERRED_RETAIL_PACKAGE",
"PREFERRED_RETAIL_SHIPMENT",
"RATED_ACCOUNT_PACKAGE",
"RATED_ACCOUNT_SHIPMENT",
"RATED_CUSTOM_PACKAGE",
"RATED_CUSTOM_SHIPMENT",
"RATED_LIST_PACKAGE",
"RATED_LIST_SHIPMENT",
"RATED_RETAIL_PACKAGE",
"RATED_RETAIL_SHIPMENT",
"UNKNOWN"
],
"example": "PAYOR_ACCOUNT_PACKAGE"
},
"rateScale": {
"type": "string",
"description": "Indicates the rate scale used.",
"example": "*USER IMS20160104 LD067110"
},
"rateZone": {
"description": "Indicates the rate zone used (based on origin and destination).",
"type": "string",
"example": "CA003O"
},
"ratingBasis": {
"description": "Allows clients to determine whether to add charges at the package level when Per Piece Rating details are returned.
- SHIPMENT_WEIGHT_BASED - Indicates shipment weight is used to calculate the rate.
- FLAT_RATE_PER_PAK - Indicates shipment is rated based on number of packs, weight would be considered for overweight surcharge but not for calculating shipment rate.
- PACK_WEIGHT_BASED - Indicates individual package weight would be rated and aggregated to get shipment rate weight.
",
"type": "string",
"enum": [
"SHIPMENT_WEIGHT_BASED",
"FLAT_RATE_PER_PAK",
"PACK_WEIGHT_BASED",
"UNKNOWN"
],
"example": "SHIPMENT_WEIGHT_BASED"
},
"pricingCode": {
"description": "Identifies the type of pricing used for this shipment.",
"type": "string",
"enum": [
"ACTUAL",
"ALTERNATE",
"BASE",
"HUNDREDWEIGHT",
"HUNDREDWEIGHT_ALTERNATE",
"INTERNATIONAL_DISTRIBUTION",
"INTERNATIONAL_ECONOMY_SERVICE",
"LTL_FREIGHT",
"PACKAGE",
"SHIPMENT",
"SHIPMENT_FIVE_POUND_OPTIONAL",
"SHIPMENT_OPTIONAL",
"SPECIAL",
"UNKNOWN"
],
"example": "ACTUAL"
},
"minimumChargeType": {
"description": "provides the minimum charge type applicable to the rates.",
"type": "string",
"enum": [
"CUSTOMER",
"CUSTOMER_FREIGHT_WEIGHT",
"EARNED_DISCOUNT",
"MIXED",
"RATE_SCALE",
"UNKNOWN"
],
"example": "EARNED_DISCOUNT"
},
"currencyExchangeRate": {
"$ref": "#/components/schemas/CurrencyExchangeRate"
},
"specialRatingApplied": {
"type": "array",
"description": "Indicates which special rating cases applied to this shipment.",
"items": {
"type": "string",
"enum": [
"FEDEX_ONE_RATE",
"FIXED_FUEL_SURCHARGE",
"IMPORT_PRICING"
]
},
"example": "FEDEX_ONE_RATE"
},
"fuelSurchargePercent": {
"description": "Specify a fuel surcharge percentage.",
"format": "double",
"type": "number",
"example": 121
},
"pickupBaseChargeDescription": {
"description": "Will indicate the pickup charge description of the on call pickup",
"type": "string",
"enum": [
"Regularly Scheduled Pickup Mon-Fri",
"Automated Pickup Mon-Fri",
"Same Day OC Pickup Mon-Fri (CS)",
"Same Day OC Pickup Mon-Fri (Online)",
"Fut. Day OC Pickup Mon-Fri (CS)",
"Fut. Day OC Pickup Mon-Fri (Online)",
"Regularly Scheduled Pickup Sat",
"Automated Pickup Sat",
"Same Day OC Pickup Sat (CS)",
"Same Day OC Pickup Sat (Online)",
"Fut. Day OC Pickup Sat (CS)",
"Fut. Day OC Pickup Sat (Online)",
"Regularly Scheduled Pickup Sun",
"Automated Pickup Sun",
"Same Day OC Pickup Sun (CS)",
"Same Day OC Pickup Sun (Online)",
"Fut. Day OC Pickup Sun (CS)",
"Fut. Day OC Pickup Sun (Online)",
"Residential On-Call Pickup Surcharge",
"Pickup Area Surcharge",
"Extended Pickup Area Surcharge",
"Remote Pickup Area Surcharge",
"Fuel Surcharge"
],
"example": "Pickup Area Surcharge"
},
"totalBaseCharge": {
"description": "Total base charges for the shipment.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalFreightDiscounts": {
"description": "The total discounts used in the rate calculation.
Example: 1257.26",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalNetFreight": {
"description": "This shipment's totalNetFreight.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalSurcharges": {
"description": "The sum of all surcharges on the package.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalNetFedExCharge": {
"description": "This shipment's totalNetFedExCharge, which is totalNetFreight plus totalSurcharges (not including totalTaxes).",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalTaxes": {
"description": "The sum of all taxes on this package.
Example: 1257.25",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalNetCharge": {
"description": "Total net charges for the shipment.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalRebates": {
"description": "The total sum of all rebates applied to this package.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalDutiesAndTaxes": {
"description": "The sum of shipment/package Duties and taxes.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalAncillaryFeesAndTaxes": {
"description": "Identifies the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalDutiesTaxesAndFees": {
"description": "The total amount of the duties and taxes plus the total ancillary fees and taxes.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"totalNetChargeWithDutiesAndTaxes": {
"description": "Total netChargesWithDutiesAndTaxes for the shipment.",
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
}
]
},
"freightDiscounts": {
"description": "All rate discounts that apply to this shipment",
"type": "array",
"items": {
"$ref": "#/components/schemas/RateDiscount_2"
}
},
"rebates": {
"description": "The all rebates applied to this package.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Rebate"
}
},
"surcharges": {
"description": "The amount of surcharges applied to this shipment.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Surcharge_2"
}
},
"taxes": {
"description": "List of taxes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tax_2"
}
},
"dutiesAndTaxes": {
"description": "List of The shipment/package Duties and taxes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/EdtCommodityTax"
}
},
"ancillaryFeesAndTaxes": {
"description": "Identifies the total amount of the shipment-lvel fees and taxes that are not based on transportation charges of commodity-level estimated duties and taxes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AncillaryFeeAndTax"
}
},
"variableHandlingCharges": {
"description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail.",
"allOf": [
{
"$ref": "#/components/schemas/VariableHandlingCharges_1"
}
]
},
"totalVariableHandlingCharges": {
"description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail.",
"allOf": [
{
"$ref": "#/components/schemas/VariableHandlingCharges_1"
}
]
}
}
},
"ratedWeightMethod": {
"type": "string",
"description": "Indicates which weight was used for the rate.
Example: 'ACTUAL'",
"example": "ACTUAL",
"enum": [
"ACTUAL",
"AVERAGE_PACKAGE_WEIGHT_MINIMUM",
"DEFAULT_WEIGHT_APPLIED",
"BALLOON",
"DIM",
"FREIGHT_MINIMUM",
"MIXED",
"OVERSIZE",
"OVERSIZE_1",
"OVERSIZE_2",
"OVERSIZE_3",
"PACKAGING_MINIMUM",
"WEIGHT_BREAK"
]
},
"totalDutiesTaxesAndFees": {
"type": "number",
"description": "The total amount of the duties and taxes plus the total ancillary fees and taxes.
Example: 445.54",
"format": "double",
"example": 445.54
},
"totalDiscounts": {
"type": "number",
"description": "This is the total discount.
Example: 445.54
Click here to see FedEx Discounts",
"format": "double",
"example": 445.54
},
"totalDutiesAndTaxes": {
"type": "number",
"description": "The sum of shipment/package Duties and taxes.
Example: 445.54",
"format": "double",
"example": 445.54
},
"variableHandlingCharges": {
"$ref": "#/components/schemas/VariableHandlingCharges"
},
"edtCharges": {
"type": "array",
"description": "These are the estimation and duty charges.",
"items": {
"$ref": "#/components/schemas/EdtCharge"
}
},
"totalAncillaryFeesAndTaxes": {
"type": "number",
"description": "Indicates the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.",
"format": "double",
"example": 445.54
},
"ratedPackages": {
"type": "array",
"description": "These are the package-level data for this rate type.",
"items": {
"$ref": "#/components/schemas/RatedPackageDetail"
}
},
"totalNetFedExCharge": {
"type": "number",
"description": "This shipment's totalNetFedExChargeList, which is totalNetFreight plus totalSurcharges (not including totalTaxes).",
"format": "double",
"example": 445.54
},
"quoteNumber": {
"type": "string",
"description": "Indicates the unique identifier for a specific rate quotation.
Example: XX1123XX",
"example": "quoteNumber"
},
"shipmentLegRateDetails": {
"type": "array",
"description": "This is data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type.",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ShipmentLegRateDetail_1"
}
]
}
},
"freightChargeBasis": {
"type": "string",
"description": "This identifies the manner in which the chargeRate was applied, for Freight.
Valid values are: - CWT - Charge rate applies per weight.
- FLAT - Charge rate is a flat-rate amount.
- MINIMUM
",
"example": "FLAT",
"enum": [
"CWT",
"FLAT",
"MINIMUM"
]
},
"totalVariableHandlingCharges": {
"$ref": "#/components/schemas/VariableHandlingCharges"
},
"totalVatCharge": {
"type": "number",
"description": "This is total value added tax charges (VAT).",
"format": "double",
"example": 445.54
},
"ancillaryFeesAndTaxes": {
"type": "array",
"description": "This is the total amount of the shipment-level fees and taxes that are not based on transportation charges of commodity-level estimated duties and taxes.",
"items": {
"$ref": "#/components/schemas/AncillaryFeesAndTaxes"
}
},
"preferredEdtCharges": {
"type": "array",
"description": "Specifies the Edt charges.",
"items": {
"$ref": "#/components/schemas/EdtCharge"
}
},
"totalNetCharge": {
"type": "number",
"description": "This is net charges for the shipment.",
"format": "double",
"example": 445.54
},
"totalBaseCharge": {
"type": "number",
"description": "This is total base charges for the shipment.",
"format": "double",
"example": 445.54
},
"totalNetChargeWithDutiesAndTaxes": {
"type": "number",
"description": "This is total net Charges with Duties And Taxes for the shipment.",
"format": "double",
"example": 445.54
},
"shipmentRateDetail": {
"$ref": "#/components/schemas/ShipmentRateDetail"
}
},
"description": "This object provides the shipment and package rating data in a rate request reply."
},
"VariableHandlingCharges": {
"type": "object",
"properties": {
"totalCustomerCharge": {
"type": "number",
"description": "Specifies the total customer assessed handling charges.
Example: 445.54",
"format": "double",
"example": 445.54
},
"variableHandlingCharge": {
"type": "number",
"description": "The variable handling charge amount calculated based on the requested variable handling charge detail.
Example: 403.2",
"format": "double",
"example": 403.2
}
},
"description": "The variable handling charge amount calculated based on the requested variable handling charge detail."
},
"EdtCharge": {
"type": "object",
"properties": {
"edtTaxDetail": {
"$ref": "#/components/schemas/EdtTaxDetail"
},
"harmonizedCode": {
"type": "string",
"description": "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.
Example: A six digit code for Almonds fresh or dried is 080211. The HTS code for pistachios in shell is 080251. The HTS code for fish is HS203.
To research the classification for your commodity, use the FedEx Global Trade Manager online at fedex.com/gtm. You can find the commodities and its respective codes by logging into FedEx and selecting harmonized code option. You will find country-specific information to determine whether your commodity is considered to be a document or non-document for your destination.
For additional information about harmonized code, refer to harmonized code.",
"example": "harmonizedCode"
}
},
"description": "estimated duties and tax charge"
},
"EdtTaxDetail": {
"type": "object",
"properties": {
"edtTaxType": {
"type": "string",
"description": "Specifies the Estimated duties and taxes type.
Example: TaxType",
"example": "TaxType"
},
"amount": {
"type": "number",
"description": "Specifies the amount for the estimated duties and taxes type.
Example: 785.12",
"format": "double",
"example": 785.12
},
"taxableValue": {
"type": "number",
"description": "Specifies the Estimated duties and taxes taxable Value.
Example: 562.23",
"format": "double",
"example": 562.23
},
"name": {
"type": "string",
"description": "Indicates the name for the Etd tax.",
"example": "name"
},
"description": {
"type": "string",
"description": "Indicates the description for the Etd tax.",
"example": "description"
},
"formula": {
"type": "string",
"description": "Indicates the formula.",
"example": "formula"
},
"effectiveDate": {
"type": "string",
"description": "Specifies the Estimated duties and taxes effective date. Format [YYYY-MM-DD].
Example: 2019-12-06",
"example": "2019-12-06"
}
},
"description": "Specifies the Estimated duties and taxes detail."
},
"RatedPackageDetail": {
"type": "object",
"properties": {
"effectiveNetDiscount": {
"type": "number",
"description": "This is the list net charge minus actual net charge.
Example: 1.0",
"format": "double",
"example": 0
},
"packageRateDetail": {
"$ref": "#/components/schemas/PackageRateDetail"
},
"groupNumber": {
"type": "integer",
"description": "This is group number, used only with package groups as a unique identifier of each group of identical packages.",
"format": "int32",
"example": 10
}
}
},
"PackageRateDetail": {
"type": "object",
"properties": {
"ratedWeightMethod": {
"type": "string",
"description": "Indicates which weight was used for the rate, e.g. actual or dimensional.
Example: dimensional",
"example": "dimensional"
},
"totalTaxes": {
"type": "number",
"description": "Specifies the sum of all taxes on this package.
Example: 1257.25",
"format": "double",
"example": 1257.25
},
"totalFreightDiscounts": {
"type": "number",
"description": "The total discounts used in the rate calculation.
Example: 1257.2
Click here to see Discounts",
"format": "double",
"example": 1257.26
},
"baseCharge": {
"type": "number",
"description": "Identifies the manner in which the chargeRate for this line item was applied.
Example: 125",
"format": "double",
"example": 125
},
"totalRebates": {
"type": "number",
"description": "The total sum of all rebates applied to this package.Example: 12",
"format": "double",
"example": 12
},
"rateType": {
"type": "string",
"description": "Specifies the type used for this specific set of rate data."
},
"billingWeight": {
"allOf": [
{
"$ref": "#/components/schemas/Weight"
},
{
"description": "Specifies the weight that was used to calculate the rate."
}
]
},
"netFreight": {
"type": "number",
"description": "Specifies the sum of freight charges.
Example: 10",
"format": "double",
"example": 10
},
"surcharges": {
"type": "array",
"description": "Specifies the list of all surcharges that apply to this package.",
"items": {
"$ref": "#/components/schemas/Surcharge"
}
},
"totalSurcharges": {
"type": "number",
"description": "The sum of all surcharges on the package.
Example: 569",
"format": "double",
"example": 569
},
"netFedExCharge": {
"type": "number",
"description": "Specifies the sum of packages netFreight and totalSurcharges (not including totalTaxes).
Example: 125.32",
"format": "double",
"example": 125.32
},
"netCharge": {
"type": "number",
"description": "Specifies the sum of packages netFreight, totalSurcharges and totalTaxes.
Example: 563.98",
"format": "double",
"example": 563
},
"freightDiscounts": {
"type": "array",
"description": "All rate discounts that apply to this shipment.
Click here to see Discounts",
"items": {
"$ref": "#/components/schemas/RateDiscount"
}
}
},
"description": "Data for a package's rates, as calculated per a specific rate type."
},
"Weight": {
"allOf": [
{
"$ref": "#/components/schemas/Weight_1"
},
{
"required": [
"units",
"value"
],
"properties": {
"units": {
"type": "string",
"example": "LB"
},
"value": {
"type": "number",
"example": 22
}
}
}
]
},
"Weight_1": {
"type": "object",
"properties": {
"units": {
"type": "string",
"description": "Specifies the package weight unit. For Dry Ice the unit of measure is KG.",
"enum": [
"KG",
"LB"
]
},
"value": {
"type": "number",
"description": "Specifies the package weight.
Example: 68.25",
"format": "double",
"example": 10
}
},
"description": "These are the weight details.",
"example": {
"units": "LB",
"value": 10
}
},
"Surcharge": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Specifies the surcharge type.
Example: FUEL
Click here to see more on Surcharges.",
"example": "FUEL"
},
"description": {
"type": "string",
"description": "Specifies the description of the surcharge. Indicates delivery and returns information for FedEx Ground Economy services.
Example: Fuel Surcharge",
"example": "Fuel Surcharge"
},
"amount": {
"type": "number",
"description": "Specify the declared monetary value/amount of the shipment.
Example: 5.42",
"format": "double",
"example": 5.42
},
"level": {
"type": "string",
"description": "Specifies the level of surcharge.
Example: level",
"example": "level"
},
"name": {
"type": "string",
"description": "The localized name of the surcharge.
Example: name",
"example": "name"
}
},
"description": "Specifies the surcharges."
},
"RateDiscount": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Indicates the details of the charges are to be added to the COD collect amount.
Example: 95",
"format": "double",
"example": 95
},
"name": {
"type": "string",
"description": "Specifies the name of all of the discounts that apply to the package.
Click here to see Discounts"
},
"description": {
"type": "string",
"description": "Specifies the discounts on this package."
},
"type": {
"type": "string",
"description": "Specifies the type of discount."
},
"percent": {
"type": "number",
"description": "Specifies the percentage of discount.",
"format": "double"
}
}
},
"ShipmentLegRateDetail_1": {
"type": "object",
"properties": {
"discounts": {
"type": "array",
"description": "Specifies the list of discounts.
Click here to see Discounts",
"items": {
"$ref": "#/components/schemas/RateDiscount_1"
}
},
"pricingCode": {
"type": "string",
"description": "Identifies the type of pricing used for this shipment.
Example: ACTUAL",
"example": "ACTUAL"
},
"legDescription": {
"type": "string",
"description": "Human-readable text describing the shipment leg.
Example: legDescription",
"example": "legDescription"
},
"surcharges": {
"type": "array",
"description": "Specifies the list of surcharges.
Valid value is:PEAKPEAK_ADDTIONAL_HANDLINGPEAK_OVERSIZEPEAK_RESIDENTIAL_DELIVERY",
"items": {
"$ref": "#/components/schemas/Surcharge_1"
}
},
"specialRatingApplied": {
"type": "array",
"description": "Indicates which special rating cases applied to this shipment.",
"items": {
"type": "string"
}
},
"taxes": {
"type": "array",
"description": "Specifies the list of taxes.",
"items": {
"$ref": "#/components/schemas/Tax_1"
}
},
"rateScale": {
"type": "string",
"description": "Indicates the rate scale used.
Example: *USER IMS20160104 LD067110"
},
"totalNetCharge": {
"type": "number",
"description": "This shipment's totalNetCharge and totalDutiesTaxesAndFees. Some duties and taxes are only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
Example: 87.5",
"format": "double",
"example": 87.5
},
"totalBaseCharge": {
"type": "number",
"description": "Specifies the total base charge list.
Example: 87.5",
"format": "double",
"example": 87.5
},
"currencyExchangeRate": {
"$ref": "#/components/schemas/CurrencyExchangeRate"
},
"totalBillingWeight": {
"description": "Sum of billing weight for the shipment.",
"allOf": [
{
"$ref": "#/components/schemas/Weight_1"
}
]
},
"currency": {
"type": "string",
"description": "Indicate the three-character ISO currency code.
Example: USD
Click here to see Currency Codes",
"example": "USD"
}
}
},
"RateDiscount_1": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Indicates the amount for the rate discount.
Example: 87.5",
"format": "double",
"example": 87.5
},
"name": {
"type": "string",
"description": "Indicate the name of the discount.Click here to see Discounts
Example: name",
"example": "name"
},
"description": {
"type": "string",
"description": "Indicates the description for the rate discount.
Example: Description",
"example": "description"
},
"type": {
"type": "string",
"description": "Indicates the type.
Example: type",
"example": "type"
},
"percent": {
"type": "number",
"description": "Indicates the percentage of the rate discount.
Example: 10.5",
"format": "double",
"example": 10.5
}
}
},
"Surcharge_1": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
Example: 87.5",
"format": "double",
"example": 87.5
},
"level": {
"type": "string",
"description": "The level of surcharge.
Example: level",
"example": "level"
},
"name": {
"type": "string",
"description": "The localized name of the surcharge.
Example: name",
"example": "name"
},
"description": {
"type": "string",
"description": "The description of the surcharge.
Example: description",
"example": "description"
},
"type": {
"type": "string",
"description": "The type of surcharge.
Example: type",
"example": "type"
}
}
},
"Tax_1": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Specifies the list of tax amounts.
Example : 87.5",
"format": "double",
"example": 87.5
},
"name": {
"type": "string",
"description": "Specifies the localized name of the tax.
Example: Name"
},
"description": {
"type": "string",
"description": "Specifies the description of the Surcharge/Tax.
Example: description"
},
"type": {
"type": "string",
"description": "Specifies the type of Surcharge/Tax.
Example: type"
}
},
"description": "Specifies the Tax surcharge details"
},
"CurrencyExchangeRate": {
"type": "object",
"properties": {
"fromCurrency": {
"type": "string",
"description": "The currency code for the original (converted FROM) currency.",
"example": "USD"
},
"intoCurrency": {
"type": "string",
"description": "The currency code for the final (converted INTO) currency.",
"example": "USD"
},
"rate": {
"type": "number",
"description": "Multiplier used to convert fromCurrency units to intoCurrency units.",
"format": "double",
"example": 87.5
}
},
"description": "Specifies the currency exchange performed on financial amounts for this rate."
},
"AncillaryFeesAndTaxes": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Specifies the list of ancillary fees And Taxes",
"format": "double",
"example": 87.5
},
"description": {
"type": "string",
"description": "Identifies the amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.",
"example": "description"
},
"type": {
"type": "string",
"description": "Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.",
"example": "type"
}
}
},
"ShipmentRateDetail": {
"type": "object",
"properties": {
"currencyExchangeRate": {
"$ref": "#/components/schemas/CurrencyExchangeRate"
},
"currency": {
"type": "string",
"description": "Indicates the currency associated with the amount.",
"example": "USD"
},
"rateZone": {
"type": "string",
"description": "Indicates the rate zone used.",
"example": "CA003O"
},
"ratingBasis": {
"type": "string",
"description": "Allows clients to determine whether to add charges at the package level when Per Piece Rating details are returned.
- SHIPMENT_WEIGHT_BASED - Indicates shipment weight is used to calculate the rate.
- FLAT_RATE_PER_PAK - Indicates shipment is rated based on number of packs, weight would be considered for overweight surcharge but not for calculating shipment rate.
- PACK_WEIGHT_BASED - Indicates individual package weight would be rated and aggregated to get shipment rate weight.
Example : SHIPMENT_WEIGHT_BASED.",
"example": "SHIPMENT_WEIGHT_BASED",
"enum": [
"SHIPMENT_WEIGHT_BASED",
"FLAT_RATE_PER_PACK",
"PACK_WEIGHT_BASED"
]
},
"pricingCode": {
"type": "string",
"description": "Indicates the type of pricing code.",
"example": "ACTUAL"
},
"totalFreightDiscount": {
"type": "number",
"description": "Indicates the total discounts used in the rate calculation. Example: 856.32",
"format": "double",
"example": 856.32
},
"specialRatingApplied": {
"type": "array",
"description": "Indicates which special rating cases applied to this shipment.",
"example": "Specialrating",
"items": {
"type": "string"
}
},
"totalSurcharges": {
"type": "number",
"description": "This is sum of all surcharges on the package. Example: 586.25",
"format": "double",
"example": 586.25
},
"freightDiscount": {
"type": "array",
"description": "This is total discount used in the rate calculation.
Click here to see Discounts",
"items": {
"$ref": "#/components/schemas/RateDiscount"
}
},
"fuelSurchargePercent": {
"type": "number",
"description": "This is fuel surcharge percentage.",
"format": "double",
"example": 10.5
},
"totalBillingWeight": {
"description": "This is total of billing weight for the shipment.",
"allOf": [
{
"$ref": "#/components/schemas/Weight_1"
}
]
},
"totalDimWeight": {
"description": "This is total of dimensional weight for the shipment.",
"allOf": [
{
"$ref": "#/components/schemas/Weight_1"
}
]
},
"dimDivisor": {
"type": "integer",
"description": "Identifies the type of divisor that was applied.
Example: 10",
"format": "int32",
"example": 10
},
"surCharges": {
"type": "array",
"description": "Indicates the surcharges applied to this shipment.",
"items": {
"$ref": "#/components/schemas/Surcharge"
}
},
"taxes": {
"description": "List of taxes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tax"
}
}
},
"description": "This is shipment level rate data."
},
"OperationalDetail": {
"type": "object",
"properties": {
"originLocationIds": {
"type": "array",
"description": "Indicate the location ID of the origin of shipment.
Example: YBZA",
"example": "YBZA",
"items": {
"type": "string"
}
},
"commitDays": {
"type": "array",
"description": "Indicate the delivery commitment day.
Example: MON",
"example": "MON",
"items": {
"type": "string"
}
},
"serviceCode": {
"type": "string",
"description": "Indicate the service code.
Example: 06",
"example": "06"
},
"airportId": {
"type": "string",
"description": "Specify the Airport Id.
Example: MEM",
"example": "MEM"
},
"scac": {
"type": "string",
"description": "Indicate the Standard Carrier Alpha Code (SCAC) is a privately controlled US code used to identify vessel operating common carriers (VOCC). It is typically two to four letters long.",
"example": "scac"
},
"originServiceAreas": {
"type": "array",
"description": "Specify origin service area.
Example: AM",
"example": "AM",
"items": {
"type": "string"
}
},
"deliveryDay": {
"type": "string",
"description": "Specify the delivery commitment day.
Example: SAT",
"example": "SAT"
},
"originLocationNumbers": {
"type": "array",
"description": "Specify the origin location ID.
Example: 6121",
"example": 6121,
"items": {
"type": "integer",
"format": "int32"
}
},
"destinationPostalCode": {
"type": "string",
"description": "Indicate the destination postal code.
Example: 38017",
"example": "38017"
},
"commitDate": {
"type": "string",
"description": "Indicate the shipment Commit Date.
Example: 2019-07-22T08:30:00",
"example": "2019-07-22T08:30:00"
},
"astraDescription": {
"type": "string",
"description": "Indicate the ASTRA description for the label.
Example: XXXL1ST",
"example": "INTL1ST"
},
"deliveryDate": {
"type": "string",
"description": "Indicate the delivery date.
Example: 2019-07-22T08:30:00",
"example": "2019-07-22T08:30:00"
},
"deliveryEligibilities": {
"type": "array",
"description": "Indicate the delivery eligibilities.",
"example": "Availavble Eligibilities",
"items": {
"type": "string"
}
},
"ineligibleForMoneyBackGuarantee": {
"type": "boolean",
"description": "indicate if ineligible For Money Back Guarantee.",
"example": false
},
"MaximumTransitTime": {
"type": "string",
"description": "Specify Maximum transit time.
Example: THREE_DAYS",
"example": "THREE_DAYS"
},
"astraPlannedServiceLevel": {
"type": "string",
"description": "Indicate Astra Planned Service Level.
Example: astraPlannedServicelevel",
"example": "astraPlannedServicelevel"
},
"destinationLocationIds": {
"type": "array",
"description": "Indicate Destination Location Ids.
Example: HKAA",
"example": "HKAA",
"items": {
"type": "string"
}
},
"destinationLocationStateOrProvinceCodes": {
"type": "array",
"description": "Indicate destination location State Or Province code.
Example: TN
Click here to see State Or Province Code",
"example": "TN",
"items": {
"type": "string"
}
},
"transitTime": {
"type": "string",
"description": "Indicate the Transit Time in days.
Example: THREE_DAYS",
"example": "THREE_DAYS"
},
"packagingCode": {
"type": "string",
"description": "Indicate the Packaging Code.
Example: M1M1M1",
"example": "M1M1M1"
},
"destinationLocationNumbers": {
"type": "array",
"description": "Indicate the Destination Location Numbers.
Example: 386",
"example": 386,
"items": {
"type": "integer",
"format": "int32"
}
},
"publishedDeliveryTime": {
"type": "string",
"description": "Indicate the Published Delivery Time.
Example: THREE_DAYS",
"example": "THREE_DAYS"
},
"countryCodes": {
"type": "array",
"description": "Indicate the Country Code.
Example: [ US, IN]
Click here to see Country Codes",
"example": "US",
"items": {
"type": "string"
}
},
"stateOrProvinceCodes": {
"type": "array",
"description": "Specifies state Or Province Code. State code is required for US, CA, PR and not required for other countries. Conditional. Max length is 2.
Example: TN",
"example": "TN",
"items": {
"type": "string"
}
},
"ursaPrefixCode": {
"type": "string",
"description": "This is FedEx URSA Prefix Code.
Example: PrefixCode",
"example": "PrefixCode"
},
"ursaSuffixCode": {
"type": "string",
"description": "This is URSA Suffix Code.
Example: SuffixCode",
"example": "SuffixCode"
},
"destinationServiceAreas": {
"type": "array",
"description": "This is Destination Service Areas.
Example: A2",
"example": "A2",
"items": {
"type": "string"
}
},
"originPostalCodes": {
"type": "array",
"description": "This is Origin Postal Codes.
Example: M1M1M1",
"example": "M1M1M1",
"items": {
"type": "string"
}
},
"customTransitTime": {
"type": "string",
"description": "This is Custom Transit Time in days.
Example: THREE_DAYS",
"example": "THREE_DAYS"
}
},
"description": "Indicate the Operational Details."
},
"ServiceDescription": {
"type": "object",
"properties": {
"serviceType": {
"type": "string",
"description": "This is the service type.
Example: INTERNATIONAL_FIRST
Click here to see Service Types",
"example": "INTERNATIONAL_FIRST"
},
"code": {
"type": "string",
"description": "Specifies the service code.
Example: 92",
"example": "92"
},
"names": {
"type": "array",
"description": "Specifies the service name.",
"items": {
"$ref": "#/components/schemas/ProductName"
}
},
"astraDescription": {
"type": "string",
"description": "Specifies astra description.
Example: INTL1ST",
"example": "INTL1ST"
},
"description": {
"type": "string",
"description": "Specifies description of the service.
Example: FedEx Ground",
"example": "FedEx Ground"
},
"serviceId": {
"type": "string",
"description": "Specifies the service Id.
Example: EP1000000135",
"example": "EP1000000135"
},
"serviceCategory": {
"type": "string",
"description": "Specifies service category.
Example: parcel",
"example": "parcel"
}
},
"description": "Indicates the provides the Service Description details."
},
"ProductName": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Specifies the type of the product.
Example: medium",
"example": "medium"
},
"encoding": {
"type": "string",
"description": "Specifies the encoding standard.
Example: utf-8.",
"example": "utf-8"
},
"value": {
"type": "string",
"description": "Specifies the value of the Product.
Example: FedEx International First®.",
"example": "FedEx International First®"
}
},
"description": "Provides the product details."
},
"BrokerDetail": {
"required": [
"broker",
"type"
],
"type": "object",
"properties": {
"broker": {
"$ref": "#/components/schemas/BrokerDetailBroker"
},
"type": {
"type": "string",
"description": "This is Broker Type.Example:IMPORT",
"example": "IMPORT",
"enum": [
"IMPORT"
]
}
},
"description": "These are Broker Detail for the rate quote."
},
"BrokerDetail_RateReply": {
"required": [
"broker",
"type"
],
"type": "object",
"properties": {
"broker": {
"$ref": "#/components/schemas/BrokerDetailBroker_RateReply"
},
"type": {
"type": "string",
"description": "This is Broker Type.",
"example": "EXPORT",
"enum": [
"EXPORT",
"IMPORT"
]
},
"brokerAddress": {
"$ref": "#/components/schemas/Brokeraddress"
}
},
"description": "These are Broker Detail for the rate quote."
},
"BrokerDetailBroker": {
"allOf": [
{
"$ref": "#/components/schemas/Party"
},
{
"required": [
"address",
"contact"
],
"properties": {
"address": {
"description": "These are Broker address details."
},
"contact": {
"description": "These are broker contact details such as Name, Email, PhoneNumber."
}
}
}
]
},
"BrokerDetailBroker_RateReply": {
"allOf": [
{
"$ref": "#/components/schemas/Party"
},
{
"required": [
"address"
],
"properties": {
"address": {
"description": "These are Broker address details."
}
}
}
]
},
"Party": {
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/Address"
},
"accountNumber": {
"$ref": "#/components/schemas/AccountNumber"
}
},
"description": "Indicate the party to a transaction including the physical address, contact information and account number information.",
"example": {
"accountNumber": {
"value": 123456789
}
}
},
"Address": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "This is a placeholder for City Name.
Example: Beverly Hills",
"example": "Beverly Hills"
},
"stateOrProvinceCode": {
"type": "string",
"description": "This is a placeholder for State or Province code.State code is required for US, CA, PR and not required for other countries. Conditional. Max length is 2.
Example: CA
Click here to see State Or Province Code",
"example": "TN"
},
"postalCode": {
"type": "string",
"description": "Indicate the Postal code. This is optional for non postal-aware countries. Maximum length is 10.
Example: 65247
Click here to see Postal aware countries",
"example": "65247"
},
"countryCode": {
"type": "string",
"description": "This is the two-letter country code. Maximum length is 2.
Example: US
Click here to see Country Codes",
"example": "US"
},
"residential": {
"type": "boolean",
"description": "Indicate whether this address is residential (as opposed to commercial).
Valid values are TRUE and FALSE.",
"example": false
}
},
"description": "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 (such as a city-state-ZIP combination within the U.S.).",
"example": {
"streetLines": [
"1550 Union Blvd",
"Suite 302"
],
"city": "Beverly Hills",
"stateOrProvinceCode": "TN",
"postalCode": "38127",
"countryCode": "US",
"residential": false
}
},
"Contact": {
"type": "object",
"properties": {
"personName": {
"type": "string",
"description": "Specifies contact name.
Note: Recommended Length is 70. There's no specific validation for the length.
Example: John Taylor",
"example": "John Taylor"
},
"emailAddress": {
"type": "string",
"description": "Specifies contact email address. Maximum length is 80.
Example: sample@company.com",
"example": "sample@company.com"
},
"phoneNumber": {
"type": "string",
"description": "Specifies contact phone number. Maximum length is 15.
Example: 1234567890",
"example": "1234567890"
},
"phoneExtension": {
"type": "string",
"description": "Specifies contact phone extension. Maximum length is 6.
Example: 1234",
"example": "1234"
},
"faxNumber": {
"type": "string",
"description": "Specifies contact fax number. Maximum length is 15.
Example: 1234567890",
"example": "1234567890"
},
"companyName": {
"type": "string",
"description": "Specifies contact company name. Maximum length is 35.",
"example": "Fedex"
}
},
"description": "Indicates the contact details.",
"example": {
"personName": "John Taylor",
"emailAddress": "sample@company.com",
"phoneNumber": "1234567890",
"phoneExtension": "1234",
"faxNumber": "1234567890",
"companyName": "Fedex"
}
},
"ParsedPersonName": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "Specify the First Name. Maximum Length is 35.
Example: John",
"example": "firstName"
},
"lastName": {
"type": "string",
"description": "Specify the Last Name. Maximum Length is 35.
Example: Mayor",
"example": "lastName"
},
"middleName": {
"type": "string",
"description": "Specify the Middle Name.
Example: Redmond",
"example": "middleName"
},
"suffix": {
"type": "string",
"description": "Specify the Suffix.
Example: Jr",
"example": "suffix"
}
},
"description": "This object is used to separate the person name into first and last name.",
"example": {
"firstName": "John",
"lastName": "Mayor",
"middleName": "Redmond",
"suffix": "Jr"
}
},
"AccountNumber": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "This is the account number. Maximum Length is 9.
Example: Your account number",
"example": "Your account number"
}
},
"description": "This is the Account number details.
Note:- If the paymentType is Sender, then the account number is optional in shippingChargesPayment.
",
"example": {
"value": "Your account number"
}
},
"Brokeraddress": {
"type": "object",
"properties": {
"streetLines": {
"type": "array",
"description": "This is the combination of number, street name, etc.
Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included. Maximum Length per line is 35.
Example: [10 FedEx Parkway, Suite 302, .etc.]",
"example": [
"10 FedEx Parkway",
"Suite 302"
],
"items": {
"type": "string"
}
},
"city": {
"type": "string",
"description": "This is city name.
Example: Beverly Hills",
"example": "Beverly Hills"
},
"stateOrProvinceCode": {
"type": "string",
"description": "This is the state Or Province Code. State code is required for US, CA, PR and not required for other countries. Conditional. Max length is 2.
Example: CA
Click here to see State Or Province Code",
"example": "CA"
},
"postalCode": {
"type": "string",
"description": "This is the postal code.
Example: 90210
Click here to see Postal aware countries",
"example": "90210"
},
"countryCode": {
"type": "string",
"description": "This is the country code.
US
Click here to see Country Codes",
"example": "US"
},
"residential": {
"type": "boolean",
"description": "Indicate whether this address is residential (as opposed to commercial).
Valid values are TRUE and FALSE.",
"example": false
},
"classification": {
"type": "string",
"description": "Specify the classification of the address.
Example: residential",
"example": "residential"
},
"geographicCoordinates": {
"type": "string",
"description": "Specify the geographic coordinates.
Example: geographicCoordinates",
"example": "geographicCoordinates"
},
"urbanizationCode": {
"type": "string",
"description": "Specify the urbanization code.",
"example": "code"
},
"countryName": {
"type": "string",
"description": "Specify the country name.
Example: India",
"example": "India"
}
},
"description": "This is the broker address used for this shipment."
},
"Commit": {
"description": "Specifies the delivery commitment details date/time.",
"allOf": [
{
"$ref": "#/components/schemas/CommitDetail_1"
}
]
},
"CommitDetail_1": {
"type": "object",
"properties": {
"daysInTransit": {
"type": "string",
"description": "Code indicating the number of transit days.
Example: EIGHTEEN_DAYS",
"enum": [
"EIGHT_DAYS",
"EIGHTEEN_DAYS",
"ELEVEN_DAYS",
"FIFTEEN_DAYS",
"FIVE_DAYS",
"FOUR_DAYS",
"FOURTEEN_DAYS",
"NINE_DAYS",
"NINETEEN_DAYS",
"ONE_DAY",
"SEVEN_DAYS",
"SEVENTEEN_DAYS",
"SIX_DAYS",
"SIXTEEN_DAYS",
"TEN_DAYS",
"THIRTEEN_DAYS",
"THREE_DAYS",
"TWELVE_DAYS",
"TWENTY_DAYS",
"TWO_DAYS",
"SMARTPOST_TRANSIT_DAYS",
"UNKNOWN"
]
},
"guaranteedType": {
"type": "string",
"description": "Indicates if there is a guaranteed delivery option applied to the rate. This is for freight rates only.
Valid values
GUARANTEED_MORNING - guaranteed delivery on morning of date specified.
GUARANTEED_CLOSE_OF_BUSINESS - guaranteed delivery on date specified by close of day
Example: GUARANTEED_MORNING",
"enum": [
"GUARANTEED_MORNING",
"GUARANTEED_CLOSE_OF_BUSINESS"
]
},
"smartPostCommitTime": {
"type": "string",
"description": "CommitTime for SmartPost shipments.",
"example": "commitTime"
},
"dateDetail": {
"$ref": "#/components/schemas/DateDetail"
},
"delayDetails": {
"$ref": "#/components/schemas/DelayDetail"
},
"saturdayDelivery": {
"type": "boolean",
"description": "Specifies the saturdayDelivery.",
"example": false
},
"alternativeCommodityNames": {
"type": "array",
"description": "Specifies the alternate names of commodities.",
"example": [
"Commodity1",
"Commodity2"
],
"items": {
"type": "string",
"description": "Specifies the items."
}
},
"transitDays": {
"$ref": "#/components/schemas/TransitDays"
},
"label": {
"type": "string",
"description": "This is an informational message to inform client Deliverydate is unavailable. If commitTimestamp and transitTime are unavailable, then this is populated in the response in the client language.
Example: Deliverydate unavailable",
"example": "Deliverydate unavailable"
},
"commitMessageDetails": {
"type": "string",
"description": "Messages concerning the ability to provide an accurate delivery commitment on an International commit quote. These could be messages providing information about why a commitment could not be returned or a successful message.
Example: Message",
"example": "Message"
},
"commodityName": {
"type": "string",
"description": "The Commodity applicable to this commitment.
Example: DOCUMENTS",
"example": "DOCUMENTS"
}
},
"description": "The delivery commitment details"
},
"DateDetail": {
"type": "object",
"properties": {
"dayOfWeek": {
"type": "string",
"description": "specific day of week in short format
Example: MON, TUE",
"example": "THU"
},
"dayFormat": {
"type": "string",
"description": "This is expected delivery date in format [YYYY-MM-DDTHH:mm:ss]
Example: 2020-07-16T10:30:00",
"example": "2020-07-16T10:30:00"
}
},
"description": "These are date and time details.",
"example": {
"dayOfWeek": "THU",
"dayFormat": "2020-07-16T10:30:00"
}
},
"DelayDetail": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "delay date. format [YYYY-MM-DD]",
"format": "[YYYY-MM-DD]",
"example": "2023-11-25"
},
"dayOfWeek": {
"type": "string",
"description": "The delay day of the week",
"example": "THU"
},
"level": {
"type": "string",
"description": "The attribute of the shipment that caused the delay(e.g. Country, City, LocationId, Zip, service area, special handling)",
"example": "Country"
},
"point": {
"type": "string",
"description": "The point in transit where the delay is occurring (e.g. Origin, Destination, Broker location)",
"example": "Origin"
},
"type": {
"type": "string",
"description": "The reason for the delay (e.g. holiday, weekend, etc.).",
"example": "holiday"
},
"description": {
"type": "string",
"description": "The name of the holiday in that country that is causing the delay.",
"example": "Christmas"
}
},
"description": "Information about why a shipment delivery is delayed and at what level",
"example": {
"date": "2023-11-25",
"dayOfWeek": "SAT",
"level": "COUNTRY",
"point": "PROOF_OF_DELIVERY_POINT",
"type": "WEEKEND"
}
},
"TransitDays": {
"description": "These are number of days the package/shipment is to be in transit. Applies to Ground and LTL Freight; indicates minimum transit time for SmartPost.",
"type": "object",
"properties": {
"description": {
"description": "Specifies the number of days the package/shipment is to be in transit.
Example: 2 Business Days",
"type": "string",
"example": "2-7 Business Days"
},
"minimumTransitTime": {
"type": "string",
"description": "Code indicating the number of transit days.
Example: TW0_DAYS",
"enum": [
"EIGHT_DAYS",
"EIGHTEEN_DAYS",
"ELEVEN_DAYS",
"FIFTEEN_DAYS",
"FIVE_DAYS",
"FOUR_DAYS",
"FOURTEEN_DAYS",
"NINE_DAYS",
"NINETEEN_DAYS",
"ONE_DAY",
"SEVEN_DAYS",
"SEVENTEEN_DAYS",
"SIX_DAYS",
"SIXTEEN_DAYS",
"TEN_DAYS",
"THIRTEEN_DAYS",
"THREE_DAYS",
"TWELVE_DAYS",
"TWENTY_DAYS",
"TWO_DAYS",
"SMARTPOST_TRANSIT_DAYS",
"UNKNOWN"
],
"example": "TWO_DAYS"
},
"maximumTransitTime": {
"type": "string",
"example": "SEVEN_DAYS"
}
}
},
"ServiceSubOptionDetail": {
"type": "object",
"properties": {
"smartPostIndiciaType": {
"type": "string",
"description": "This identifies the indicia used during rate quote.",
"example": "PRESORTED_STANDARD",
"enum": [
"MEDIA_MAIL",
"PARCEL_RETURN",
"PARCEL_SELECT",
"PRESORTED_BOUND_PRINTED_MATTER",
"PRESORTED_STANDARD"
]
}
},
"description": "These are supporting detail for applied options identified in a rate quote."
},
"Alert": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Specifies the alert code."
},
"alertType": {
"type": "string",
"description": "Specifies the alert type.",
"example": "WARNING",
"enum": [
"NOTE",
"WARNING"
]
},
"message": {
"type": "string",
"description": "Specifies the alert message.",
"example": "Shipper Postal-City Mismatch."
}
},
"description": "Specifies the alerts."
},
"ErrorResponseVO": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "The transaction ID is a special set of numbers that defines each transaction.
Example: 624deea6-b709-470c-8c39-4b5511281492",
"example": "624deea6-b709-470c-8c39-4b5511281492"
},
"customerTransactionId": {
"type": "string",
"description": "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",
"example": "AnyCo_order123456789"
},
"errors": {
"type": "array",
"description": "Indicates error alert when suspicious files, potential exploits and viruses found while scanning files , directories and user accounts. This includes code, message and parameter.",
"items": {
"$ref": "#/components/schemas/CXSError"
}
}
}
},
"CXSError": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Indicates the error code.
Example:
ACCOUNT.NUMBER.MISMATCH
"
},
"parameterList": {
"type": "array",
"description": "List of parameters which indicates the properties of the alert message.",
"items": {
"$ref": "#/components/schemas/Parameter"
}
},
"message": {
"type": "string",
"description": "Indicates the description of error alert message.
Example: When payment Type is SENDER, ShippingChargesPayment Payor AccountNumber should match the shipper account number."
}
}
},
"Parameter": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Identifies the error option to be applied."
},
"key": {
"type": "string",
"description": "Indicates the value associated with the key."
}
},
"description": "List of parameters which indicates the properties of the alert message."
},
"ErrorResponseVO401": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "The transaction ID is a special set of numbers that defines each transaction.
Example: 624deea6-b709-470c-8c39-4b5511281492",
"example": "624deea6-b709-470c-8c39-4b5511281492"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CXSError401"
}
}
}
},
"CXSError401": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Indicates the error code.
Example: NOT.AUTHORIZED.ERROR"
},
"parameterList": {
"type": "array",
"description": "Specifies list of parameters.",
"items": {
"$ref": "#/components/schemas/Parameter"
}
},
"message": {
"description": "Indicates the description of API error alert message.
Example: Access token expired. Please modify your request and try again."
}
},
"description": "Indicates error alert when suspicious files, potential exploits and viruses found while scanning files , directories and user accounts. This includes code, message and parameter"
},
"ErrorResponseVO403": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "The transaction ID is a special set of numbers that defines each transaction.
Example: 624deea6-b709-470c-8c39-4b5511281492",
"example": "624deea6-b709-470c-8c39-4b5511281492"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CXSError403"
}
}
}
},
"CXSError403": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Indicates the error code.
Example: FORBIDDEN.ERROR"
},
"parameterList": {
"type": "array",
"description": "Specifies list of parameters.",
"items": {
"$ref": "#/components/schemas/Parameter"
}
},
"message": {
"description": "Indicates the description of API error alert message.
Example: We could not authorize your credentials. Please check your permissions and try again"
}
},
"description": "Indicates error alert when suspicious files, potential exploits and viruses found while scanning files , directories and user accounts. This includes code, message and parameter"
},
"ErrorResponseVO404": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "The transaction ID is a special set of numbers that defines each transaction.
Example: 624deea6-b709-470c-8c39-4b5511281492",
"example": "624deea6-b709-470c-8c39-4b5511281492"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CXSError404"
}
}
}
},
"CXSError404": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Indicates the error code.
Example: NOT.FOUND.ERROR"
},
"parameterList": {
"type": "array",
"description": "Specifies list of parameters.",
"items": {
"$ref": "#/components/schemas/Parameter"
}
},
"message": {
"description": "Indicates the description of API error alert message.
Example: The resource you requested is no longer available. Please modify your request and try again."
}
},
"description": "Indicates error alert when suspicious files, potential exploits and viruses found while scanning files , directories and user accounts. This includes code, message and parameter"
},
"ErrorResponseVO500": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "The transaction ID is a special set of numbers that defines each transaction.
Example: 624deea6-b709-470c-8c39-4b5511281492",
"example": "624deea6-b709-470c-8c39-4b5511281492"
},
"customerTransactionId": {
"type": "string",
"description": "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",
"example": "AnyCo_order123456789"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CXSError500"
}
}
}
},
"CXSError500": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Indicates the error code.
Example: INTERNAL.SERVER.ERROR"
},
"parameterList": {
"type": "array",
"description": "Specifies list of parameters.",
"items": {
"$ref": "#/components/schemas/Parameter"
}
},
"message": {
"description": "Indicates the description of API error alert message.
Example: We encountered an unexpected error and are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
}
},
"description": "Indicates error alert when suspicious files, potential exploits and viruses found while scanning files , directories and user accounts. This includes code, message and parameter"
},
"ErrorResponseVO503": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "The transaction ID is a special set of numbers that defines each transaction.
Example: 624deea6-b709-470c-8c39-4b5511281492",
"example": "624deea6-b709-470c-8c39-4b5511281492"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CXSError503"
}
}
}
},
"CXSError503": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Indicates the error code.
Example: SERVICE.UNAVAILABLE.ERROR"
},
"parameterList": {
"type": "array",
"description": "Specifies list of parameters.",
"items": {
"$ref": "#/components/schemas/Parameter"
}
},
"message": {
"description": "Indicates the description of API error alert message.
Example: The service is currently unavailable and we are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
}
},
"description": "Indicates error alert when suspicious files, potential exploits and viruses found while scanning files , directories and user accounts. This includes code, message and parameter"
},
"Full_Schema_Quote_Rate": {
"required": [
"accountNumber",
"requestedShipment"
],
"type": "object",
"properties": {
"accountNumber": {
"$ref": "#/components/schemas/AccountNumber"
},
"rateRequestControlParameters": {
"$ref": "#/components/schemas/RateRequestControlParameters"
},
"requestedShipment": {
"$ref": "#/components/schemas/RequestedShipment"
},
"processingOptions": {
"type": "array",
"description": "- 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.
.",
"items": {
"type": "string",
"example": "INCLUDE_PICKUPRATES",
"enum": [
"INCLUDE_PICKUPRATES"
]
}
},
"carrierCodes": {
"type": "array",
"description": "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.
",
"example": [
"FDXE",
"FDXG"
],
"items": {
"type": "string"
}
},
"version": {
"$ref": "#/components/schemas/Version"
}
},
"description": "The request elements for requesting a rate quote."
},
"Version": {
"type": "object",
"properties": {
"major": {
"description": "This version is incremented when significant changes are made to the API functionality. These could be breaking changes and might require code-adjustments from clients. Accepts only numbers",
"example": "1",
"type": "integer"
},
"minor": {
"description": "This represents a backward-compatible bug fix or minor adjustment to an existing API functionality. This is the second number in API versioning scheme. Accepts only numbers",
"example": "1",
"type": "integer"
},
"patch": {
"description": "This represents a backward-compatible bug fix or minor adjustment to an existing API functionality. This is the third number in API versioning scheme. Accepts only numbers",
"example": "1",
"type": "integer"
}
}
},
"FDGSamplePayload-RateResourceDetails-IntraEurope": {
"example": {
"rateRequestControlParameters": {
"rateSortOrder": "COMMITASCENDING",
"returnTransitTimes": true,
"servicesNeededOnRateFailure": false
},
"requestedShipment": {
"shipper": {
"accountNumber": {
"value": "XXXXX2630",
"key": ""
},
"address": {
"streetLines": [
"SENDER ADDRESS"
],
"city": "SENDER CITY",
"stateOrProvinceCode": "SENDER PROVINCE CODE",
"postalCode": "5003",
"countryCode": "NO"
}
},
"recipient": {
"address": {
"streetLines": [
"RECIPIENT ADDRESS 1"
],
"city": "RECIPIENT city",
"stateOrProvinceCode": "RECIPIENT PROVINCE CODE",
"postalCode": "5003",
"countryCode": "NO"
}
},
"serviceType": "FEDEX_PRIORITY",
"packagingType": "YOUR_PACKAGING",
"pickupType": "CONTACT_FEDEX_TO_SCHEDULE",
"shippingChargesPayment": {
"payor": {
"responsibleParty": {
"accountNumber": {
"value": "XXXXX2630",
"key": ""
},
"address": {
"countryCode": "ES"
}
}
}
},
"blockInsightVisibility": false,
"edtRequestType": "NONE",
"specialServicesRequested": {
"specialServiceTypes": []
},
"rateRequestType": [
"LIST"
],
"requestedPackageLineItems": [
{
"groupPackageCount": 1,
"physicalPackaging": "YOUR_PACKAGING",
"insuredValue": {
"currency": "USD",
"amount": 0
},
"weight": {
"units": "KG",
"value": 2
},
"dimensions": {
"length": 20,
"width": 20,
"units": "CM",
"height": 20
},
"packageSpecialServices": {
"specialServiceTypes": [
"DANGEROUS_GOODS"
],
"dangerousGoodsDetail": {
"regulation": "ADR",
"options": [
"HAZARDOUS_MATERIALS"
],
"accessibility": "ACCESSIBLE"
}
}
}
]
},
"returnLocalizedDateTime": true,
"webSiteCountryCode": "US"
}
},
"MinimumSamplePayload_1": {
"example": {
"accountNumber": {
"value": "XXXXX7354"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": "65247",
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": "72348",
"countryCode": "US"
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"rateRequestType": [
"ACCOUNT",
"LIST"
],
"requestedPackageLineItems": [
{
"weight": {
"units": "LB",
"value": "10"
}
}
]
}
}
},
"FreightSamplePayload-RateResourceDetails_1": {
"example": {
"accountNumber": {
"value": "XXXXX9837"
},
"requestedShipment": {
"freightShipmentDetail": {
"role": "SHIPPER",
"lineItem": [
{
"pieces": "1",
"handlingUnits": "1",
"freightClass": "CLASS_060",
"subPackagingType": "PALLET",
"description": "books autograph",
"weight": {
"units": "LB",
"value": "1000.00"
},
"id": "books",
"dimensions": {
"length": "15",
"width": "15",
"units": "IN",
"height": "15"
}
}
],
"fedExFreightBillingContactAndAddress": {
"address": {
"residential": false,
"city": "COLLIERVILLE",
"countryCode": "US",
"streetLines": [
"20 FEDEX PKWY"
],
"postalCode": "380178711",
"stateOrProvinceCode": "TN"
},
"contact": {
"personName": "BRON TAPES",
"emailAddress": "neena_sebastian@syntelinc.com",
"phoneNumber": "9012635448",
"phoneExtension": "001",
"companyName": "SYNT"
}
},
"collectTermsType": "STANDARD",
"fedExFreightAccountNumber": {
"value": "XXXXX9837",
"key": "ba9b4726f7fac6ca7515492d2a4e369e"
},
"declaredValueUnits": "USD",
"totalHandlingUnits": "2"
},
"shipper": {
"address": {
"residential": false,
"city": "Collierville",
"countryCode": "US",
"streetLines": [
"20 Fedex Parkway"
],
"postalCode": "380178711",
"stateOrProvinceCode": "TN"
},
"contact": {
"personName": "Abhay_shipper",
"phoneNumber": "9822280721",
"companyName": "Syntel"
},
"accountNumber": {
"value": "XXXXX9837",
"key": "ba9b4726f7fac6ca7515492d2a4e369e"
}
},
"rateRequestType": [
"LIST"
],
"shipmentSpecialServices": {
"specialServiceTypes": []
},
"recipient": {
"address": {
"residential": false,
"city": "Memphis",
"countryCode": "US",
"postalCode": "38116",
"stateOrProvinceCode": "ON"
}
},
"shippingChargesPayment": {
"payor": {
"responsibleParty": {
"address": {
"residential": false,
"city": "Collierville",
"countryCode": "US",
"streetLines": [
"10 Fedex Parkway"
],
"postalCode": "38017",
"stateOrProvinceCode": "TN"
}
}
},
"paymentType": "SENDER"
},
"shipDateStamp": "2020-02-19",
"requestedPackageLineItems": [
{
"subPackagingType": "OTHER",
"groupPackageCount": "1",
"itemDescriptionForClearance": "",
"weight": {
"units": "LB",
"value": "1000.00"
},
"associatedFreightLineItems": [
{
"id": "books"
}
]
}
],
"pickupType": "CONTACT_FEDEX_TO_SCHEDULE",
"packagingType": "YOUR_PACKAGING"
},
"rateRequestControlParameters": {
"returnTransitTimes": true,
"servicesNeededOnRateFailure": false,
"rateSortOrder": "SERVICENAMETRADITIONAL",
"returnLocalizedDateTime": true
},
"carrierCodes": [
"FXFR"
],
"customerTransactionId": "User defined Transaction Id"
}
},
"RateRequestControlParameters": {
"type": "object",
"properties": {
"returnTransitTimes": {
"type": "boolean",
"description": "Indicate if the transit time and commit data are to be returned in the reply. Default value is false.
Valid values are TRUE and FALSE.",
"example": false
},
"servicesNeededOnRateFailure": {
"type": "boolean",
"description": "Specify the services to be requested if the rate data is not available.
Valid values are TRUE and FALSE.",
"example": true
},
"variableOptions": {
"type": "string",
"description": "Specify service options whose combinations are to be considered when replying with available services.
Example: FREIGHT_GUARANTEE",
"example": "FREIGHT_GUARANTEE",
"enum": [
"SATURDAY_DELIVERY",
"FREIGHT_GUARANTEE",
"SMART_POST_ALLOWED_INDICIA",
"SMARTPOST_HUB_ID"
]
},
"rateSortOrder": {
"type": "string",
"description": "This is a sort order you can specify to control the order of the response data.
Example: SERVICENAMETRADITIONAL
- SERVICENAMETRADITIONAL - data in order of highest to lowest service (Default)
- COMMITASCENDING - data in order of ascending delivery committment
- COMMITDESCENDING - data in order of descending delivery committment.
",
"example": "SERVICENAMETRADITIONAL",
"enum": [
"COMMITASCENDING",
"SERVICENAMETRADITIONAL",
"COMMITDESCENDING"
]
}
},
"description": "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."
},
"RequestedShipment": {
"required": [
"pickupType",
"recipient",
"requestedPackageLineItems",
"shipper"
],
"type": "object",
"properties": {
"shipper": {
"description": "The descriptive data for the physical shipper location from which the shipment originates.",
"allOf": [
{
"$ref": "#/components/schemas/RateParty"
}
]
},
"pickupDetail": {
"$ref": "#/components/schemas/PickupDetail"
},
"recipient": {
"description": "Indicate the descriptive data for the recipient location to which the shipment is to be received.",
"allOf": [
{
"$ref": "#/components/schemas/RateParty"
}
]
},
"serviceType": {
"type": "string",
"description": "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 corresponding rates will be returned.
Example: STANDARD_OVERNIGHT
Click here to see Service Types",
"example": "STANDARD_OVERNIGHT"
},
"preferredCurrency": {
"type": "string",
"description": "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 to pull Preferred rates.
Example: USD
Click here to see Currency Codes",
"example": "USD"
},
"rateRequestType": {
"type": "array",
"description": "Indicate the type of rates to be returned.
Following are values:- LIST - Returns FedEx published list rates in addition to account-specific rates (if applicable).
- PREFERRED - Returns rates in the preferred currency specified in the element preferredCurrency.
- ACCOUNT - Returns account specific rates (Default).
- INCENTIVE - This is one-time discount for incentivising the customer. For more information, contact your FedEx representative.
Examples: [\"LIST\",\"PREFERRED\"]",
"example": [
"ACCOUNT",
"LIST"
],
"items": {
"type": "string",
"description": "Specifies the items.",
"enum": [
"LIST",
"INCENTIVE",
"ACCOUNT",
"PREFERRED"
]
}
},
"shipDateStamp": {
"type": "string",
"description": " 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 time of the shipment based on the shipper's time zone.
Required Format is YYYY-MM-DD
Example: 2019-09-05",
"example": "2019-09-05"
},
"pickupType": {
"type": "string",
"description": "Indicate the pickup type method by which the shipment to be tendered to FedEx.
Click here for more information on Pickup Types.",
"example": "DROPOFF_AT_FEDEX_LOCATION",
"enum": [
"CONTACT_FEDEX_TO_SCHEDULE",
"DROPOFF_AT_FEDEX_LOCATION",
"USE_SCHEDULED_PICKUP"
]
},
"requestedPackageLineItems": {
"type": "array",
"description": "These are one or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics of all packages in the shipment.- At least one instance containing the weight for at least one package is required for EXPRESS and GROUND shipments.
- Not used for FREIGHT.
- Single piece requests will have one RequestedPackageLineItem.
- Multiple piece requests will have multiple RequestedPackageLineItems.
- Maximum occurrences is 99.
",
"items": {
"$ref": "#/components/schemas/RequestedPackageLineItem"
}
},
"documentShipment": {
"type": "boolean",
"description": "Indicate whether or not its a document Shipment.",
"example": false
},
"variableHandlingChargeDetail": {
"description": "contains the detail used to calculate a variable handling charge, a potentially non-fixed handling surcharge. Based on if there is a percent value, or a fixed amount, the charge can either be fixed or percents based.",
"allOf": [
{
"$ref": "#/components/schemas/VariableHandlingChargeDetail"
}
]
},
"packagingType": {
"type": "string",
"description": "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 specified on the request. For International Express the packaging may be bumped and not mapped.
Click here to see Package Types",
"example": "YOUR_PACKAGING"
},
"totalPackageCount": {
"type": "integer",
"description": "Indicate the total number of packages in the shipment.
The Maximum number of packages in a rate request is 100.",
"format": "int32",
"example": 3
},
"totalWeight": {
"type": "number",
"description": "Specify the total weight of the shipment.
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 decimal position.",
"format": "double",
"example": 87.5
},
"shipmentSpecialServices": {
"$ref": "#/components/schemas/RequestedShipmentSpecialServicesRequested"
},
"customsClearanceDetail": {
"$ref": "#/components/schemas/RequestedShipmentCustomsClearanceDetail"
},
"smartPostInfoDetail": {
"$ref": "#/components/schemas/RequestedShipmentSmartPostInfoDetail"
}
},
"description": "This is shipment data for which a rate quote (or rate-shipping comparison) is requested."
},
"RateParty": {
"required": [
"address"
],
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/RateAddress"
}
},
"description": "Specify the shipper address details."
},
"RateAddress": {
"description": "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 city-state-ZIP combination within the US). Country code is required. Postal code is required for postal aware countries.",
"allOf": [
{
"$ref": "#/components/schemas/Address_2"
},
{
"required": [
"countryCode",
"postalCode"
],
"properties": {
"countryCode": {
"type": "string",
"example": "US"
},
"postalCode": {
"type": "string",
"example": "65247"
}
}
}
]
},
"Address_2": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "This is a placeholder for City Name.
Example: Beverly Hills",
"example": "Beverly Hills"
},
"stateOrProvinceCode": {
"type": "string",
"description": "This is a placeholder for State or Province code. State code is required for US, CA, PR and not required for other countries. Conditional. Max length is 2 .
Example: CA
Click here to see State Or Province Code",
"example": "TN"
},
"postalCode": {
"type": "string",
"description": "Indicate the Postal code. This is optional for non postal-aware countries. Maximum length is 10.
Example: 65247
Click here to see Postal aware countries",
"example": "65247"
},
"countryCode": {
"type": "string",
"description": "This is the two-letter country code. Maximum length is 2.
Example: US
Click here to see Country Codes",
"example": "US"
},
"residential": {
"type": "boolean",
"description": "Indicate whether this address is residential (as opposed to commercial).",
"example": false
}
},
"description": "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 (such as a city-state-ZIP combination within the U.S.).",
"example": {
"streetLines": [
"1550 Union Blvd",
"Suite 302"
],
"city": "Beverly Hills",
"stateOrProvinceCode": "TN",
"postalCode": "38127",
"countryCode": "US",
"residential": false
}
},
"EmailNotificationRecipient": {
"required": [
"emailAddress"
],
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"description": "Identifies the email address associated with this contact."
},
"notificationEventType": {
"type": "array",
"description": "Specifies notification event type.",
"items": {
"type": "string",
"enum": [
"ON_DELIVERY",
"ON_EXCEPTION",
"ON_SHIPMENT",
"ON_TENDER",
"ON_ESTIMATED_DELIVERY",
"ON_PICKUP",
"ON_LABEL",
"ON_BILL_OF_LADING"
]
}
},
"smsDetail": {
"$ref": "#/components/schemas/SmsDetail"
},
"notificationFormatType": {
"type": "string",
"description": "Specifies Notification Format Type.",
"enum": [
"HTML",
"TEXT"
]
},
"emailNotificationRecipientType": {
"type": "string",
"description": "Required Email Notification Recipient Type.",
"enum": [
"BROKER",
"OTHER",
"RECIPIENT",
"SHIPPER",
"THIRD_PARTY",
"OTHER1",
"OTHER2"
]
},
"notificationType": {
"type": "string",
"description": "Specifies the type of the notification received.",
"enum": [
"EMAIL",
"SMS_TEXT_MESSAGE"
]
},
"locale": {
"type": "string",
"description": "Specify the locale details.
Example: 'en_US'
Click here to see the list of available locales
Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response."
}
},
"description": "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 required."
},
"SmsDetail": {
"description": "Specifies the SMS notification details.
Conditionally required for SMS notifications.",
"allOf": [
{
"required": [
"phoneNumber",
"phoneNumberCountryCode"
],
"properties": {
"phoneNumber": {
"type": "string"
},
"phoneNumberCountryCode": {
"type": "string"
}
}
}
]
},
"RequestedPackageLineItem": {
"required": [
"weight"
],
"type": "object",
"properties": {
"subPackagingType": {
"type": "string",
"description": "This is a physical packaging type used for the package.
Click here to see sub-packaging types
For more information on physical packaging or packaging regulatory requirements, visit fedex.com or contact your FedEx representative.",
"example": "BAG"
},
"groupPackageCount": {
"type": "integer",
"description": "Indicate the grouped package count. These are number of identical package(s) each with one or more commodities.
Example: 2",
"format": "int32",
"example": 1
},
"declaredValue": {
"description": "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 provide information, or misdelivery of information relating to the Shipment.",
"allOf": [
{
"$ref": "#/components/schemas/Money"
}
]
},
"weight": {
"description": "Indicate the total weight of the requested package line items.",
"allOf": [
{
"$ref": "#/components/schemas/Weight_2"
}
]
},
"dimensions": {
"$ref": "#/components/schemas/RequestePackageLineItemDimensions"
},
"variableHandlingChargeDetail": {
"$ref": "#/components/schemas/VariableHandlingChargeDetail"
},
"packageSpecialServices": {
"description": "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.",
"allOf": [
{
"$ref": "#/components/schemas/PackageSpecialServicesRequested"
}
]
}
}
},
"Money": {
"allOf": [
{
"$ref": "#/components/schemas/Money_1"
},
{
"properties": {
"amount": {
"type": "number",
"description": "Indicates the declared amount value for the shipment.",
"example": 100
},
"currency": {
"type": "string",
"description": "Indicates the currency associated with the amount.",
"example": "USD"
}
},
"example": {
"amount": "100",
"currency": "USD"
}
}
]
},
"Money_1": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Indicates the amount. Example: 12.45",
"format": "double",
"example": 12.45
},
"currency": {
"type": "string",
"description": "Indicate the three-character ISO currency code.
Example: USD
Click here to see Currency Codes",
"example": "USD"
}
},
"description": "Indicate the amount details. This is optional, but if indicated, amount and currency must be provided."
},
"Weight_2": {
"allOf": [
{
"$ref": "#/components/schemas/Weight_1_2"
},
{
"required": [
"units",
"value"
],
"properties": {
"units": {
"type": "string",
"example": "LB"
},
"value": {
"type": "number",
"example": 22
}
}
}
]
},
"Weight_1_2": {
"type": "object",
"properties": {
"units": {
"type": "string",
"description": "Specifies the package weight unit. For Dry Ice the unit of measure is KG.",
"example": "LB",
"enum": [
"KG",
"LB"
]
},
"value": {
"type": "number",
"description": "Specifies the package weight.
Example: 68.25",
"format": "double",
"example": 10
}
},
"description": "These are the weight details.",
"example": {
"units": "LB",
"value": 10
}
},
"StandaloneBatteryDetails": {
"type": "object",
"properties": {
"batteryMaterialType": {
"type": "string",
"description": "Describes the material composition of the battery or cell.",
"example": "LITHIUM_METAL",
"enum": [
"LITHIUM_METAL",
"LITHIUM_ION"
]
}
}
},
"RequestePackageLineItemDimensions": {
"description": "Specify the dimensions of this package and the unit type used for the measurements. Valid measurements are whole numbers greater than zero.",
"allOf": [
{
"$ref": "#/components/schemas/Dimensions"
}
]
},
"Dimensions": {
"description": "Indicate the dimensions of the package.
Following conditions will apply: - Dimensions are optional but when added, then all three dimensions must be indicated.
- Dimensions are required with YOUR_PACKAGING package type.
Note: The Maximum/minimum dimension values varies based on the services and the packaging types. Refer FedEx Service Guide for service details related to DIM Weighting for FedEx Express and oversize conditions for FedEx Express and FedEx Ground.",
"allOf": [
{
"$ref": "#/components/schemas/Dimensions_1"
},
{
"required": [
"height",
"length",
"units",
"width"
],
"properties": {
"length": {
"type": "integer",
"description": "Indicate the length of the package. No implied decimal places. Maximum value: 999
Example: 20",
"format": "int32"
},
"width": {
"type": "integer",
"description": "Indicate the width of the package. No implied decimal places. Maximum value: 999
Example: 10",
"format": "int32"
},
"height": {
"type": "integer",
"description": "Indicate the height of the package. No implied decimal places. Maximum value: 999
Example: 10",
"format": "int32"
},
"units": {
"type": "string",
"description": "Indicate the unit of measure for the provided dimensions.
Valid Values are:- IN - Inches
- CM - Centimeters
"
}
},
"example": {
"length": 10,
"width": 8,
"height": 2,
"units": "IN"
}
}
]
},
"Dimensions_1": {
"type": "object",
"properties": {
"length": {
"type": "integer",
"description": "Indicate the length of the package. No implied decimal places. Maximum value: 999
Example: 20",
"format": "int32",
"example": 100
},
"width": {
"type": "integer",
"description": "Indicate the width of the package. No implied decimal places. Maximum value: 999
Example: 10",
"format": "int32",
"example": 50
},
"height": {
"type": "integer",
"description": "Indicate the height of the package. No implied decimal places. Maximum value: 999
Example: 10",
"format": "int32",
"example": 30
},
"units": {
"type": "string",
"description": "Indicate the unit of measure for the provided dimensions.
Valid Values are:- IN - Inches
- CM - Centimeters
",
"example": "CM",
"enum": [
"CM",
"IN"
]
}
},
"description": "Indicate the dimensions of the package.
Following conditions will apply: - Dimensions are optional but when added, then all three dimensions must be indicated.
- Dimensions are required with YOUR_PACKAGING package type.
Note: The Maximum/minimum dimension values varies based on the services and the packaging types. Refer FedEx Service Guide for service details related to DIM Weighting for FedEx Express and oversize conditions for FedEx Express and FedEx Ground.",
"example": {
"length": 100,
"width": 50,
"height": 30,
"units": "CM"
}
},
"VariableHandlingChargeDetail": {
"required": [
"rateElementBasis"
],
"type": "object",
"properties": {
"rateType": {
"type": "string",
"description": "The rate type indicates what type of rate request is being returned; account, preferred, incentive, etc.",
"enum": [
"ACCOUNT",
"ACTUAL",
"CURRENT",
"CUSTOM",
"LIST",
"INCENTIVE",
"PREFERRED",
"PREFERRED_INCENTIVE",
"PREFERRED_CURRENCY"
]
},
"percentValue": {
"type": "number",
"description": "Indicate the variable handling percentage. Actual percentage (10 means 10%, which is a mutiplier of 0.1).",
"format": "double"
},
"rateLevelType": {
"type": "string",
"description": "indicates whether or not the rating is being done at the package level, or if the packages are bundled together. At the package level, charges are applied based on the details of each individual package. If they are bundled, one package is chosen as the parent and charges are applied based on that one package.",
"enum": [
"BUNDLED_RATE",
"INDIVIDUAL_PACKAGE_RATE"
]
},
"fixedValue": {
"description": "Indicate the Fixed value.
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 the decimal and 2 characters following the decimal.
Example - 5.00.",
"allOf": [
{
"$ref": "#/components/schemas/Money"
}
]
},
"rateElementBasis": {
"type": "string",
"description": "Indicate the rate charge on which, the variable handling amount is calculated.",
"enum": [
"NET_CHARGE",
"NET_FREIGHT",
"BASE_CHARGE",
"NET_CHARGE_EXCLUDING_TAXES"
]
}
},
"description": "Indicate the details on how to calculate variable handling charges at the package level. If indicated, element rateLevelType is required."
},
"PackageSpecialServicesRequested": {
"type": "object",
"properties": {
"specialServiceTypes": {
"type": "array",
"description": "Indicate the special services requested.
Click here to see Package level Special Service Types",
"example": [
"DANGEROUS_GOODS"
],
"items": {
"type": "string",
"description": "Specifies the items."
}
},
"signatureOptionType": {
"type": "string",
"description": "Type of a Signature Option.",
"example": [
"NO_SIGNATURE_REQUIRED"
],
"enum": [
"SERVICE_DEFAULT",
"NO_SIGNATURE_REQUIRED",
"INDIRECT",
"DIRECT",
"ADULT"
]
},
"alcoholDetail": {
"$ref": "#/components/schemas/AlcoholDetail"
},
"dangerousGoodsDetail": {
"$ref": "#/components/schemas/DangerousGoodsDetail"
},
"packageCODDetail": {
"$ref": "#/components/schemas/PackageSpecialServicesRequestedPackageCODDetail"
},
"pieceCountVerificationBoxCount": {
"type": "integer",
"description": "Provide the pieceCount or VerificationBoxCount for batteries or cells that are contained within this specific package.",
"format": "int32"
},
"batteryDetails": {
"type": "array",
"description": "Specify the details about the batteries or cells that are contained within this specific package.",
"items": {
"$ref": "#/components/schemas/BatteryClassificationDetail"
}
},
"dryIceWeight": {
"$ref": "#/components/schemas/Weight_1_2"
},
"standaloneBatteryDetails": {
"type": "array",
"description": "Provides details about the batteries or cells that are contained within this specific package.",
"items": {
"$ref": "#/components/schemas/StandaloneBatteryDetails"
}
}
},
"description": "These special services are available at the package level for some or all service types. Needs Indicated, if rate data is being requested for the special services. "
},
"AlcoholDetail": {
"required": [
"alcoholRecipientType"
],
"type": "object",
"properties": {
"alcoholRecipientType": {
"type": "string",
"description": "Specify the recipient type for the alcohol shipment.",
"enum": [
"LICENSEE",
"CONSUMER"
]
},
"shipperAgreementType": {
"type": "string",
"description": "Specify the shipper entity type.
Example: Fulfillment house, Retailer or a Winery.",
"example": "Retailer"
}
},
"description": "Indicate the alcohol shipment details. This object is mandatory if alcohol special service is selected."
},
"DangerousGoodsDetail": {
"type": "object",
"properties": {
"accessibility": {
"type": "string",
"description": "Indicate the Dangerous Goods Accessibility Type.
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 strictly controlled.",
"enum": [
"ACCESSIBLE",
"INACCESSIBLE"
]
},
"options": {
"type": "array",
"description": "Specify the special handling requested for the package.
Example: BATTERY",
"example": [
"BATTERY"
],
"items": {
"type": "string",
"enum": [
"HAZARDOUS_MATERIALS",
"BATTERY",
"ORM_D",
"REPORTABLE_QUANTITIES",
"SMALL_QUANTITY_EXCEPTION",
"LIMITED_QUANTITIES_COMMODITIES"
]
}
},
"containers": {
"type": "array",
"description": "Indicate one or more containers used to pack dangerous goods commodities.",
"items": {
"$ref": "#/components/schemas/DangerousGoodsContainer"
}
},
"regulation": {
"type": "string",
"description": "The hazardous package shipment regulation type.",
"example": "ADR",
"enum": [
"ADR",
"DOT",
"IATA",
"ORMD"
]
}
},
"description": "Use this object to specify Dangerous Goods shipment Detail."
},
"DangerousGoodsContainer": {
"type": "object",
"properties": {
"offeror": {
"type": "string",
"description": "Specify the shipper name(offeror) or contact number. Required on all shipping papers.",
"example": "Offeror Name"
},
"hazardousCommodities": {
"type": "array",
"description": "Specify the kinds and quantities of all hazardous commodities in the current container.",
"items": {
"$ref": "#/components/schemas/HazardousCommodityContent"
}
},
"numberOfContainers": {
"type": "integer",
"description": "Indicate the number of containers.",
"format": "int32",
"example": 10
},
"containerType": {
"type": "string",
"description": "Indicate the type of container.",
"example": "Copper Box"
},
"emergencyContactNumber": {
"$ref": "#/components/schemas/PhoneNumber"
},
"packaging": {
"$ref": "#/components/schemas/HazardousCommodityPackagingDetail"
},
"packingType": {
"type": "string",
"description": "Indicate the packing type used.",
"enum": [
"ALL_PACKED_IN_ONE"
]
},
"radioactiveContainerClass": {
"type": "string",
"description": "Indicate the packaging type of the container used to package the radioactive materials.",
"enum": [
"EXCEPTED_PACKAGE",
"INDUSTRIAL_IP1",
"INDUSTRIAL_IP2",
"INDUSTRIAL_IP3",
"TYPE_A",
"TYPE_B_M",
"TYPE_B_U",
"TYPE_C"
]
}
},
"description": "Dangerous Goods Container"
},
"HazardousCommodityContent": {
"type": "object",
"properties": {
"quantity": {
"$ref": "#/components/schemas/HazardousCommodityQuantityDetail"
},
"innerReceptacles": {
"type": "array",
"description": "Specifies the inner receptacles within the container.",
"items": {
"$ref": "#/components/schemas/HazardousCommodityInnerReceptacleDetail"
}
},
"options": {
"$ref": "#/components/schemas/HazardousCommodityOptionDetail"
},
"description": {
"$ref": "#/components/schemas/HazardousCommodityDescription"
}
},
"description": "Documents the kind and quantity of an individual hazardous commodity in a package."
},
"HazardousCommodityQuantityDetail": {
"type": "object",
"properties": {
"quantityType": {
"type": "string",
"description": "Specifies type of a quantity unit.",
"enum": [
"GROSS",
"NET"
]
},
"amount": {
"type": "number",
"description": "Specifies amount details.",
"format": "double"
},
"units": {
"type": "string",
"description": "Specify unit details.",
"example": "LB"
}
},
"description": "Specifies Hazardous Commodity Quantity Detail."
},
"HazardousCommodityInnerReceptacleDetail": {
"type": "object",
"properties": {
"quantity": {
"$ref": "#/components/schemas/HazardousCommodityQuantityDetail"
}
},
"description": "This describes information about the inner receptacles for the hazardous commodity in a particular dangerous goods container."
},
"HazardousCommodityOptionDetail": {
"type": "object",
"properties": {
"labelTextOption": {
"type": "string",
"description": "Specifies how the customer wishes the label text to be handled for this commodity in this package.",
"example": "Override",
"enum": [
"APPEND",
"OVERRIDE",
"STANDARD"
]
},
"customerSuppliedLabelText": {
"type": "string",
"description": "Text used in labeling the commodity under control of the labelTextOption field.",
"example": "LabelText"
}
},
"description": "Customer-provided specifications for handling individual commodities."
},
"HazardousCommodityDescription": {
"type": "object",
"properties": {
"sequenceNumber": {
"type": "integer",
"description": "In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.",
"format": "int32"
},
"processingOptions": {
"type": "array",
"description": "Indicates any special processing options to be applied to the description of the dangerous goods commodity.",
"items": {
"type": "string",
"enum": [
"INCLUDE_SPECIAL_PROVISIONS"
]
}
},
"subsidiaryClasses": {
"type": "array",
"description": "Specifies the hazardous material subsidiary classes.",
"example": "subsidiaryClass",
"items": {
"type": "string"
}
},
"labelText": {
"type": "string",
"description": "Specifies the DOT diamond hazard label type. This element can also include limited quantity or exemption number.",
"example": "labelText"
},
"technicalName": {
"type": "string",
"description": "Specify the technical name for the hazardous commodity.",
"example": "technicalName"
},
"packingDetails": {
"$ref": "#/components/schemas/HazardousCommodityPackingDetail"
},
"authorization": {
"type": "string",
"description": "Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.",
"example": "Authorization Information"
},
"reportableQuantity": {
"type": "boolean",
"description": "The element specifies the reportable quantity of the hazardous material.",
"example": false
},
"percentage": {
"type": "number",
"description": "Indicates the percentage.",
"format": "double",
"example": 10
},
"id": {
"type": "string",
"description": "Specifies the ID of label text.",
"example": "ID"
},
"packingGroup": {
"type": "string",
"description": "Identifies IATA packing group for a hazardous commodity.",
"enum": [
"DEFAULT",
"I",
"II",
"III"
]
},
"properShippingName": {
"type": "string",
"description": "The proper shipping name as defined by the regulation.
The name can also include qualifying words.",
"example": "ShippingName"
},
"hazardClass": {
"type": "string",
"description": "Specify hazard class for commodity.",
"example": "hazardClass"
}
},
"description": "Identifies and describes an individual hazardous commodity."
},
"HazardousCommodityPackingDetail": {
"type": "object",
"properties": {
"packingInstructions": {
"type": "string",
"description": "Indicates the coded specification for how commodity is to be packed.",
"example": "instruction"
},
"cargoAircraftOnly": {
"type": "boolean",
"description": "Indicates the shipment is packaged/documented for movement ONLY on cargo aircraft.",
"example": false
}
},
"description": "Specifies documentation and limits for validation of an individual packing group/category."
},
"PhoneNumber": {
"required": [
"areaCode",
"countryCode"
],
"type": "object",
"properties": {
"areaCode": {
"type": "string",
"description": "Indicates the area code.",
"example": "202"
},
"extension": {
"type": "string",
"description": "Indicates the Extension.",
"example": "3245"
},
"countryCode": {
"type": "string",
"description": "The two-letter code used to identify a country.
Example: US",
"example": "US"
},
"personalIdentificationNumber": {
"type": "string",
"description": "Indicates the Personal Identification Number.",
"example": "9545678"
},
"localNumber": {
"type": "string",
"description": "Telephone number to use for contact in the event of an emergency.",
"example": "23456"
}
},
"description": "Indicates the telephone number to use for contact in the event of an emergency."
},
"HazardousCommodityPackagingDetail": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Indicate the number and type of packaging units for dangerous goods.",
"format": "int32",
"example": 20
},
"units": {
"type": "string",
"description": "Specify the unit of the package.",
"example": "Liter"
}
},
"description": "Identifies number and type of packaging units for hazardous commodities."
},
"PackageSpecialServicesRequestedPackageCODDetail": {
"$ref": "#/components/schemas/PackageCODDetail"
},
"PackageCODDetail": {
"type": "object",
"properties": {
"codCollectionAmount": {
"$ref": "#/components/schemas/Money_1"
},
"codCollectionType": {
"type": "string",
"description": "Indicate the type of funds FedEx should collect upon shipment delivery.
Conditionally required for Ground COD rates",
"enum": [
"ANY",
"CASH",
"COMPANY_CHECK",
"GUARANTEED_FUNDS",
"PERSONAL_CHECK"
]
}
},
"description": "Indicates package COD Detail. COD main information is set in shipment level."
},
"BatteryClassificationDetail": {
"type": "object",
"properties": {
"material": {
"type": "string",
"description": "Describes the material composition of the battery or cell. Example: LITHIUM_METAL",
"enum": [
"LITHIUM_METAL",
"LITHIUM_ION"
]
},
"regulatorySubType": {
"type": "string",
"description": "Specify the regulation specific classification for the battery or cell.",
"enum": [
"IATA_SECTION_II"
]
},
"packing": {
"type": "string",
"description": "Indicate the packing arrangement of the battery or cell with respect to other items within the same package. Example: CONTAINED_IN_EQUIPMENT",
"enum": [
"CONTAINED_IN_EQUIPMENT",
"PACKED_WITH_EQUIPMENT"
]
}
},
"description": "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 dangerous goods documentation and procedures are not required."
},
"Party_2": {
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/Address_2"
},
"contact": {
"$ref": "#/components/schemas/Contact_2"
},
"accountNumber": {
"$ref": "#/components/schemas/AccountNumber"
}
},
"description": "Indicate the party to a transaction including the physical address, contact information and account number information.",
"example": {
"accountNumber": {
"value": 123456789
}
}
},
"Contact_2": {
"type": "object",
"properties": {
"personName": {
"type": "string",
"description": "Specify contact name.
Note: Recommended Length is 70. There's no specific validation for the length.
Example: John Taylor",
"example": "John Taylor"
},
"emailAddress": {
"type": "string",
"description": "Specify contact email address. Maximum length is 80.
Example: sample@company.com",
"example": "sample@company.com"
},
"phoneNumber": {
"type": "string",
"description": "Specify contact phone number. Maximum length is 15.
Example: 1234567890",
"example": "1234567890"
},
"phoneExtension": {
"type": "string",
"description": "Specify contact phone extension. Maximum length is 6.
Example: 1234",
"example": "1234"
},
"faxNumber": {
"type": "string",
"description": "Specify contact fax number. Maximum length is 15.
Example: 1234567890",
"example": "1234567890"
},
"companyName": {
"type": "string",
"description": "Specify contact company name. Maximum length is 35.",
"example": "Fedex"
}
},
"description": "Indicate the contact details.",
"example": {
"personName": "John Taylor",
"emailAddress": "sample@company.com",
"phoneNumber": "1234567890",
"phoneExtension": "1234",
"faxNumber": "1234567890",
"companyName": "Fedex"
}
},
"RequestedShipmentSpecialServicesRequested": {
"description": "Specify the special services requested at the shipment level.
This has to be specified if rate data needed for the special services. ",
"allOf": [
{
"$ref": "#/components/schemas/ShipmentSpecialServicesRequested"
}
]
},
"ShipmentSpecialServicesRequested": {
"type": "object",
"properties": {
"returnShipmentDetail": {
"$ref": "#/components/schemas/ShipmentSpecialServicesRequested_returnShipmentDetail"
},
"deliveryOnInvoiceAcceptanceDetail": {
"$ref": "#/components/schemas/DeliveryOnInvoiceAcceptanceDetail"
},
"internationalTrafficInArmsRegulationsDetail": {
"$ref": "#/components/schemas/InternationalTrafficInArmsRegulationsDetail"
},
"holdAtLocationDetail": {
"$ref": "#/components/schemas/HoldAtLocationDetail"
},
"shipmentCODDetail": {
"$ref": "#/components/schemas/ShipmentSpecialServicesRequestedShipmentCODDetail"
},
"shipmentDryIceDetail": {
"$ref": "#/components/schemas/ShipmentDryIceDetail"
},
"internationalControlledExportDetail": {
"$ref": "#/components/schemas/InternationalControlledExportDetail"
},
"homeDeliveryPremiumDetail": {
"$ref": "#/components/schemas/HomeDeliveryPremiumDetail"
},
"specialServiceTypes": {
"type": "array",
"description": "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.
Example: BROKER_SELECT_OPTION
Click here to see Shipment level Special Service Types",
"example": [
"BROKER_SELECT_OPTION"
],
"items": {
"type": "string"
}
}
},
"description": "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.
Example: [BROKER_SELECT_OPTION]
Click here to see Shipment level Special Service Types"
},
"DeliveryOnInvoiceAcceptanceDetail": {
"type": "object",
"properties": {
"recipient": {
"$ref": "#/components/schemas/DeliveryOnInvoiceAcceptanceDetailRecipient"
}
},
"description": "Indicate the Delivery On Invoice Acceptance detail. Recipient is required for Delivery On Invoice Special service."
},
"DeliveryOnInvoiceAcceptanceDetailRecipient": {
"allOf": [
{
"$ref": "#/components/schemas/Party_2"
},
{
"required": [
"address",
"contact"
],
"properties": {
"address": {
"$ref": "#/components/schemas/DeliveryOnInvoiceAcceptanceDetailRecipient_address"
},
"contact": {
"$ref": "#/components/schemas/DeliveryOnInvoiceAcceptanceDetailRecipient_contact"
}
}
}
]
},
"InternationalTrafficInArmsRegulationsDetail": {
"type": "object",
"properties": {
"licenseOrExemptionNumber": {
"type": "string",
"description": "The export or license number for the ITAR shipment.
Example: 9871234",
"example": "432345"
}
},
"description": "These are International Traffic In Arms Regulations shipment service Details."
},
"PendingShipmentProcessingOptionsRequested": {
"type": "object",
"properties": {
"options": {
"type": "array",
"description": "These are Pending Shipment processing options.
Example: [\"ALLOW_MODIFICATIONS\"]",
"items": {
"type": "string",
"enum": [
"ALLOW_MODIFICATIONS"
]
}
}
},
"description": "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 editable shipment data."
},
"RecommendedDocumentSpecification": {
"type": "object",
"properties": {
"types": {
"type": "array",
"description": "This is a document type.",
"items": {
"type": "string",
"enum": [
"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"
]
}
}
},
"description": "These are recommended document specification which are recommended to be included with the shipment."
},
"EmailLabelDetail": {
"type": "object",
"properties": {
"recipients": {
"type": "array",
"description": "Describes specific information about the list of email label shipment reipients.",
"items": {
"$ref": "#/components/schemas/EmailRecipient"
}
},
"message": {
"type": "string",
"description": "customer specified message to be included in the email to the end-user."
}
},
"description": "Describes specific information about the email label shipment.- Message: Content of the email message
- Recipients: EMailRecipient
- emailAddress - email address of the recipient
- role - role type of the recipient
- optionsRequested
- localization
"
},
"EmailRecipient": {
"required": [
"emailAddress"
],
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"description": "This is the placeholder for Email address of the end-user to be notified of the return label. Maximum length is 200 characters."
},
"optionsRequested": {
"$ref": "#/components/schemas/EmailOptionsRequested"
},
"role": {
"type": "string",
"description": "Specifies the role of the recipient to the pending shipment.",
"enum": [
"SHIPMENT_COMPLETOR",
"SHIPMENT_INITIATOR"
]
},
"locale": {
"$ref": "#/components/schemas/Locale"
}
},
"description": "Use this object to specify the recipient email information."
},
"EmailOptionsRequested": {
"type": "object",
"properties": {
"options": {
"type": "array",
"description": "Specifies the options.",
"items": {
"type": "string",
"enum": [
"PRODUCE_PAPERLESS_SHIPPING_FORMAT",
"SUPPRESS_ADDITIONAL_LANGUAGES",
"SUPPRESS_ACCESS_EMAILS"
]
}
}
},
"description": "Indicates how the email notifications for the pending shipment need to be processed."
},
"Locale": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "This is country code.
Example: US
Click here to see Country Codes"
},
"language": {
"type": "string",
"description": "This is language code.
Example: en
Click here to see Locale"
}
},
"description": "These are Locale details.
Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response."
},
"UploadDocumentReferenceDetail": {
"type": "object",
"properties": {
"documentType": {
"type": "string",
"description": "These are the type of document specified in the PendingShipment request.",
"enum": [
"CERTIFICATE_OF_ORIGIN",
"COMMERCIAL_INVOICE",
"ETD_LABEL",
"NAFTA_CERTIFICATE_OF_ORIGIN",
"NET_RATE_SHEET",
"OTHER",
"PRO_FORMA_INVOICE"
]
},
"customerReference": {
"title": "@Ignore4TPP",
"type": "string",
"description": "Customer Reference"
},
"description": {
"type": "string",
"description": "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.",
"example": "ShippingDocumentSpecification"
},
"documentId": {
"type": "string",
"description": "Specify the document ID for the uploaded document.",
"example": "98123"
}
},
"description": "Upload document details provided by the initator of the shipment."
},
"ShipmentDryIceDetail": {
"type": "object",
"properties": {
"totalWeight": {
"$ref": "#/components/schemas/Weight_1_2"
},
"packageCount": {
"type": "integer",
"description": "This is package count.
Example: 12",
"format": "int32",
"example": 12
}
},
"description": "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."
},
"HoldAtLocationDetail": {
"required": [
"locationId"
],
"type": "object",
"properties": {
"locationId": {
"type": "string",
"description": "This is an alphanumeric identifier used for Location/Facility Identification.
Example: YBZA
Note: - For HAL Shipment, Location ID is REQUIRED to ensure packages are delivered to the right location.
- Use endpoint [Find Location] in [Location Search API], to find the correct location ID for your shipment.
",
"example": "YBZA"
},
"locationContactAndAddress": {
"$ref": "#/components/schemas/ContactAndAddress"
},
"locationType": {
"type": "string",
"description": "Specify the Location Type.
Example: FEDEX_ONSITE",
"example": "FEDEX_ONSITE",
"enum": [
"FEDEX_AUTHORIZED_SHIP_CENTER",
"FEDEX_OFFICE",
"FEDEX_SELF_SERVICE_LOCATION",
"FEDEX_STAFFED",
"RETAIL_ALLICANCE_LOCATION",
"FEDEX_GROUND_TERMINAL",
"FEDEX_ONSITE"
]
}
},
"description": "Use this object to specify required information for a shipment to be held at destination FedEx location.
Note: This object HoldAtLocationDetail is REQUIRED, when HOLD_AT_LOCATION is chosen in the specialServiceTypes."
},
"ContactAndAddress": {
"type": "object",
"properties": {
"contact": {
"$ref": "#/components/schemas/Contact_2"
},
"address": {
"$ref": "#/components/schemas/Address_1"
}
},
"description": "Specify the contact and address details of a location.",
"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"
}
}
},
"Address_1": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "Specify name of city, town, etc.
Example: Beverly Hills",
"example": "Beverly Hills"
},
"stateOrProvinceCode": {
"type": "string",
"description": "Specify State or province code. Maximum length is 2.State code is required for US, CA, PR and not required for other countries. Conditional. Max length is 2.
Example: CA
Click here to see State Or Province Codes",
"example": "CA"
},
"postalCode": {
"type": "string",
"description": "Specify the postal code. This is optional for non postal- aware countries. Maximum length is 10.
Example: 65247
Click here to see Postal aware countries",
"example": "65247"
},
"countryCode": {
"type": "string",
"description": "The two-letter country code. Maximum length is 2.
Example: US
Click here to see Country Codes",
"example": "US"
},
"residential": {
"type": "boolean",
"description": "Indicate whether this address is residential (as opposed to commercial).",
"example": false
}
},
"description": "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 (such as a city-state-ZIP combination within the US). Country code is required. Postal code is required for postal aware countries. State or province code is mandatory for Puerto Rico."
},
"ShipmentSpecialServicesRequestedShipmentCODDetail": {
"description": "Use this object to specify Collect On Delivery (COD) shipment details.",
"allOf": [
{
"$ref": "#/components/schemas/ShipmentCODDetail"
}
]
},
"ShipmentCODDetail": {
"type": "object",
"properties": {
"addTransportationChargesDetail": {
"$ref": "#/components/schemas/CODTransportationChargesDetail"
},
"codRecipient": {
"$ref": "#/components/schemas/Party_2"
},
"remitToName": {
"type": "string",
"description": "Specifies the name of person or company receiving the secured or unsecured payment.
Example: FedEx",
"example": "FedEx"
},
"codCollectionType": {
"type": "string",
"description": "Indicate the type of funds FedEx should collect upon shipment delivery.",
"enum": [
"ANY",
"CASH",
"COMPANY_CHECK",
"GUARANTEED_FUNDS",
"PERSONAL_CHECK"
]
},
"financialInstitutionContactAndAddress": {
"$ref": "#/components/schemas/ContactAndAddress"
},
"returnReferenceIndicatorType": {
"type": "string",
"description": "Indicate the type of reference information to include on the COD return shipping label.",
"enum": [
"INVOICE",
"PO",
"REFERENCE",
"TRACKING"
]
}
},
"description": "Specifies Shipment COD Detail"
},
"CODTransportationChargesDetail": {
"type": "object",
"properties": {
"rateType": {
"type": "string",
"description": "Specify COD Rate Type.",
"enum": [
"ACCOUNT",
"ACTUAL",
"CURRENT",
"CUSTOM",
"LIST",
"INCENTIVE",
"PREFERRED",
"PREFERRED_INCENTIVE",
"PREFERRED_CURRENCY"
]
},
"rateLevelType": {
"type": "string",
"description": "Specify whether the rate applied on bundle or indiividual package.",
"enum": [
"BUNDLED_RATE",
"INDIVIDUAL_PACKAGE_RATE"
]
},
"chargeLevelType": {
"type": "string",
"description": "Specify whether the charges applied on current or all packages.",
"enum": [
"CURRENT_PACKAGE",
"SUM_OF_PACKAGES"
]
},
"chargeType": {
"type": "string",
"description": "Specify the Charges Type.",
"enum": [
"COD_SURCHARGE",
"NET_CHARGE",
"NET_FREIGHT",
"TOTAL_CUSTOMER_CHARGE"
]
}
},
"description": "These are COD Transportation Charges Detail."
},
"InternationalControlledExportDetail": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Indicate International Controlled Export Type.
Example: WAREHOUSE_WITHDRAWAL",
"enum": [
"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"
]
}
},
"description": "Use this object to specify International Controlled Export shipment Details."
},
"HomeDeliveryPremiumDetail": {
"type": "object",
"properties": {
"shipTimestamp": {
"type": "string",
"description": "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 time of the shipment based on the shipper's time zone.
Formats: YYYY-MM-DD, YYYY-MM-DD HH:MM:SS
Example: 2024-06-14 19:23:51",
"example": "2020-04-24"
},
"homedeliveryPremiumType": {
"type": "string",
"description": "This is Home Delivery Premium Type. It allows to specify additional premimum service options for the home delivery shipment. Can specify Evening delivery or a Date certain, or can specify appointment for the delivery.",
"enum": [
"APPOINTMENT",
"DATE_CERTAIN",
"EVENING"
]
}
},
"description": "These are Special service elements for FedEx Ground Home Delivery shipments. If selected, element homedeliveryPremiumType is mandatory.\n\n"
},
"RequestedShipmentCustomsClearanceDetail": {
"description": "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 intra-country rating.",
"allOf": [
{
"$ref": "#/components/schemas/CustomsClearanceDetail"
}
]
},
"CustomsClearanceDetail": {
"required": [
"commodities"
],
"type": "object",
"properties": {
"brokers": {
"type": "array",
"description": "Conditional.
Required if BROKER_SELECT_OPTION is specified as a shipment special service type. A country code must be specified in addition to one of the following address items: postal code, city, or location id.",
"items": {
"$ref": "#/components/schemas/BrokerDetail"
}
},
"commercialInvoice": {
"$ref": "#/components/schemas/CommercialInvoice"
},
"freightOnValue": {
"type": "string",
"description": " Indicates Freight on value for customs.",
"example": "CARRIER_RISK",
"enum": [
"CARRIER_RISK",
"OWN_RISK"
]
},
"dutiesPayment": {
"$ref": "#/components/schemas/Payment"
},
"commodities": {
"type": "array",
"description": "Indicates the details about the dutiable packages. Maximum upto 999 commodities per shipment.",
"items": {
"$ref": "#/components/schemas/Commodity"
}
}
},
"description": "This is Customs clearance data, used for both international and intra-country shipping and rating. Customs commodity data is required for international and intra-country rating. "
},
"CommercialInvoice": {
"type": "object",
"properties": {
"shipmentPurpose": {
"type": "string",
"description": "The reason for the shipment. Note: SOLD is not a valid purpose for a Proforma Invoice.",
"example": "GIFT",
"enum": [
"GIFT",
"NOT_SOLD",
"PERSONAL_EFFECTS",
"REPAIR_AND_RETURN",
"SAMPLE",
"SOLD",
"COMMERCIAL",
"RETURN_AND_REPAIR",
"PERSONAL_USE"
]
}
},
"description": "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.
Customers are responsible for printing their own Commercial Invoice.
If you would like FedEx to generate a Commercial Invoice and transmit it to Customs for clearance purposes, you need to specify that in the 'ETDDetail/RequesteDocumentCopies' element.
Support consists of a Maximum of 99 commodity line items."
},
"Payment": {
"type": "object",
"properties": {
"payor": {
"$ref": "#/components/schemas/Payor"
},
"paymentType": {
"type": "string",
"description": "Indicate the payment Type. Applicable for Express and Ground rates.",
"enum": [
"SENDER"
]
}
},
"description": "These are details about shipment payment. Value payor is optional when paymentType provided as SENDER.",
"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",
"phoneNumber": "1234567890",
"phoneExtension": "phone extension",
"companyName": "Fedex",
"faxNumber": "fax number"
},
"accountNumber": {
"value": "123456789"
}
}
},
"paymentType": "SENDER"
}
},
"Payor": {
"type": "object",
"properties": {
"responsibleParty": {
"description": "These are payer details such as address, account and contacts.",
"allOf": [
{
"$ref": "#/components/schemas/Party_2"
},
{
"required": [
"accountNumber"
],
"properties": {
"accountNumber": {
"type": "object"
}
}
}
]
}
},
"description": "This is payer Information responsible for paying for the shipment.
Note: Optional when paymentType is SENDER.",
"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.
Example: Your account number"
}
}
}
},
"Commodity": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Indicate the description of the dutiable packages.
Maximum Length is 450.
Example: DOCUMENTS
Click here to see Vague commodity descriptions",
"example": "DOCUMENTS"
},
"weight": {
"description": "Specify the Total weight of this commodity. This element is used to estimate duties and taxes.",
"allOf": [
{
"$ref": "#/components/schemas/Weight_2"
}
]
},
"quantity": {
"type": "integer",
"description": "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.
Example: 1",
"format": "int32",
"example": 1
},
"customsValue": {
"description": "Specify the required Customs value for this commodity.",
"allOf": [
{
"$ref": "#/components/schemas/Money"
}
]
},
"unitPrice": {
"allOf": [
{
"$ref": "#/components/schemas/Money"
},
{
"description": "Specifies the unit price of the commodity. "
}
]
},
"numberOfPieces": {
"type": "integer",
"description": "Specifies the number of pieces for this commodity.
Example: 10",
"format": "int32",
"example": 1
},
"countryOfManufacture": {
"type": "string",
"description": "This is commodity country of manufacture. This is required. Maximum allowed length is 4.
Example: US
Click here to see Country Codes",
"example": "US"
},
"quantityUnits": {
"type": "string",
"description": "Indicate quantiy unit used. Used to estimate duties and taxes
Example: PCS
click here to see Commodity Unit Measures",
"example": "PCS"
},
"name": {
"type": "string",
"description": "Indicate the Commodity name
Example: DOCUMENTS",
"example": "DOCUMENTS"
},
"harmonizedCode": {
"type": "string",
"description": "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.
Example: A six digit code for Almonds fresh or dried is 080211. The HTS code for pistachios in shell is 080251. The HTS code for fish is HS203.
To research the classification for your commodity, use the FedEx Global Trade Manager online at fedex.com/gtm. You can find the commodities and its respective codes by logging into FedEx and selecting harmonized code option. You will find country-specific information to determine whether your commodity is considered to be a document or non-document for your destination.
For additional information about harmonized code, refer to harmonized code.",
"example": "080211"
},
"partNumber": {
"type": "string",
"description": "Specify the part number if any. Example: P1",
"example": "P1"
}
}
},
"ServiceTypeDetailVO": {
"type": "object",
"properties": {
"carrierCode": {
"type": "string",
"description": "Identifies which carrier is being described.",
"enum": [
"FDXE",
"FDXG",
"FXSP",
"FXFR",
"FDXC",
"FXCC"
]
},
"description": {
"type": "string",
"description": "Description"
},
"serviceName": {
"type": "string",
"description": "Service Name"
},
"serviceCategory": {
"type": "string",
"description": "Service Category"
}
},
"description": "service type information details"
},
"RequestedShipmentSmartPostInfoDetail": {
"description": "Indicate the FedEx Smartpost shipment details. Required for Smartpost shipments only.",
"allOf": [
{
"$ref": "#/components/schemas/SmartPostInfoDetail"
}
]
},
"SmartPostInfoDetail": {
"type": "object",
"properties": {
"ancillaryEndorsement": {
"type": "string",
"description": "Indicate the type of ancillary endorsement. Is required for Presorted Standard but not for returns or parcel select. Note not all are usable for all ancillary endorsements.
For more information, refer to the FedEx SmartPost®.",
"enum": [
"ADDRESS_CORRECTION",
"CARRIER_LEAVE_IF_NO_RESPONSE",
"CHANGE_SERVICE",
"FORWARDING_SERVICE",
"RETURN_SERVICE"
]
},
"hubId": {
"type": "string",
"description": "Specify the four-digit numeric Hub ID value used during rate quote for smartport shipments.
Click here to see Hub Ids",
"example": "5531"
},
"indicia": {
"type": "string",
"description": "Specify the indicia type.
Available options include:- MEDIA_MAIL
- PARCEL_SELECT (1 LB through 70 LB)
- PRESORTED_BOUND_PRINTED_MATTER
- PRESORTED_STANDARD (less than 1 LB)
- PARCEL_RETURN
",
"enum": [
"MEDIA_MAIL",
"PARCEL_RETURN",
"PARCEL_SELECT",
"PRESORTED_BOUND_PRINTED_MATTER",
"PRESORTED_STANDARD"
]
},
"specialServices": {
"type": "string",
"description": "Specify the special handling associated with Smartpost Shipment.
Click here to see Shipment Level Special Service Types",
"enum": [
"USPS_DELIVERY_CONFIRMATION"
]
}
},
"description": "Use this object to specify the smartpost shipment details.
Required for SMARTPOST service. If SmartPostInfoDetail is indicated, the elements below it are also required."
},
"US_Domestic_Rate_shop": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 65247,
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": 75063,
"countryCode": "US"
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"rateRequestType": [
"ACCOUNT",
"LIST"
],
"requestedPackageLineItems": [
{
"weight": {
"units": "LB",
"value": 10
}
}
]
}
}
},
"Alternate_Currency_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 65247,
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": 75063,
"countryCode": "US"
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "FEDEX_2_DAY",
"rateRequestType": [
"PREFERRED"
],
"preferredCurrency": "CAD",
"requestedPackageLineItems": [
{
"weight": {
"units": "LB",
"value": 10
}
}
]
}
}
},
"Express_Freight_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 65247,
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": 75063,
"countryCode": "US"
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "FEDEX_1_DAY_FREIGHT",
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"requestedPackageLineItems": [
{
"weight": {
"units": "LB",
"value": 151
},
"dimensions": {
"length": 30,
"width": 30,
"height": 40,
"units": "IN"
}
}
]
}
}
},
"International_Hold_At_Location_with_Adult_Signature_Option": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 8099,
"countryCode": "CH"
}
},
"recipient": {
"address": {
"postalCode": 2116,
"countryCode": "AU"
}
},
"shipDateStamp": "2020-07-03",
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "INTERNATIONAL_PRIORITY",
"shipmentSpecialServices": {
"specialServiceTypes": [
"HOLD_AT_LOCATION"
]
},
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"customsClearanceDetail": {
"dutiesPayment": {
"paymentType": "SENDER",
"payor": {
"responsibleParty": null
}
},
"commodities": [
{
"description": "Camera",
"quantity": 1,
"quantityUnits": "PCS",
"weight": {
"units": "KG",
"value": 11
},
"customsValue": {
"amount": 100,
"currency": "SFR"
}
}
]
},
"requestedPackageLineItems": [
{
"weight": {
"units": "KG",
"value": 11
},
"packageSpecialServices": {
"specialServiceTypes": [
"SIGNATURE_OPTION"
],
"signatureOptionType": "ADULT"
}
}
]
}
}
},
"International_Multi_Piece_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 8099,
"countryCode": "CH"
}
},
"recipient": {
"address": {
"postalCode": 2116,
"countryCode": "AU"
}
},
"shipDateStamp": "2020-07-03",
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "INTERNATIONAL_PRIORITY",
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"customsClearanceDetail": {
"dutiesPayment": {
"paymentType": "SENDER",
"payor": {
"responsibleParty": null
}
},
"commodities": [
{
"description": "Camera",
"quantity": 1,
"quantityUnits": "PCS",
"weight": {
"units": "KG",
"value": 11
},
"customsValue": {
"amount": 100,
"currency": "SFR"
}
}
]
},
"requestedPackageLineItems": [
{
"groupPackageCount": 2,
"weight": {
"units": "KG",
"value": 1
}
},
{
"groupPackageCount": 3,
"weight": {
"units": "KG",
"value": 10
}
}
]
}
}
},
"International_Return_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 8099,
"countryCode": "CH"
}
},
"recipient": {
"address": {
"postalCode": 2116,
"countryCode": "AU"
}
},
"shipDateStamp": "2020-07-03",
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "INTERNATIONAL_PRIORITY",
"shipmentSpecialServices": {
"specialServiceTypes": [
"RETURN_SHIPMENT"
],
"returnShipmentDetail": {
"returnType": "PRINT_RETURN_LABEL"
}
},
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"customsClearanceDetail": {
"dutiesPayment": {
"paymentType": "SENDER",
"payor": {
"responsibleParty": null
}
},
"commodities": [
{
"description": "Camera",
"quantity": 1,
"quantityUnits": "PCS",
"weight": {
"units": "KG",
"value": 11
},
"customsValue": {
"amount": 100,
"currency": "SFR"
}
}
]
},
"requestedPackageLineItems": [
{
"weight": {
"units": "KG",
"value": 11
}
}
]
}
}
},
"Intra_Canada_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": "m1m1m1",
"countryCode": "CA"
}
},
"recipient": {
"address": {
"postalCode": "V5K1A1",
"countryCode": "CA"
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "STANDARD_OVERNIGHT",
"packagingType": "FEDEX_PAK",
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"requestedPackageLineItems": [
{
"weight": {
"units": "KG",
"value": 1
}
}
]
}
}
},
"Intra_Europe_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 75008,
"countryCode": "FR"
}
},
"recipient": {
"address": {
"postalCode": 10115,
"countryCode": "DE"
}
},
"shipDateStamp": "2020-07-03",
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "INTERNATIONAL_PRIORITY",
"packagingType": "YOUR_PACKAGING",
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"customsClearanceDetail": {
"dutiesPayment": {
"paymentType": "SENDER",
"payor": {
"responsibleParty": null
}
},
"commodities": [
{
"description": "Camera",
"weight": {
"value": 1,
"units": "KG"
},
"quantity": 1,
"quantityUnits": "PCS",
"customsValue": {
"amount": 100,
"currency": "EUR"
}
}
]
},
"requestedPackageLineItems": [
{
"weight": {
"units": "KG",
"value": 1
}
}
]
}
}
},
"Intra_India_Cash_On_Delivery_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 500001,
"countryCode": "IN"
}
},
"recipient": {
"address": {
"postalCode": 600021,
"countryCode": "IN"
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"packagingType": "YOUR_PACKAGING",
"shipmentSpecialServices": {
"specialServiceTypes": [
"COD"
]
},
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"customsClearanceDetail": {
"dutiesPayment": {
"paymentType": "SENDER",
"payor": {
"responsibleParty": null
}
},
"commercialInvoice": {
"shipmentPurpose": "SOLD"
},
"freightOnValue": "CARRIER_RISK",
"commodities": [
{
"description": "Camera",
"weight": {
"value": 1,
"units": "KG"
},
"quantity": 1,
"quantityUnits": "PCS",
"customsValue": {
"amount": 100,
"currency": "INR"
}
}
]
},
"requestedPackageLineItems": [
{
"weight": {
"units": "KG",
"value": 1
}
}
]
}
}
},
"Intra_Mexico_Express_Saver_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 11800,
"countryCode": "MX"
}
},
"recipient": {
"address": {
"postalCode": 66000,
"countryCode": "MX"
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "FEDEX_EXPRESS_SAVER",
"packagingType": "YOUR_PACKAGING",
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"requestedPackageLineItems": [
{
"weight": {
"units": "KG",
"value": 1
}
}
]
}
}
},
"Priority_Alert_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 65247,
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": 75063,
"countryCode": "US"
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "PRIORITY_OVERNIGHT",
"packagingType": "YOUR_PACKAGING",
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"requestedPackageLineItems": [
{
"weight": {
"units": "LB",
"value": 1
},
"packageSpecialServices": {
"specialServiceTypes": [
"PRIORITY_ALERT"
]
}
}
]
}
}
},
"Express_Freight_Saturday_Pickup_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 38017,
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": "m1m1m1",
"countryCode": "CA"
}
},
"shipDateStamp": "2020-07-04",
"pickupType": "CONTACT_FEDEX_TO_SCHEDULE",
"serviceType": "INTERNATIONAL_PRIORITY_FREIGHT",
"shipmentSpecialServices": {
"specialServiceTypes": [
"SATURDAY_PICKUP"
]
},
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"customsClearanceDetail": {
"dutiesPayment": {
"paymentType": "SENDER",
"payor": {
"responsibleParty": null
}
},
"commodities": [
{
"description": "Camera",
"quantity": 1,
"quantityUnits": "PCS",
"weight": {
"units": "LB",
"value": 151
},
"customsValue": {
"amount": 100,
"currency": "USD"
}
}
]
},
"requestedPackageLineItems": [
{
"weight": {
"units": "LB",
"value": 151
}
}
]
}
}
},
"SmartPost_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": "38017",
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": "75063",
"countryCode": "US"
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "SMART_POST",
"smartPostInfoDetail": {
"indicia": "PARCEL_SELECT",
"hubId": "5531"
},
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"requestedPackageLineItems": [
{
"weight": {
"units": "LB",
"value": "10"
}
}
]
}
}
},
"International_Dry_Ice_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 8099,
"countryCode": "CH"
}
},
"recipient": {
"address": {
"postalCode": 2116,
"countryCode": "AU"
}
},
"shipDateStamp": "2020-07-03",
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "INTERNATIONAL_PRIORITY",
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"customsClearanceDetail": {
"dutiesPayment": {
"paymentType": "SENDER",
"payor": {
"responsibleParty": null
}
},
"commodities": [
{
"description": "Camera",
"quantity": 1,
"quantityUnits": "PCS",
"weight": {
"units": "KG",
"value": 11
},
"customsValue": {
"amount": 100,
"currency": "SFR"
}
}
]
},
"requestedPackageLineItems": [
{
"weight": {
"units": "KG",
"value": 11
},
"packageSpecialServices": {
"specialServiceTypes": [
"DRY_ICE"
],
"dryIceWeight": {
"units": "KG",
"value": 5
}
}
}
]
}
}
},
"US_Domestic_Multi_Piece_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 65247,
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": 75063,
"countryCode": "US"
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "FEDEX_2_DAY",
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"requestedPackageLineItems": [
{
"groupPackageCount": 2,
"weight": {
"units": "LB",
"value": 1
}
},
{
"groupPackageCount": 3,
"weight": {
"units": "LB",
"value": 10
}
}
]
}
}
},
"US_Domestic_Priority_Overnight_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 65247,
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": 75063,
"countryCode": "US"
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "PRIORITY_OVERNIGHT",
"packagingType": "FEDEX_ENVELOPE",
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"requestedPackageLineItems": [
{
"weight": {
"units": "LB",
"value": 1
}
}
]
}
}
},
"Ground_Home_Delivery_Appointment_Delivery_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 65247,
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": 75063,
"countryCode": "US",
"residential": true
}
},
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "GROUND_HOME_DELIVERY",
"shipmentSpecialServices": {
"specialServiceTypes": [
"HOME_DELIVERY_PREMIUM"
],
"homeDeliveryPremiumDetail": {
"homedeliveryPremiumType": "APPOINTMENT"
}
},
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"requestedPackageLineItems": [
{
"weight": {
"units": "LB",
"value": 10
}
}
]
}
}
},
"International_Ground_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 75063,
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": "m1m1m1",
"countryCode": "CA"
}
},
"shipDateStamp": "2020-07-03",
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "FEDEX_GROUND",
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"customsClearanceDetail": {
"dutiesPayment": {
"paymentType": "SENDER",
"payor": {
"responsibleParty": null
}
},
"commodities": [
{
"description": "Camera",
"quantity": 1,
"quantityUnits": "PCS",
"weight": {
"units": "KG",
"value": 20
},
"customsValue": {
"amount": 100,
"currency": "USD"
}
}
]
},
"requestedPackageLineItems": [
{
"weight": {
"units": "KG",
"value": 20
}
}
]
}
}
},
"International_Priority_Rate_Quote": {
"example": {
"accountNumber": {
"value": "XXXXX7364"
},
"requestedShipment": {
"shipper": {
"address": {
"postalCode": 75063,
"countryCode": "US"
}
},
"recipient": {
"address": {
"postalCode": "m1m1m1",
"countryCode": "CA"
}
},
"shipDateStamp": "2020-07-03",
"pickupType": "DROPOFF_AT_FEDEX_LOCATION",
"serviceType": "INTERNATIONAL_PRIORITY",
"rateRequestType": [
"LIST",
"ACCOUNT"
],
"customsClearanceDetail": {
"dutiesPayment": {
"paymentType": "SENDER",
"payor": {
"responsibleParty": null
}
},
"commodities": [
{
"description": "Camera",
"quantity": 1,
"quantityUnits": "PCS",
"weight": {
"units": "KG",
"value": 20
},
"customsValue": {
"amount": 100,
"currency": "USD"
}
}
]
},
"requestedPackageLineItems": [
{
"weight": {
"units": "KG",
"value": 20
}
}
]
}
}
},
"body": {
"oneOf": [
{
"$ref": "#/components/schemas/Full_Schema_Quote_Rate"
},
{
"$ref": "#/components/schemas/MinimumSamplePayload_1"
},
{
"$ref": "#/components/schemas/FreightSamplePayload-RateResourceDetails_1"
},
{
"$ref": "#/components/schemas/US_Domestic_Rate_shop"
},
{
"$ref": "#/components/schemas/FDGSamplePayload-RateResourceDetails-IntraEurope"
},
{
"$ref": "#/components/schemas/Alternate_Currency_Rate_Quote"
},
{
"$ref": "#/components/schemas/Express_Freight_Rate_Quote"
},
{
"$ref": "#/components/schemas/International_Hold_At_Location_with_Adult_Signature_Option"
},
{
"$ref": "#/components/schemas/International_Multi_Piece_Rate_Quote"
},
{
"$ref": "#/components/schemas/International_Return_Rate_Quote"
},
{
"$ref": "#/components/schemas/Intra_Canada_Rate_Quote"
},
{
"$ref": "#/components/schemas/Intra_Europe_Rate_Quote"
},
{
"$ref": "#/components/schemas/Intra_India_Cash_On_Delivery_Rate_Quote"
},
{
"$ref": "#/components/schemas/Intra_Mexico_Express_Saver_Rate_Quote"
},
{
"$ref": "#/components/schemas/Priority_Alert_Rate_Quote"
},
{
"$ref": "#/components/schemas/Express_Freight_Saturday_Pickup_Rate_Quote"
},
{
"$ref": "#/components/schemas/SmartPost_Rate_Quote"
},
{
"$ref": "#/components/schemas/International_Dry_Ice_Rate_Quote"
},
{
"$ref": "#/components/schemas/US_Domestic_Multi_Piece_Rate_Quote"
},
{
"$ref": "#/components/schemas/US_Domestic_Priority_Overnight_Rate_Quote"
},
{
"$ref": "#/components/schemas/Ground_Home_Delivery_Appointment_Delivery_Rate_Quote"
},
{
"$ref": "#/components/schemas/International_Ground_Rate_Quote"
},
{
"$ref": "#/components/schemas/International_Priority_Rate_Quote"
}
]
},
"EMailNotificationDetail_PrintedReference": {
"type": "object",
"properties": {
"printedReferenceType": {
"type": "string",
"description": "Indicates the printed reference type.",
"enum": [
"BILL_OF_LADING",
"CONSIGNEE_ID_NUMBER",
"INTERLINE_PRO_NUMBER",
"PO_NUMBER",
"SHIPPER_ID_NUMBER",
"SHIPPER_ID1_NUMBER",
"SHIPPER_ID2_NUMBER"
]
},
"value": {
"type": "string",
"description": "Specifies printed reference value."
}
},
"description": "Specifies Printed Reference."
},
"ShipmentSpecialServicesRequested_returnShipmentDetail": {
"type": "object",
"properties": {
"returnType": {
"type": "string",
"description": "The type of return shipment being requested. ",
"enum": [
"FEDEX_TAG",
"PENDING",
"PRINT_RETURN_LABEL",
"EMAIL_LABEL",
"NET_RETURN",
"VOICE_CALL_TAG"
],
"example": "PRINT_RETURN_LABEL"
}
},
"description": "Details for the Return Shipment."
},
"DeliveryOnInvoiceAcceptanceDetailRecipient_address": {
"required": [
"countryCode"
],
"properties": {
"streetLines": {
"type": "array",
"description": "This is the combination of number, street name, etc.
Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included. Maximum Length per line is 35.
Example: [10 FedEx Parkway, Suite 302, .etc.]",
"example": [
"10 FedEx Parkway",
"Suite 30"
],
"items": {
"type": "string"
}
},
"countryCode": {
"type": "string",
"description": "The two-letter country code.
Maximum length is 2.
Example: US
Click here to see Country Codes",
"example": "US"
}
}
},
"Tax": {
"description": "Tax surcharge details",
"type": "object",
"properties": {
"amount": {
"description": "Tax amount.
Example: 408.97",
"format": "double",
"type": "number",
"example": 408.97
},
"name": {
"description": "The localized name of the tax.
Example: Denmark VAT",
"type": "string",
"example": "Denmark VAT"
},
"description": {
"description": "The description of the Surcharge/Tax.
Example: Denmark VAT",
"type": "string",
"example": "Denmark VAT"
},
"type": {
"description": "The type of Surcharge/Tax.
Example: VAT",
"type": "string",
"example": "VAT"
}
}
},
"DeliveryOnInvoiceAcceptanceDetailRecipient_contact": {
"required": [
"companyName",
"personName",
"phoneNumber"
],
"properties": {
"companyName": {
"type": "string",
"description": "This is a placeholder for company name. Maximum length is 35.",
"example": "FedEx"
},
"faxNumber": {
"type": "string",
"description": "This is a placeholder for Fax number. Maximum length is 15.",
"example": "9013577890"
},
"personName": {
"type": "string",
"description": "This is a placeholder for contact person's name. Maximum Length is 70.",
"example": "John Taylor"
},
"phoneNumber": {
"type": "string",
"description": "This is a placeholder for phone number associated with this contact. Maximum length is 15.",
"example": "9013577890"
}
}
}
}
}
}