--- title: "Prohibited Items" method: POST path: "/v4/ProhibitedItems" tags: ["Hurricane Services"] --- # Prohibited Items `POST /v4/ProhibitedItems` 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.
This API helps ensure compliance with international trade laws by identifying items that cannot legally cross borders, thereby preventing legal issues and shipment delays. ## Request body - ProhibitedItemsRequest — Prohibited Items Request - `ShippingAccountId` string, 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.
This ID helps associate the request with a specific shipping account. - `Shipment` ProhibitedItemsShipment, required — The shipment subjected to the commodity code validation, allowing the user to provide details about the entire shipment for validation. - `Reference` string, nullable — A reference string that is used to trace the response of the request.
This allows users to keep track of their requests and facilitates easier follow-up if needed. - `ShipperCountryCode` string, required — An abbreviation representing the shipment origin country, following the ISO 3166-1 alpha-2 standard, for example, "GB" for the United Kingdom. - `DestinationCountryCode` string, required — An abbreviation representing the destination country, following the ISO 3166-1 alpha-2 standard, for example, "US" for the United States of America. - `ReturnRestrictionCodes` boolean, nullable — If set to true, the response returns an array of import, export, and transport codes indicating any return restrictions associated with the shipment, providing additional context for compliance checks.

*Note: By default, this field is set to false.* - `Items` ProhibitedItemsItem[], required — A collection of items for which the user wants to validate their HS codes, allowing for multiple items to be checked in a single request.

Before sending the request, make sure of the following conditions:


*Note: For better performance, it is recommended to send 10 items or less in a single request.* - `SkuCode` string, nullable — A unique Stock Keeping Unit (SKU) code assigned to the item.
This code is essential for tracking inventory, helping users identify specific items easily. - `HSCode` string, required — The Harmonized System (HS) code used by customs to determine potential duties and taxes for the product.
This code can be 6, 8, or 13 alphanumeric characters, depending on specific services or destinations.
Some countries may use HS codes with different character lengths, such as 10 or 12 characters.

Note: The HSCode or Description must be provided. If both are supplied, and they do not match for the same product, then only the HSCode will take precedence.
Characters like space and dot are supported.

For more information on the HS Codes see > https://www.gov.uk/trade-tariff - `Description` string, nullable — A detailed description of the item being shipped, which helps verify that the HS code provided is appropriate for the nature of the item.

Note: The HSCode or Description must be provided.
If both are supplied, and they do not match for the same product, then only the HSCode will take precedence. ## Response `200` Returns prohibited items response. - ProhibitedItemsResponse — Prohibited Items Response - `ShippingAccountId` string, nullable — The unique identifier for the shipping account used in the request, returned for confirmation of the matched account.

*Note: If an empty value was sent in the request, then this field will return as blank.* - `Shipment` ProhibitedItemsShipmentResponse — The shipment object returned in the response, reflecting the processed shipment details. - `Reference` string, nullable — A reference string that is used to trace the response of the request.
This allows users to keep track of their requests and facilitates easier follow-up if needed.

*Note: If an empty value was sent in the request, then this field will return as blank.* - `Items` ProhibitedItemsItemResponse[], nullable — An array of items included in the shipment that need to be evaluated for prohibitions against import, export, or transport. - `HS6Code` string, nullable — The trimmed down 6-digit HS code used by Hurricane for classification, reflecting the higher-level categorisation of the item for validation.

Note: If an empty value was sent in the request, then this field will return as blank. - `Description` string, nullable — The description of each item returned in the response, confirming the information submitted for validation.

Note: If an empty value was sent in the request, then this field will return as blank. - `10DigitExportHSCode` string, nullable — The most likely 10-digit HS code that should be used for exporting the item from the source country, reflecting required customs codes. - `10DigitImportHSCode` string, nullable — The most likely 10-digit HS code to be followed for importing the item into the destination country, which is essential for compliance with import regulations. - `RestrictionCodes` ProhibitedItemsRestrictionCodes — A collection of import, export, or transport codes that outline specific restrictions applicable to each item, providing clarity on what is prohibited.

*Note: This information is only populated if in the request, the ReturnRestrictionCodes field was set to true. The description of each code can be found in our API documentation.* - `ExportCode` string[], nullable — An array of specific codes indicating any export restrictions related to the item, essential for compliance verification during shipping. - `TransportCode` string[], nullable — An array of specific codes indicating any transportation restrictions associated with the item, important for logistics and shipping planning. - `ImportCode` string[], nullable — An array of specific codes identifying any import restrictions for the item, which is critical for customs compliance. - `Prohibited` boolean — A boolean value indicating whether the item is prohibited for import, export, or transport for the details provided in the request. - `IsError` boolean — A boolean indicating whether an error occurred during item processing. It helps users quickly identify if there was an issue with the item.

Note: If the item is successfully processed by Hurricane, then this value is returned as false.
In case an error has been returned by Hurricane, then the information about the error will be provided in the ErrorDescription field. - `ErrorDescription` string, nullable — A description of the error associated with the item (if encountered), providing insights into what went wrong and how it can be addressed. - `IsError` boolean — A boolean indicating whether an error occurred during the request processing. It helps users quickly identify if there was an issue with their request.

Note: This field returns true only if the requested root elements generated an error, indicating that Hurricane cannot process the request. - `ErrorDescription` string, nullable — A description of the error during the request (if encountered), providing insights into what went wrong and how it can be addressed. - `Notes` string, 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. - `GeneratedDate` string, nullable — A timestamp in Coordinated Universal Time (UTC) returned by Hurricane, indicating when the call was performed, aiding in tracking and logging activities. ## Other responses - `400` — Invalid request response. - `401` — Unauthorized - `403` — Forbidden - `500` — Internal Server Error --- [API](https://skmtc.dev/intersoftsapient/apis/sapient-core-api.md) · [All operations](https://skmtc.dev/intersoftsapient/apis/sapient-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intersoftsapient/sapient-core-api/revisions/3315ad0b5875/schema)