Get Landed Cost - FlavorCloud Partner API Documentation

Returns the fully qualified landed cost calculation for a shipment. There is a limit of 20 items in "Pieces" array per request.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Reference

string

required

This field is for your reference. A good use of it would be to provide your order number here.

Currency

string

required

currency for the rate

WeightUnit

string

required

Unit for weight of the shipment. Possible values are - KG|LB

Pieces

array[object (Piece) {12}]

required

limit of 20 items in "Pieces" array

Quantity

number

required

Number of items

Weight

number

required

weight of the piece

Length

number

optional

Length of the parcel

Default:

Width

number

optional

Width of the parcel

Default:

Height

number

optional

Height of the parcel

Default:

SalePrice

number

required

Price of the item

HSCode

string

required

HS Code for the item

OriginCountryCode

string

optional

Origin country of the item

Description

string

required

Description of the item

SKU

string

optional

Product SKU

Material

string

optional

Material the item is made of

Category

array[string]

optional

ShipToAddress

object (Address)

required

Name

string

required

Name of person. Both name and company can be included

AttentionName

string

required

Name of attention, if person

AddressLine1

string

required

First line of the address

AddressLine2

string

optional

Second line of the address

AddressLine3

string

optional

Third line of the address

City

string

required

Full city name

State

string

optional

State or province

Country

string

required

ISO 3166 country code for the country the address is located in

Zip

string

optional

ZIP or postal code

Phone

string

required

Phone number to reach the person or organization

string

required

Email to reach the person or organization

ShipFromAddress

object (Address)

required

ShippingCost

number

optional

Specify a HashKey or ShippingCost to calculate the Duties

RateHashKey

string

optional

Specify a HashKey or ShippingCost to calculate the Duties

Example

{
    "Reference": "test-create-landed-cost-001",
    "Currency": "USD",
    "WeightUnit": "LB",
    "ShippingCost": 100.00,
    "Pieces": [
        {
            "Quantity": 1,
            "Weight": 2,
            "SalePrice": 250,
            "HSCode": "610910",
            "OriginCountryCode": "US",
            "Description": "T Shirt",
            "Category": [
                "merchandise"
            ],
            "SKU": "1234567890"
        }
    ],
    "ShipFromAddress": {
        "Name": "FC Landed Cost",
        "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 Landed Cost",
        "AttentionName": "FC Rates",
        "AddressLine1": "49 Montcalm Ave",
        "AddressLine2": "",
        "AddressLine3": "",
        "City": "York",
        "State": "ON",
        "Country": "CA",
        "Zip": "M6E 4N8",
        "Phone": "1111111111",
        "Email": "test@test.com"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

LandedCostID

string

required

This is a unique id that can be used to retrieve the landed cost at a later time.

Reference

string

required

This is the reference id you passed in while making the request

Currency

string

required

currency for the rate

HashKey

string

required

The unique key of the landed cost

Duty

string

required

Duties for the order to be returned to the customer after conversion optimization rules are applied

ActualDuty

string

required

Actual Duties prior to any conversion optimization rules being applied

SalesTax

string

required

Sales tax for the order to be returned to the customer after conversion optimization rules are applied

ActualSalesTax

string

required

Actual sales tax prior to any conversion optimization rules being applied

AIT

string

required

Fees for the order to be returned to the customer after conversion optimization rules are applied

ActualAIT

string

required

Actual fees prior to any conversion optimization rules being applied

LandedCost

string

required

Landed cost (Duties/Taxes/Fees) for the order to be returned to the customer after conversion optimization rules are applied

ActualLandedCost

string

required

Actual Landed cost prior to any conversion optimization rules being applied

Pieces

object

optional

HScode

string

required

6 digit HSCode

HSLong

string

required

Country specific long HS code (10/12/13 digit)

Example

{
    "Duty": 62.5,
    "ActualDuty": 62.5,
    "SalesTax": 40.63,
    "ActualSalesTax": 40.63,
    "AIT": 20.63,
    "ActualAIT": 20.63,
    "LandedCost": 123.76,
    "ActualLandedCost": 123.76,
    "HashKey": "bed9e1d9-3ca0-4066-87ad-4c8add22f39d",
    "LandedCostID": 22668174,
    "Reference": "test-create-landed-cost-001",
    "Currency": "USD",
    "Pieces": [
        {
            "HSCode": "610910",
            "HSLong": "6109100019"
        }
    ],
    "RootRequestId": "7e46c133-46b2-45c6-a7a9-1a50fa6a09c2"
}

🟠401Authentication Error

🟠422Validation Error

🔴500Error Response