Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Hurricane Services

Prohibited Items

Check whether specific items in a shipment are prohibited for import, export, or transport based on the regulations related to the shipper's and destination countries. <br /> This API helps ensure compliance with international trade laws by identifying items that cannot legally cross borders, thereby preventing legal issues and shipment delays.

post/v4/ProhibitedItems

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",
    "ShipperCountryCode": "GB",
    "DestinationCountryCode": "US"
  },
  "Items": [
    {
      "SkuCode": "BWPC123",
      "HSCode": "340120",
      "Description": "BABY WIPES"
    }
  ]
}

Response

Returns prohibited items 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": "ABC1234"
  },
  "Items": [
    {
      "HS6Code": "340120",
      "Description": "BABY WIPES",
      "10DigitExportHSCode": "8525500000",
      "10DigitImportHSCode": "8525500000"
    }
  ],
  "IsError": true,
  "ErrorDescription": "The Destination Country doesn't exist",
  "GeneratedDate": "2019-02-12T15:27:01Z"
}