GET api/v1/HSCodesMaster?search={search}&sort={sort}

Retrieves an array of HS Codes based on the criteria.

Request Information

Parameters

NameDescriptionAdditional information
search 
HS code or name. Minimum length is 3 characters. (required)

Define this parameter in the request URI.
sort 
Field to sort on; prepend + or - to indicate ascending or descending (optional)

Define this parameter in the request URI.

Response Information

Response body formats

application/json

Sample: 
[
  {
    "HSCode": "sample string 1",
    "CargoName": "sample string 1 - sample string 2",
    "CargoGroup": 3
  },
  {
    "HSCode": "sample string 1",
    "CargoName": "sample string 1 - sample string 1 - sample string 2",
    "CargoGroup": 3
  },
  {
    "HSCode": "sample string 1",
    "CargoName": "sample string 1 - sample string 1 - sample string 1 - sample string 2",
    "CargoGroup": 3
  }
]

text/json

Sample: 
[
  {
    "HSCode": "sample string 1",
    "CargoName": "sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 2",
    "CargoGroup": 3
  },
  {
    "HSCode": "sample string 1",
    "CargoName": "sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 2",
    "CargoGroup": 3
  },
  {
    "HSCode": "sample string 1",
    "CargoName": "sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 2",
    "CargoGroup": 3
  }
]

application/xml

Sample: 
<ArrayOfHarmonizedSystemMasterDTO>
  <HarmonizedSystemMasterDTO>
    <HSCode>sample string 1</HSCode>
    <CargoName>sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 2</CargoName>
    <CargoGroup>3</CargoGroup>
  </HarmonizedSystemMasterDTO>
  <HarmonizedSystemMasterDTO>
    <HSCode>sample string 1</HSCode>
    <CargoName>sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 2</CargoName>
    <CargoGroup>3</CargoGroup>
  </HarmonizedSystemMasterDTO>
  <HarmonizedSystemMasterDTO>
    <HSCode>sample string 1</HSCode>
    <CargoName>sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 2</CargoName>
    <CargoGroup>3</CargoGroup>
  </HarmonizedSystemMasterDTO>
</ArrayOfHarmonizedSystemMasterDTO>

text/xml

Sample: 
<ArrayOfHarmonizedSystemMasterDTO>
  <HarmonizedSystemMasterDTO>
    <HSCode>sample string 1</HSCode>
    <CargoName>sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 2</CargoName>
    <CargoGroup>3</CargoGroup>
  </HarmonizedSystemMasterDTO>
  <HarmonizedSystemMasterDTO>
    <HSCode>sample string 1</HSCode>
    <CargoName>sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 2</CargoName>
    <CargoGroup>3</CargoGroup>
  </HarmonizedSystemMasterDTO>
  <HarmonizedSystemMasterDTO>
    <HSCode>sample string 1</HSCode>
    <CargoName>sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 1 - sample string 2</CargoName>
    <CargoGroup>3</CargoGroup>
  </HarmonizedSystemMasterDTO>
</ArrayOfHarmonizedSystemMasterDTO>