Lookup Tariff Codes

---

The purpose of this endpoint is to provide the HS Tariff code information for the EAD PreCom portal users to comply with the ICS2 Tariff Code requirements.

The EAD PreCom application requires HS code information for declarations to specific countries. If the destination country is not IE or is null or empty, the API will return 6-digits HS codes. However, if the destination country is Ireland (IE), the API will return 10-digit HS tariff data as per the current requirements.

URLs:

UAT: https://api.uat.nzpost.co.nz/lookup-tariff-codes/v1/fetch-codes/ead/{records}?destination_country=%destination_country%
PROD: https://api.nzpost.co.nz/lookup-tariff-codes/v1/fetch-codes/ead/{records}?destination_country=%destination_country%

Where,
- {records} is the URI parameter and the value for this is either all or the first
- Here all means, the URL returns all the Product tariff details, and first means this call returns only the first Product tariff details
- destination_country is the Query parameter  and the  value is a  two-digit country code EX: IE  or Null or empty

Process overview:

1. The user sends products-description as input with URI parameter{records} and query parameter destination_country in the URL

2. API will check for destination_country,

   • When destination_country is an EAD-supported country (for example Ireland (IE)) then API will return a response with 10-digit import codes.
     • If URI parameter {records} is set to 'first', API will return top first matching HS Tariff code details.
     • If URI parameter{records} is set to 'all', API will return all top five matching HS code alternates in the in the response.
   • When destination_country is not an EAD-supported country or NULL or Empty then API will return the products with 6-digits HS codes.
     • If URI parameter{records} is set to 'first', API will return top first matching HS Tariff codes.
     • If URI parameter {records} is set to 'all', API will return all top five matching HS code alternates in the in the response.

Input Fields

Below is the table detailing the fields used in this endpoint call requests:

Field Name	Data Type	Restrictions	Required?	Notes
consignmentId	string		optional	The ID used by the client to tie back to the consignment being checked. This field is optional but User can use this field to supply a unique identification value for tracking the request and responses. Examples: barcode or tracking_id or consignment_id etc.
destinationCountry	string	ANSI 2 char	required	The ANSI 2-character code for the country the item is being sent to, as defined by ISO3166 If this is missing, the 10-digit import code will be null in the response.
overrideTranslation	boolean		optional	API will attempt to translate any inbound product description for the purposes of matching. This translation is based on the UPU guidelines for translation. We check in English, French, destination country and additionally source country languages. If set true , the system assumes all descriptions do not require translation and will be in English. If omitted then true will be assumed.
products	Array		required	At this stage there will only be 1 product per call
… description	string		optional if hs6code provided otherwise required	The client description of the product
… hs6code	string		optional if description provided otherwise required	The client-supplied HS6 code. If the HS6 code and description appear not to match then the HS6 code will take precedence for the call. If a code longer than 6 digits is supplied, then we will trim to 6 digits prior to processing
… originatingCountry	string	ANSI 2 char	optional	The ANSI 2-character code for the country the item was produced in, as defined by ISO3166. This will only have an impact on certain import and export control codes.
showOptions	boolean		optional	If true API will return the top matches used for the call, in order of likelihood. If omitted then false will be assumed.
showOriginalCodes	boolean		optional	When returning the 10-digit import and export codes API will pad a code less than 10 digits long (i.e. 12345678 becomes 1234567800) or trim one longer than 10 digits (12345678901 becomes 1234567890). If this is set to true then API will return two additional fields in the response that have the original length codes in them. The original codes may be 6,8,9,10,11 digits long depending on the country and their particular tariff schema. Note: these may still be 10 digits if that is all that was available. If omitted then false will be assumed.
sourceCountry	string	ANSI 2 char	required	The ANSI 2-character code for the country the item is being sent from, as defined by ISO3166. If this is missing, the 10-digit export code will be null in the response.

---

Explore the API End Point