Get Rates

POST

/Rates

This API call is used to return the rates for a shipment. All the details of the shipment should be provided to the api. Our route optimization engine determines the best available route based on cost, service level and historical performance.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "Reference": "test-rates-001",
    "LabelFormat": "PDF",
    "WeightUnit": "LB",
    "Currency": "USD",
    "DimensionUnit": "IN",
    "Insurance": "Y",
    "ServiceCode": [
        "STANDARD",
        "EXPRESS"
    ],
    "TermsOfTrade": [
        "DDP",
        "DDU"
    ],
    "IsReturn": "N",
    "IncludeLandedCost": true,
    "ShipFromAddress": {
        "Name": "FC Rates",
        "AttentionName": "",
        "AddressLine1": "1562 Washington St",
        "AddressLine2": "",
        "AddressLine3": "",
        "City": "San Francisco",
        "State": "CA",
        "Country": "US",
        "Zip": "94109",
        "Phone": "1111111111",
        "Email": "test@test.com"
    },
    "ShipToAddress": {
        "Name": "FC Rates",
        "AttentionName": "FC Rates",
        "AddressLine1": "49 Montcalm Ave",
        "AddressLine2": "",
        "AddressLine3": "",
        "City": "York",
        "State": "ON",
        "Country": "CA",
        "Zip": "M6E 4N8",
        "Phone": "1111111111",
        "Email": "test@test.com"
    },
    "ReasonForExport": "merchandise",
    "Pieces": [
        {
            "Quantity": 1,
            "Weight": 0.1,
            "Length": 1,
            "Width": 1,
            "Height": 1,
            "SalePrice": 10,
            "HSCode": "610910",
            "OriginCountryCode": "US",
            "Description": "T-SHIRT",
            "SKU": "1234567890",
            "Material": "",
            "Category": [
                "merchandise"
            ]
        }
    ],
    "Package": {
        "Weight": 0.5,
        "Length": 1,
        "Width": 1,
        "Height": 1
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://partnerapi.flavorcloud.com/Rates' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Reference": "test-rates-001",
    "LabelFormat": "PDF",
    "WeightUnit": "LB",
    "Currency": "USD",
    "DimensionUnit": "IN",
    "Insurance": "Y",
    "ServiceCode": [
        "STANDARD",
        "EXPRESS"
    ],
    "TermsOfTrade": [
        "DDP",
        "DDU"
    ],
    "IsReturn": "N",
    "IncludeLandedCost": true,
    "ShipFromAddress": {
        "Name": "FC Rates",
        "AttentionName": "",
        "AddressLine1": "1562 Washington St",
        "AddressLine2": "",
        "AddressLine3": "",
        "City": "San Francisco",
        "State": "CA",
        "Country": "US",
        "Zip": "94109",
        "Phone": "1111111111",
        "Email": "test@test.com"
    },
    "ShipToAddress": {
        "Name": "FC Rates",
        "AttentionName": "FC Rates",
        "AddressLine1": "49 Montcalm Ave",
        "AddressLine2": "",
        "AddressLine3": "",
        "City": "York",
        "State": "ON",
        "Country": "CA",
        "Zip": "M6E 4N8",
        "Phone": "1111111111",
        "Email": "test@test.com"
    },
    "ReasonForExport": "merchandise",
    "Pieces": [
        {
            "Quantity": 1,
            "Weight": 0.1,
            "Length": 1,
            "Width": 1,
            "Height": 1,
            "SalePrice": 10,
            "HSCode": "610910",
            "OriginCountryCode": "US",
            "Description": "T-SHIRT",
            "SKU": "1234567890",
            "Material": "",
            "Category": [
                "merchandise"
            ]
        }
    ],
    "Package": {
        "Weight": 0.5,
        "Length": 1,
        "Width": 1,
        "Height": 1
    }
}'

Responses

🟢200Rate Response

application/json

Body

Example

{
    "RateId": 25911009,
    "Reference": "test-rates-001",
    "Currency": "USD",
    "Express": {
        "DDP": {
            "HashKey": "a0fd5b74-1a62-4ce6-8935-7ad9d5b3a2ff",
            "ShippingCost": 51.3,
            "ActualShippingCost": 51.3,
            "Insurance": 0,
            "DiscountedShippingCost": 51.3,
            "Days": "2-3 business days",
            "Carrier": "FlavorCloud",
            "LandedCostDetail": {
                "AIT": 0,
                "Duty": 0,
                "SalesTax": 0,
                "LandedCost": 0,
                "DutyHashKey": "6ae9af3a-d0a3-47b3-ab32-397165f356b7",
                "ActualAIT": 0,
                "ActualDuty": 0,
                "ActualSalesTax": 0,
                "ActualLandedCost": 0
            }
        },
        "DDU": {
            "HashKey": "ed3a2915-85b5-41fe-a884-72e944e7beb0",
            "ShippingCost": 29.2,
            "ActualShippingCost": 29.2,
            "Insurance": 0,
            "DiscountedShippingCost": 29.2,
            "Days": "2-3 business days",
            "Carrier": "FlavorCloud"
        }
    },
    "Standard": {
        "DDP": {
            "HashKey": "1be086b4-42a2-4c74-9c94-2aea0644a40f",
            "ShippingCost": 7.01,
            "ActualShippingCost": 7.01,
            "Insurance": 0,
            "DiscountedShippingCost": 7.01,
            "Days": "2-9 business days",
            "Carrier": "FlavorCloud",
            "LandedCostDetail": {
                "AIT": 0,
                "Duty": 0,
                "SalesTax": 0,
                "LandedCost": 0,
                "DutyHashKey": "d1588ae8-795c-4b79-9077-b392aae9d1fa",
                "ActualAIT": 0,
                "ActualDuty": 0,
                "ActualSalesTax": 0,
                "ActualLandedCost": 0
            }
        },
        "DDU": {
            "HashKey": "54eb85ba-10b2-45bd-9cc1-df11c7716cf5",
            "ShippingCost": 7.9,
            "ActualShippingCost": 7.9,
            "Insurance": 0,
            "DiscountedShippingCost": 7.9,
            "Days": "6-14 business days",
            "Carrier": "FlavorCloud"
        }
    },
    "Pieces": [
        {
            "HSCode": "610910",
            "HSLong": "6109100019"
        }
    ],
    "RootRequestId": "ad67c716-b83a-44bb-b0ac-b41be13c0bf0"
}

🟠401Authentication Error

🟠422Validation Error

🔴500Error Response

Modified at 2025-06-30 17:51:35

Get Auth Token

Create Shipments