Calculate Duties and Taxes for Single Country

This API calculates estimated duties and taxes for a basket of items being shipped to a single country. A landed cost is the total of all charges involved in a crossborder transaction, including transportation, import duties and taxes, shipping insurance, and related fees. Use this API to power a superior “duty-paid” checkout experience with accurate D&T estimates, and/or to inform business planning around import costs.

SecuritybearerAuth
Request
query Parameters
calculationType
string

The type of calculation to be performed. Possible values are:

  • duty: Only the duty will be returned
  • tax: Only the tax will be returned
  • duty_tax: Both duty and tax will be returned (default if not provided)
    Note: Duty and/or tax may still be calculated internally if required as part of determining the other, but the results will not be included in the response based on the calculation type.
Enum: "duty" "tax" "duty_tax"
Example: calculationType=duty_tax
header Parameters
X-PB-TransactionId
string

A unique Transaction ID provided by the partner, which is used to enable debugging and linking between the client's transaction and the system.Allowed characters limit is 36.

Content-Type
required
string

The media type of the request body.

Value: "application/json"
Request Body schema: application/json
exportCountryCode
required
string [ 2 .. 3 ] characters

The country from which the shipment is exported. This must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., US or USA).

destinationCountryCode
required
string [ 2 .. 3 ] characters

The country to which the shipment is intended. This must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., US or USA).

destinationStateProvince
string = 2 characters

Region code in the country of destination.

  • For countries that require a state or province (CA and BR), if not provided, the default will be:
    • ON for Canada
    • SP for Brazil
serviceId
string

Shipping service type used. Customs processing and related fees can vary between courier shipments and parcels shipped and cleared via the International Postal System. For the most accurate duty and tax estimation, specify the service type related to your shipment

  • Valid values are COURIER and POSTAL.
  • If not provided, COURIER will be used as the default serviceId.
Enum: "COURIER" "POSTAL"
responseCurrencyCode
string = 3 characters

The currency in which the quote should be returned. This must be a valid ISO 4217 currency code

  • Defaults to USD if not provided.
pricingCurrencyCode
required
string = 3 characters

Currency code associated with the amounts passed in the request.

  • Must be a valid ISO 4217 currency code.
required
Array of objects

List of item objects for the quote.

  • Maximum number of items is 200.
shippingAmount
number <float>

The end-to-end shipping cost in the pricing currency.

  • Used in duty and tax calculations for countries that require shipping cost.
  • If not provided, zero will be assumed.
  • Must be 0 or greater.
handlingAmount
number <float>

The handling cost in the pricing currency.

  • Used in duty and tax calculations for countries that require handling cost.
  • If not provided, zero will be assumed.
  • Must be 0 or greater.
insuranceAmount
number <float>

The insurance cost in the pricing currency.

  • Used in duty and tax calculations for countries that require insurance cost.
  • If not provided, zero will be assumed.
  • Must be 0 or greater.
Responses
200

The requested Landed Cost Quote has been retrived successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/crossborder-services/landedCostQuote
Request samples
application/json
{
  • "exportCountryCode": "US",
  • "destinationCountryCode": "CA",
  • "destinationStateProvince": "ON",
  • "serviceId": "COURIER",
  • "responseCurrencyCode": "USD",
  • "pricingCurrencyCode": "USD",
  • "items": [
    ],
  • "shippingAmount": 10,
  • "handlingAmount": 6,
  • "insuranceAmount": 5
}
Response samples
application/json
{
  • "destinationCountryCode": "CA",
  • "destinationStateProvince": "ON",
  • "exportCountryCode": "US",
  • "importationFees": [
    ],
  • "items": [
    ],
  • "messages": [
    ],
  • "responseCurrencyCode": "USD",
  • "serviceId": "COURIER",
  • "totalCharges": {
    }
}