Landed Cost Calculator API

Estimated reading: 9 minutes 19 views

Landed Cost Calculator API Documentation

The Landed Cost Calculator API calculates international duties, brokerage fees and taxes based on the online retailer’s shopping cart details.

Landed Cost Calculator API Endpoint URL

api.landedcost.io/calculator

Landed Cost Calculator API Request Method

POST

Landed Cost Calculator API Request Definitions

NameDescriptionRequiredTypeMax AllowedLength
securityKeyThe seller’s API security keyYesString11…100
carrierShipping carrier to deliver the merchandise. Options: ANY, UPS, FEDEX, DHLYesString11…5
shippingMethodShipping method to deliver the merchandise. Options: ANY, AIR, GROUND, 2DAYYesString11…5
languageCodeThe landed cost quote’s target ISO language code. The default is ‘en-us’ (English/United States)YesString11…5
shippingCostTotalThe total shipping costs for the orderYesString11…20
sourceCurrencyCodeThe source currency code, normally the currency code of the seller’s country. ISO currency codes supported.YesString13
targetCurrencyCodeThe target currency code, normally the currency code of the customer’s country. ISO currency codes supported.YesString13
discountTotalThe discount that should be applied to the landed cost calculation. Only positive amounts are accepted. For example, 10.00 would represent a 10 USD Dollar discount.YesString11…20
transactionIdThe seller may provide a transaction ID to lookup landed cost details by the seller’s transaction ID (order number)NoString11…100
additionalInsuranceTotalThe insurance value that should be applied to the landed cost calculationYesString11…20
addressesThe collection of addresses. Two addresses are required: seller and Customer. The first address in the collection should contain the seller’s address. The second address in the collection should contain the customer’s addressYesContainer2N/A
— firstNameThe seller’s or customer’s first nameYesString11…255
— lastNameThe seller’s or customer’s last nameYesString11…255
— companyThe seller’s or customer’s company’s nameNoString11…100
— address1The seller’s or customer’s address1 lineYesString11…255
— address2The seller’s or customer’s address2 lineYesString11…255
— cityThe seller’s or customer’s cityYesString11…255
— regionCodeThe seller’s or customer’s state/province/regionYesString11…255
— countryCodeThe seller’s or customer’s country code. Full list available here: https://www.landedcost.io/documentation/country-codesYesString11…255
— postalCodeThe seller’s or customer’s zip code/postal codeNoString11…20
— emailAddressThe seller’s or customer’s email addressYesString11…100
— nationalIdentificationNumberThe seller’s national identification numberNoString11…100
— addressTypeThe seller’s addressType must contain “ShipFrom” (without the quotes). The customer’s addressType must contain “ShipTo” (without the quotes).YesString11…100
itemsThe collection of products/items included in the transactionYesContainerUnboundedN/A
— skuThe product’s SKU number.YesString11…255
— nameThe product’s nameYesString11…255
— descriptionThe product’s full descriptionYesString11…4000
— priceThe product’s priceYesString11…25
— quantityThe product’s quantity ordered by the customerYesInteger11…4
— categoryThe product’s category name. This will contain the Web category for online sellers.NoString11…100
— attributesThe product’s special attributesNoString1Unbounded
— weightThe product’s weight. A numeric value is required.YesString11…15
— uomThe product’s Unit of Measure. Acceptable options: lbs, ea , kgNoString12
— countryOfOriginThe product’s country of originYesString12
— hsCodeThe item’s HTS or HS Classification Code, supports both HTS (10-digits) and HS Codes (6-digits)YesString11…15
— autoClassifyInforms the Landed Cost Calculator API to auto select the appropriate HS Code based on the product description, category and attributes. To enable auto-classification, set this attribute to: auto-classify (all lower case). Otherwise, set this attribute to: falseNoString11…15
— freeCirculationFor UK-based sellers Informs the Landed Cost Calculator API whether the product is considered free circulation. If set to false, the product will be considered GSP Eligible. If set to true, the product will be non-GSP Eligible. Default value is set to: false if not provided in the APINoString11…15
— isFTAEligibleIf the seller has been able to certify that a specific product originates/qualifies for the ship to (destination) country’s free trade agreement, the seller can set this element to true to recieve the free trade agreement benefit for a specific sku. Only set the value to true, if you have received a Free Trade Agreement Certification or Declaration from the ship to country’s issuing authority. Default value is set to false if not provided in the APINoString11…15

Landed Cost Calculator API Response Definitions

NameDescriptionRequiredTypeMax AllowedLengthValidation Rules
idUnique identifier generated by each Landed Cost Calculator API call. This id can be used for reference during reconciliation or integration.YesString113
transactionIdThe transaction ID provided by the seller to lookup landed cost response details by the seller’s transaction IDNoString11…100
codeThe API response codeYesString11…10
messageThe API response messageYesString11…100
securityKeyThe seller’s API security keyYesString11…100
dutiesTotalThe calculated duties totalYesString11…20
taxesTotalThe calculated taxes totalYesString11…20
feesTotalThe calculated fees totalYesString11…20
subTotalThe calculated sub-total (merchandise total)YesString11…20
grandTotalThe calculated grand totalYesString11…20
landedCostTotalThe calculated “landed cost” totalYesString11…20
carrierShipping carrier to deliver the merchandise. Options: UPS, FEDEX, DHLYesString11…5
shippingMethodShipping method to deliver the merchandise. Options: ANY, AIR, GROUND, 2DAYYesString11…5
languageCodeThe landed cost quote’s target ISO language code. The default is ‘en-us’ (English/United States)YesString11…5
shippingCostTotalThe total shipping costs for the orderNoString11…20
sourceCurrencyCodeThe source currency code, normally the currency code of the seller’s country. ISO currency codes supported.YesString13
targetCurrencyCodeThe target currency code, normally the currency code of the customer’s country. ISO currency codes supported.YesString13
discountTotalThe discount applied to the landed cost calculationYesString11…20
additionalInsuranceTotalThe insurance value applied to the landed cost calculationYes1
utcDateTimeStampThe transaction date/timeStamp in Coordinated Universal Time (UTC)YesString11…100
timeStampThe transaction UNIX timeStampYesString11…12
feesThe collection of fees applied in the calculationYesContainerUnboundedN/A
— nameThe fee applied in the calculationYesString11…25
— amountThe fee amount applied in the calculationYesString11…25
taxesThe collection of taxes applied in the calculationYesContainerUnboundedN/A
— nameThe tax applied in the calculationYesString11…25
— localNameThe tax’s local name applied in the calculationYesString11…25
— amountThe tax amount applied in the calculationYesString11…25
addressesThe collection of addresses. Two addresses are required: seller and Customer. The first address in the collection should contain the seller’s address. The second address in the collection should contain the customer’s addressYesContainer2N/A
— firstNameThe seller’s or customer’s first nameYesString11…255
— lastNameThe seller’s or customer’s last nameYesString11…255
— companyThe seller’s or customer’s company’s nameNoString11…100
— address1The seller’s or customer’s address1 lineYesString11…255
— address2The seller’s or customer’s address2 lineYesString11…255
— cityThe seller’s or customer’s cityYesString11…255
— regionCodeThe seller’s or customer’s state/province/regionYesString11…255
— countryCodeThe seller’s or customer’s country code. Full list available here: https://www.landedcost.io/documentation/country-codesYesString11…255
— postalCodeThe seller’s or customer’s zip code/postal codeNoString11…20
— emailAddressThe seller’s or customer’s email addressYesString11…100
— nationalIdentificationNumberThe seller’s national identification numberNoString11…100
— addressTypeThe seller’s addressType must contain “ShipFrom” (without the quotes). The customer’s addressType must contain “ShipTo” (without the quotes).YesString11…100
itemsThe collection of shopping cart items.YesContainerUnboundedN/A
— skuThe product’s SKU number.YesString11…255
— nameThe product’s nameYesString11…255
— descriptionThe product’s full descriptionYesString11…4000
— priceThe product’s priceYesString11…25
— quantityThe product’s quantity ordered by the customerYesInteger11…4
— categoryThe product’s category name. This will contain the Web category for online sellers.YesString11…100
— attributesThe product’s special attributesNoString1Unbounded
— weightThe product’s weight. A value of numeric value is required.YesString11…15
— uomThe product’s Unit of Measure. Acceptable options: lbs, ea , kgNoString12
— countryOfOriginThe product’s country of originYesString12
— hsCodeThe product’s HTS or HTS Classification Code.NoString11…15
— dutiesAmountThe product’s calculated duties amountYesString11…15
— taxesAmountThe product’s calculated taxes amountYesString11…15
— hsCodeAccuracyThe accuracy of HS Code lookup on a scale from 0 to 100 (100 signifies the HTS Code was found. 80 signifies the HS Code was found. 0 signifies neither the HTS Code or HS Code were found in the system.)YesString11…3
— restrictedIndicates whether the product may or may not be shipped to the destination country. Possible return values: true , falseYesString11…10
— autoClassifyIndicates whether the product used the auto-select feature to identify the appropriate HS Code based on the product description, category and attributesNoString11…15

Sample Landed Cost Calculator API JSON Request Using Valid HS Code

 

{
	"carrier": "DHL",
	"shippingMethod": "ANY",
	"securityKey": "{Your Security Key Goes Here}",
	"shippingCostTotal": "00.00",
	"sourceCurrencyCode": "USD",
	"targetCurrencyCode": "USD",
	"discountTotal": "0.00",
	"additionalInsuranceTotal": "0.00",
	"languageCode": "en-us",
	"addresses": [{
		"firstName": "John",
		"lastName": "Shipper",
		"address1": "123 Vine Street",
		"address2": "",
		"city": "Lemoore",
		"regionCode": "CA",
		"countryCode": "US",
		"postalCode": "93245",
		"emailAddress": "john_shipper@email.com",
		"nationalIdentificationNumber": "",
		"addressType": "shipFrom"
	},
	{
		"firstName": "Bob",
		"lastName": "Customer",
		"address1": "Filbert Way",
		"address2": "",
		"city": "Toronto",
		"regionCode": "ON",
		"countryCode": "CA",
		"postalCode": "M4C 1B5",
		"emailAddress": "bob_customer@email.com",
		"nationalIdentificationNumber": "",
		"addressType": "shipTo"
	}],
	"items": [{
		"sku": "SC90",
		"description": "Men's Cotton Shorts (Color: Blue, Size: Large)",
		"name": "Men's Cotton Shorts",
		"price": "19.00",
		"quantity": 1,
		"category": "Apparel",
		"hsCode": "6203.42.00.41",
		"weight": 1,
		"uom": "lbs",
		"countryOfOrigin": "US",
        "autoClassify": "false"
		
	}]
}

Sample Landed Cost Calculator API JSON Response Using Valid HS Code

 
{
	"id": "583e625043f3127d8afe129d",
	"code": "200",
	"message": "Landed Cost API Request Was Successful",
	"securityKey": "{Your Security Key Goes Here}",
	"shippingMethod": "ANY",
	"shippingCostTotal": "0.00",
	"additionalInsuranceTotal": "0.00",
	"discountTotal": "0.00",
	"languageCode": "en-us",
	"dutiesTotal": "0.03",
	"taxesTotal": "2.47",
	"feesTotal": "0.00",
	"subTotal": "19.00",
	"grandTotal": "21.50",
	"landedCostTotal": "2.50",
	"carrier": "DHL",
	"sourceCurrencyCode": "USD",
	"targetCurrencyCode": "USD",
	"transactionId": "",
	"items": [
		{
			"sku": "SC90",
			"name": "Men's Cotton Shorts",
			"description": "Men's Cotton Shorts (Color: Blue, Size: Large)",
			"price": "19.00",
			"quantity": "1",
			"category": "Apparel",
			"dutiesAmount": "0.03",
			"taxesAmount": "2.47",
			"restricted": "false",
			"hsCode": "6203.42.00.41",
			"weight": "1",
			"uom": "lbs",
			"countryOfOrigin": "US",
			"hsCodeAccuracy": "100",
            "autoClassify": "false"
		}
	],
	"fees": [
	],
	"taxes": [
		{
			"name": "Goods and Services Tax",
			"localName": "Goods and Services Tax",
			"amount": "0.95"
		},
		{
			"name": "Harmonized Sales Tax",
			"localName": "Harmonized Sales Tax",
			"amount": "1.52"
		}
	],
	"addresses": [
		{
			"firstName": "John",
			"lastName": "Shipper",
			"company": "",
			"address1": "123 Vine Street",
			"address2": "",
			"city": "Lemoore",
			"regionCode": "CA",
			"postalCode": "93245",
			"countryCode": "US",
			"emailAddress": "john_shipper@email.com",
			"addressType": "shipFrom",
			"nationalIdentificationNumber": ""
		},
		{
			"firstName": "Bob",
			"lastName": "Customer",
			"company": "",
			"address1": "Filbert Way",
			"address2": "",
			"city": "Toronto",
			"regionCode": "ON",
			"postalCode": "M4C 1B5",
			"countryCode": "CA",
			"emailAddress": "bob_customer@email.com",
			"addressType": "shipTo",
			"nationalIdentificationNumber": ""
		}
	],
	"utcDateTimeStamp": "Wed, Nov 30, 2016 05:23:28 AM UTC",
	"timeStamp": "1480483408"
}

Sample Landed Cost Calculator API JSON Request Using Auto-Classification

 

{
    "carrier": "DHL",
    "shippingMethod": "ANY",
    "securityKey": "{Your Security Key Goes Here}",
    "shippingCostTotal": "00.00",
    "sourceCurrencyCode": "USD",
    "targetCurrencyCode": "USD",
    "discountTotal": "0.00",
    "additionalInsuranceTotal": "0.00",
    "languageCode": "en-us",
    "addresses": [{
        "firstName": "John",
        "lastName": "Shipper",
        "address1": "123 Vine Street",
        "address2": "",
        "city": "Lemoore",
        "regionCode": "CA",
        "countryCode": "US",
        "postalCode": "93245",
        "emailAddress": "john_shipper@email.com",
        "nationalIdentificationNumber": "",
        "addressType": "shipFrom"
    },
    {
        "firstName": "Bob",
        "lastName": "Customer",
        "address1": "Filbert Way",
        "address2": "",
        "city": "Toronto",
        "regionCode": "ON",
        "countryCode": "CA",
        "postalCode": "M4C 1B5",
        "emailAddress": "bob_customer@email.com",
        "nationalIdentificationNumber": "",
        "addressType": "shipTo"
    }],
    "items": [{
        "sku": "SC90",
        "description": "Men's Cotton Shorts (Color: Blue, Size: Large)",
        "name": "Men's Cotton Shorts",
        "price": "19.00",
        "quantity": 1,
        "category": "Apparel",
        "hsCode": "",
        "weight": 1,
        "uom": "lbs",
        "countryOfOrigin": "US",
        "autoClassify": "auto-classifiy"
        
    }]
}

Sample Landed Cost Calculator API JSON Response Using Auto-Classification

 
{
    "id": "583e625043f3127d8afe129d",
    "code": "200",
    "message": "Landed Cost API Request Was Successful",
    "securityKey": "{Your Security Key Goes Here}",
    "shippingMethod": "ANY",
    "shippingCostTotal": "0.00",
    "additionalInsuranceTotal": "0.00",
    "discountTotal": "0.00",
    "languageCode": "en-us",
    "dutiesTotal": "0.03",
    "taxesTotal": "2.47",
    "feesTotal": "0.00",
    "subTotal": "19.00",
    "grandTotal": "21.50",
    "landedCostTotal": "2.50",
    "carrier": "DHL",
    "sourceCurrencyCode": "USD",
    "targetCurrencyCode": "USD",
    "transactionId": "",
    "items": [
        {
            "sku": "SC90",
            "name": "Men's Cotton Shorts",
            "description": "Men's Cotton Shorts (Color: Blue, Size: Large)",
            "price": "19.00",
            "quantity": "1",
            "category": "Apparel",
            "dutiesAmount": "0.03",
            "taxesAmount": "2.47",
            "restricted": "false",
            "hsCode": "6203.42.00.41",
            "weight": "1",
            "uom": "lbs",
            "countryOfOrigin": "US",
            "hsCodeAccuracy": "100",
            "autoClassify": "auto-classifiy"
        }
    ],
    "fees": [
    ],
    "taxes": [
        {
            "name": "Goods and Services Tax",
            "localName": "Goods and Services Tax",
            "amount": "0.95"
        },
        {
            "name": "Harmonized Sales Tax",
            "localName": "Harmonized Sales Tax",
            "amount": "1.52"
        }
    ],
    "addresses": [
        {
            "firstName": "John",
            "lastName": "Shipper",
            "company": "",
            "address1": "123 Vine Street",
            "address2": "",
            "city": "Lemoore",
            "regionCode": "CA",
            "postalCode": "93245",
            "countryCode": "US",
            "emailAddress": "john_shipper@email.com",
            "addressType": "shipFrom",
            "nationalIdentificationNumber": ""
        },
        {
            "firstName": "Bob",
            "lastName": "Customer",
            "company": "",
            "address1": "Filbert Way",
            "address2": "",
            "city": "Toronto",
            "regionCode": "ON",
            "postalCode": "M4C 1B5",
            "countryCode": "CA",
            "emailAddress": "bob_customer@email.com",
            "addressType": "shipTo",
            "nationalIdentificationNumber": ""
        }
    ],
    "utcDateTimeStamp": "Wed, Nov 30, 2016 05:23:28 AM UTC",
    "timeStamp": "1480483408"
}

For questions and information about the Landed Cost Calcultor API please contact us.

Leave a Reply

Your email address will not be published. Required fields are marked *

Share this Doc

Landed Cost Calculator API

Or copy link

CONTENTS

Powered By EazyDocs