1. Rates
FlavorCloud Partner API Documentation
  • Getting Started Guide for Merchants
  • B2B International Shipping Guide
  • Getting Started Guide for 3PLs
  • Returns Guide
  • Authentication
    • Get Auth Token
      POST
  • Rates
    • Get Rates
      POST
    • Get Multi Rates
      POST
  • Shipments
    • Create Shipments
      POST
    • Get Shipments
      GET
    • Cancel Shipments
      PUT
  • Tracking
    • Get Tracking Detail
      GET
  • Classifications
    • Get Classification
      POST
  • Landed Cost
    • Get Landed Cost
      POST
  • Webhooks
    • Subscribe Webhooks
      POST
    • Unsubscribe Webhooks
      POST
  • Invoices
    • Get Invoice Detail
      GET
    • Get Invoices
      GET
  • Schemas
    • Schemas
      • ClassificationStatus
      • ProductResponse
      • ClassificationResponse
      • MissingProperty
      • ResponseDetails
      • ResponseData
      • ErrorResponse
      • ClassificationProduct
      • ClassificationRequest
      • InvoiceResponse
      • CustomerResponse
      • AccountInformation
      • ShippingOrigin
      • AveragePackageSettings
      • CreateCustomerRequest
      • CreateCustomerResponse
      • GetCustomerResponse
      • LandedCostResponse
      • Piece
      • Address
      • LandedCostRequest
      • CreateManifestShipmentResponse
      • CreateManifestShipmentRequest
      • GetManifestShipmentResponse
      • RateDetailDDU
      • LandedCostDetail
      • RateDetailDDP
      • TradeModel
      • RatesResponse
      • QuoteToAddress
      • QuoteFromAddress
      • QuotePiece
      • Package
      • QuoteRequest
      • RateRequest
      • ShipmentPackage
      • ShipmentsModel
      • MultiRateRequest
      • ShipmentsModelQuote
      • MultiQuoteRequest
      • RateDetailReponse
      • ShipmentBatches
      • ShipFromAddress
      • ShipToAddress
      • IndiaExportInfo
      • Metadata
      • BatchRequest
      • BatchUpdateReqModel
      • BatchCloseReqModel
      • ShipmentBatchesResponseModel
      • ShipmentResponse
      • ShipmentResponseExcluding_ConsolidateLabel_
      • ShipmentRequest
      • CancelShipmentResponse
      • CancelShipmentRequest
      • TrackingHistory
      • TrackingAPIResponse
      • CreateWebhookResponse
      • WebHookInfo
      • SubscribeWebhooksRequest
      • UnSubscribeWebhookRequest
  1. Rates

Get Multi Rates

POST
/MultiRates
This API call is used to return Multi-Rated shipments. All the details of the shipments should be provided to the api. Within the shipment array you include sets of pieces and package pairs which make this a Multi-Rate request. Our route optimization engine, determines the best available route based on cost, service level and historical performance. DHL and FedEx support multi-piece shipments while other carriers do not support multi-piece shipments. Only express rates will be returned in the response for multi-rate/shipment requests.

Request

Header Params

Body Params application/json

Example
{
    "Reference": "test-multi-rates-001",
    "LabelFormat": "PDF",
    "WeightUnit": "LB",
    "Currency": "USD",
    "DimensionUnit": "IN",
    "Insurance": "N",
    "ServiceCode": [
        "STANDARD",
        "EXPRESS"
    ],
    "TermsOfTrade": [
        "DDP",
        "DDU"
    ],
    "IsReturn": "N",
    "IncludeLandedCost": true,
    "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"
    },
    "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"
    },
    "ReasonForExport": "merchandise",
    "Shipments": [
        {
            "Piece": [
                {
                    "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 Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://partnerapi.flavorcloud.com/MultiRates' \
--header 'Authorization: {{JWT_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Reference": "test-multi-rates-001",
    "LabelFormat": "PDF",
    "WeightUnit": "LB",
    "Currency": "USD",
    "DimensionUnit": "IN",
    "Insurance": "N",
    "ServiceCode": [
        "STANDARD",
        "EXPRESS"
    ],
    "TermsOfTrade": [
        "DDP",
        "DDU"
    ],
    "IsReturn": "N",
    "IncludeLandedCost": true,
    "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"
    },
    "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"
    },
    "ReasonForExport": "merchandise",
    "Shipments": [
        {
            "Piece": [
                {
                    "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

🟢200MultiRate Response
application/json
Bodyapplication/json

Example
{
    "RateId": "string",
    "Reference": "string",
    "Currency": "string",
    "Standard": {
        "DDU": {
            "HashKey": "string",
            "ShippingCost": "string",
            "ActualShippingCost": "string",
            "DiscountedShippingCost": "string",
            "Carrier": "string",
            "Insurance": "string",
            "Days": "string"
        },
        "DDP": {
            "HashKey": "string",
            "ShippingCost": "string",
            "ActualShippingCost": "string",
            "DiscountedShippingCost": "string",
            "Carrier": "string",
            "Insurance": "string",
            "Days": "string",
            "LandedCostDetail": {
                "Duty": "string",
                "ActualDuty": "string",
                "SalesTax": "string",
                "ActualSalesTax": "string",
                "AIT": "string",
                "ActualAIT": "string",
                "LandedCost": "string",
                "ActualLandedCost": "string",
                "DutyHashKey": "string"
            }
        }
    },
    "Express": {
        "DDU": {
            "HashKey": "string",
            "ShippingCost": "string",
            "ActualShippingCost": "string",
            "DiscountedShippingCost": "string",
            "Carrier": "string",
            "Insurance": "string",
            "Days": "string"
        },
        "DDP": {
            "HashKey": "string",
            "ShippingCost": "string",
            "ActualShippingCost": "string",
            "DiscountedShippingCost": "string",
            "Carrier": "string",
            "Insurance": "string",
            "Days": "string",
            "LandedCostDetail": {
                "Duty": "string",
                "ActualDuty": "string",
                "SalesTax": "string",
                "ActualSalesTax": "string",
                "AIT": "string",
                "ActualAIT": "string",
                "LandedCost": "string",
                "ActualLandedCost": "string",
                "DutyHashKey": "string"
            }
        }
    },
    "StandardEconomy": {
        "DDU": {
            "HashKey": "string",
            "ShippingCost": "string",
            "ActualShippingCost": "string",
            "DiscountedShippingCost": "string",
            "Carrier": "string",
            "Insurance": "string",
            "Days": "string"
        },
        "DDP": {
            "HashKey": "string",
            "ShippingCost": "string",
            "ActualShippingCost": "string",
            "DiscountedShippingCost": "string",
            "Carrier": "string",
            "Insurance": "string",
            "Days": "string",
            "LandedCostDetail": {
                "Duty": "string",
                "ActualDuty": "string",
                "SalesTax": "string",
                "ActualSalesTax": "string",
                "AIT": "string",
                "ActualAIT": "string",
                "LandedCost": "string",
                "ActualLandedCost": "string",
                "DutyHashKey": "string"
            }
        }
    },
    "ExpressEconomy": {
        "DDU": {
            "HashKey": "string",
            "ShippingCost": "string",
            "ActualShippingCost": "string",
            "DiscountedShippingCost": "string",
            "Carrier": "string",
            "Insurance": "string",
            "Days": "string"
        },
        "DDP": {
            "HashKey": "string",
            "ShippingCost": "string",
            "ActualShippingCost": "string",
            "DiscountedShippingCost": "string",
            "Carrier": "string",
            "Insurance": "string",
            "Days": "string",
            "LandedCostDetail": {
                "Duty": "string",
                "ActualDuty": "string",
                "SalesTax": "string",
                "ActualSalesTax": "string",
                "AIT": "string",
                "ActualAIT": "string",
                "LandedCost": "string",
                "ActualLandedCost": "string",
                "DutyHashKey": "string"
            }
        }
    },
    "Pieces": {
        "HSCode": "string",
        "HSLong": "string"
    }
}
🟠401Authentication Error
🟠422Validation Error
🔴500Error Response
Modified at 2026-02-24 15:43:15
Previous
Get Rates
Next
Create Shipments
Built with