Terminal Shipping API
  • Introduction
  • Example Book Shipment Flow
  • Ship with Code
  • Authentication
  • Errors
  • Libraries & Plugins
  • API ENDPOINTS
  • Addresses
    • Create Address
    • Get Addresses
    • Get Address
    • Update Address
    • Validate Address
    • Set Default Sender Address
    • Get Default Sender Address
  • Carriers
    • Get Carriers
    • Get Carrier
    • Enable Carrier
    • Enable Multiple Carriers
    • Disable Carrier
    • Disable Multiple Carriers
    • Drop-off Locations
  • Claims
    • Get Claims
    • Get Claim
    • File Claim
  • HS Codes
    • Get HSCodes
    • Get HSCode Chapters
    • Get HSCode Categories
    • Get HSCode Details
    • Search HSCodes
  • Insurance
    • Get Insurance
    • Get Insurances List
    • Get Insurance Premium
    • Get Insurance Premium Using Parcel Value
    • Purchase Insurance
  • Packaging
    • Create Packaging
    • Update Packaging
    • Get Packaging
    • Terminal Default Packaging
    • Get Specific Packaging
  • Parcels
    • Create Parcel
    • Update Parcel
    • Get Parcels
    • Get Parcel
  • Rates
    • Get Rates for Shipment
    • Get Quotes for Shipment
    • Get Rates for Multi-Parcel Shipment
    • Get Rates
    • Get Rate
  • Simplified HS Codes
    • Get Simplified HSCodes
    • Get Simplified HSCode Chapters
    • Get Simplified HSCode Categories
    • Get Simplified HSCode Details
    • Search Simplified HSCodes
  • Shipments
    • Create Shipment
    • Create Quick Shipment
    • Update Shipment
    • Get Shipments
    • Get Shipments v2
    • Get Shipment
    • Track a Shipment
    • Cancel Shipment
    • Delete Shipment
    • Duplicate Shipment
    • Arrange Pickup & Delivery for Shipment
  • Transactions
    • Get Transactions
    • Get Transaction
  • Users
    • Get User
    • Get Wallet Info
    • Get Wallet Balance
    • Get User Carriers
  • Webhooks
    • Create Webhook
    • Delete Webhook
    • Disable Webhook
    • Enable Webhook
    • Get Webhooks
    • Get Webhook
  • MISCALLANEOUS
    • Carriers Available
    • Carrier Object
    • Cities
    • Countries
    • File Claim Object
    • Parcel Item
    • Quick Shipments
      • Parcel
      • Pickup / Delivery Address
    • Shipment Events
    • Shipment Extras
    • States
    • Webhook Events
      • Handling Webhook Events
    • Volumetric Weight
Powered by GitBook
On this page

Was this helpful?

  1. HS Codes

Search HSCodes

Search from the list of HS Codes available

/hs-codes/search/query

GET https://api.terminal.africa/v1/hs-codes/search/query

This endpoint allows you to search from the list of all hs codes available.

Query Parameters

Name
Type
Description

perPage

Number

Specify how many records will be sent in a single response. Defaults to 100.

page

Number

Specify what page of records will be sent in response. Defaults to 1.

query_string*

String

Query to search

Headers

Name
Type
Description

Authorization*

String

Set value to Bearer SECRET_KEY

{
    "status": true,
    "message": "Search results",
    "data": {
        "hs_codes": [
            {
                "_id": "641d65dfd1b41ab967641c9b",
                "chapter": "35",
                "category": "Casein, caseinates and other casein derivatives; casein glues (excl. those packaged as glue for retail sale and weighing net <= 1 kg)",
                "category_code": "3501",
                "sub_category": "Casein for the manufacture of artificial textile fibres",
                "hs_code": "35011010",
                "hs_code_id": "HS-58166557317",
                "__v": 0,
                "id": "641d65dfd1b41ab967641c9b"
            },
            {
                "_id": "641d65dfd1b41ab967641c9c",
                "chapter": "35",
                "category": "Casein, caseinates and other casein derivatives; casein glues (excl. those packaged as glue for retail sale and weighing net <= 1 kg)",
                "category_code": "3501",
                "sub_category": "Casein for industrial uses (excl. the manufacture of foodstuffs or fodder and artificial textile fibres)",
                "hs_code": "35011050",
                "hs_code_id": "HS-52565243769",
                "__v": 0,
                "id": "641d65dfd1b41ab967641c9c"
            },
            {
                "_id": "641d65dfd1b41ab967641c9d",
                "chapter": "35",
                "category": "Casein, caseinates and other casein derivatives; casein glues (excl. those packaged as glue for retail sale and weighing net <= 1 kg)",
                "category_code": "3501",
                "sub_category": "Casein for the manufacture of foodstuffs and fodder and other types of casein (excl. the manufacture of artificial textile fibres and other industrial uses)",
                "hs_code": "35011090",
                "hs_code_id": "HS-04289043889",
                "__v": 0,
                "id": "641d65dfd1b41ab967641c9d"
            }
        ],
        "pagination": {
            "page": 1,
            "perPage": 100,
            "prevPage": null,
            "nextPage": null,
            "currentPage": 1,
            "total": 28,
            "pageCount": 1,
            "pagingCounter": 1,
            "hasPrevPage": false,
            "hasNextPage": false
        }
    }
}

PreviousGet HSCode DetailsNextInsurance

Last updated 1 year ago

Was this helpful?