Skip to main content
GET
Search HS Codes

Overview

A sub-merchant with a goods category must declare at least one HS code in global_company.hs_codes, and each code must be one EximPe recognises. This endpoint searches that list by code or by description. Send the value of each code you pick in hs_codes on Create Merchant or Update Merchant.

Query Parameters

Response

data is a page, with the same paging fields as List Merchants. Each result is one HS code:

Errors

Authorizations

X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Query Parameters

Text to match against the code and its description.

page
integer
default:1

Page number. Default 1.

page_size
integer
default:250

Results per page. Default 250, maximum 1000.

Required range: x <= 1000

Response

A page of HS codes.

success
boolean
required
message
string
required
data
object
required