Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Hurricane Services

Quoted Landed Cost

Calculate and provide a detailed breakdown of the landed costs associated with international shipments. <br />The landed cost includes not only the price of goods but also shipping charges, duties, taxes, and any additional costs for dutiable shipments. <br />This API is important to understand the total cost of shipping items internationally before proceeding with a transaction.

post/v4/QuotedLandedCost

Request body

ShippingAccountIdstring nullable

A unique identifier for the shipping account, which can either be generated by the system or provided by you (alias) during shipping account creation. <br />This ID helps associate the request with a specific shipping account.

Example request

{
  "ShippingAccountId": "453",
  "Shipment": {
    "Reference": "ABC1234",
    "ConvertCurrency": true,
    "Shipper": {
      "CountryCode": "GB",
      "Currency": "GBP",
      "Postcode": "GU11 1AX"
    },
    "Destination": {
      "CountryCode": "US"
    },
    "ShippingCharges": 23.75,
    "DeclaredWeight": 3000
  },
  "Items": [
    {
      "SkuCode": "BWPC123",
      "HSCode": "340120",
      "Description": "BABY WIPES",
      "CountryOfOrigin": "CN",
      "Value": 2.39,
      "Quantity": 10,
      "Weight": 250
    }
  ]
}

Response

Returns quoted landed cost response.

ShippingAccountIdstring nullable

The unique identifier for the shipping account used in the request, returned for confirmation of the matched account. <br />
<br /><b>Note:</b> If an empty value was sent in the request, then this field will return as blank.

IsErrorboolean

A boolean indicating whether an error occurred during the request processing. It helps users quickly identify if there was an issue with their request. <br /> <br /><b>Note:</b> This field returns true only if the requested root elements generated an error, indicating that Hurricane cannot process the request.

ErrorDescriptionstring nullable

A description of the error during the request (if encountered), providing insights into what went wrong and how it can be addressed.

Notesstring nullable

Additional information returned by the system containing any notes or notifications, for example, further details on the error or notes about forthcoming changes on duty rates.

GeneratedDatestring nullable

A timestamp in Coordinated Universal Time (UTC) returned by Hurricane, indicating when the call was performed, aiding in tracking and logging activities.

Example response

{
  "ShippingAccountId": "453",
  "Shipment": {
    "Reference": "REF1234567890",
    "Shipper": {
      "CountryCode": "GB",
      "Currency": "GBP",
      "Postcode": "GU11 1AX",
      "ShippingCharges": 19.93,
      "DeclaredValue": 734.9,
      "TotalDuty": 22,
      "TotalTax": 146.9,
      "TotalIncludingTaxes": 923.73
    },
    "Destination": {
      "CountryCode": "US",
      "Currency": "USD",
      "Postcode": "23100",
      "ShippingCharges": 23.45,
      "DeclaredValue": 864.6,
      "TotalDuty": 26,
      "TotalTax": 172.9,
      "TotalIncludingTaxes": 1086.95
    },
    "Currency": {
      "ConvertCurrency": true,
      "CurrencyExchange": "GBP: USD",
      "ExchangeRate": 0.85,
      "RateLastUpdated": "2019-07-15T00:00:00Z"
    }
  },
  "Items": [
    {
      "HS6Code": "330491",
      "Description": "GENTLE BABY WIPES",
      "10digitExportHsCode": "3304910000",
      "10digitImportHsCode": "3304910000",
      "CountryOfOrigin": "CN",
      "HurricaneDescription": "BABY WIPES",
      "PercentageDutyRate": 3,
      "VolumetricDutyRate": 2,
      "ItemDutyRate": 2,
      "TaxRate": 20,
      "ShipperCurrencyValues": {
        "ItemValue": 32.47,
        "ItemDuty": 0.97,
        "ItemTax": 6.49,
        "ItemTotalIncludingTaxes": 39.93
      },
      "DestinationCurrencyValues": {
        "ItemValue": 38.2,
        "ItemDuty": 1.15,
        "ItemTax": 7.64,
        "ItemTotalIncludingTaxes": 46.99
      },
      "IsError": true,
      "ErrorDescription": "The item is subject to an additional excise duty payment, based on individual rules by the type of product, percentage of alcohol for example, and is not currently supported by Hurricane's solution."
    }
  ],
  "IsError": true,
  "ErrorDescription": "Postcode is invalid",
  "GeneratedDate": "2019-02-12T15:27:01Z"
}