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

Get HSCodes

Fetch list of HS Codes available

/hs-codes

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

This endpoint allows you to get a 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.

chapter

String

Specify what hs code chapter to return. Defaults to all. Currently supports up to 97 chapters

category_code

String

Specify what hs code category code to be returned

hs_code

String

Specify what group of hs code to be returned

Headers

Name
Type
Description

Authorization*

String

Set value to Bearer SECRET_KEY

{
    "status": true,
    "message": "Hs codes retrieved successfully",
    "data": {
        "hs_codes": [
            {
                "_id": "641d65dfd1b41ab967642832",
                "chapter": "90",
                "category": "Optical fibres and optical fibre bundles; optical fibre cables (excl. made up of individually sheathed fibres of heading 8544); sheets and plates of polarising material; lenses, incl. contact lenses, prisms, mirrors and other optical elements of any material, unmounted (excl. such elements of glass not optically worked)",
                "category_code": "9001",
                "sub_category": "Optical fibres, optical fibre bundles and cables (excl. made up of individually sheathed fibres of heading 8544)",
                "hs_code": "900110",
                "hs_code_id": "HS-91033501933",
                "__v": 0,
                "id": "641d65dfd1b41ab967642832"
            },
            {
                "_id": "641d65dfd1b41ab967642833",
                "chapter": "90",
                "category": "Optical fibres and optical fibre bundles; optical fibre cables (excl. made up of individually sheathed fibres of heading 8544); sheets and plates of polarising material; lenses, incl. contact lenses, prisms, mirrors and other optical elements of any material, unmounted (excl. such elements of glass not optically worked)",
                "category_code": "9001",
                "sub_category": "Image conductor cables of optical fibres (excl. cables made up of individually sheathed fibres of heading 8544)",
                "hs_code": "90011010",
                "hs_code_id": "HS-39846437965",
                "__v": 0,
                "id": "641d65dfd1b41ab967642833"
            },
            {
                "_id": "641d65dfd1b41ab967642834",
                "chapter": "90",
                "category": "Optical fibres and optical fibre bundles; optical fibre cables (excl. made up of individually sheathed fibres of heading 8544); sheets and plates of polarising material; lenses, incl. contact lenses, prisms, mirrors and other optical elements of any material, unmounted (excl. such elements of glass not optically worked)",
                "category_code": "9001",
                "sub_category": "Optical fibres, optical fibre bundles and cables (excl. made up of individually sheathed fibres of heading 8544 and image conductor cables)",
                "hs_code": "90011090",
                "hs_code_id": "HS-14513435157",
                "__v": 0,
                "id": "641d65dfd1b41ab967642834"
            },
            {
                "_id": "641d65dfd1b41ab967642835",
                "chapter": "90",
                "category": "Optical fibres and optical fibre bundles; optical fibre cables (excl. made up of individually sheathed fibres of heading 8544); sheets and plates of polarising material; lenses, incl. contact lenses, prisms, mirrors and other optical elements of any material, unmounted (excl. such elements of glass not optically worked)",
                "category_code": "9001",
                "sub_category": "Sheets and plates of polarising material",
                "hs_code": "90012000",
                "hs_code_id": "HS-48789662202",
                "__v": 0,
                "id": "641d65dfd1b41ab967642835"
            },
            {
                "_id": "641d65dfd1b41ab967642836",
                "chapter": "90",
                "category": "Optical fibres and optical fibre bundles; optical fibre cables (excl. made up of individually sheathed fibres of heading 8544); sheets and plates of polarising material; lenses, incl. contact lenses, prisms, mirrors and other optical elements of any material, unmounted (excl. such elements of glass not optically worked)",
                "category_code": "9001",
                "sub_category": "Contact lenses",
                "hs_code": "90013000",
                "hs_code_id": "HS-47812076456",
                "__v": 0,
                "id": "641d65dfd1b41ab967642836"
            }
        ],
        "pagination": {
            "page": 1,
            "perPage": 5,
            "prevPage": null,
            "nextPage": 2,
            "currentPage": 1,
            "total": 70,
            "pageCount": 14,
            "pagingCounter": 1,
            "hasPrevPage": false,
            "hasNextPage": true
        }
    }
}

PreviousHS CodesNextGet HSCode Chapters

Last updated 1 year ago

Was this helpful?