Get Favorite HSCodes

Fetch available Favorite HSCodes

/hs-codes/favorites

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

This endpoint allows you to fetch lists of your saved favorite hscodes

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.

Headers

Name	Type	Description
Authorization*	String	Set value to Bearer SECRET_KEY

200 results

{
    "status": true,
    "message": "Favorite HS codes retrieved successfully",
    "data": {
        "favorite_hs_codes": [
            {
                "_id": "6902f29f204e8b727137f832",
                "user": "USER-0123456789",
                "description": "test",
                "hs_code": "12756789090",
                "hs_code_id": "HS-2IPPUANWJI5EJ6K3",
                "created_at": "2025-10-30T05:07:43.554Z",
                "updated_at": "2025-10-30T05:07:43.554Z",
                "__v": 0,
                "id": "6902f29f204e8b727137f832"
            },
            {
                "_id": "6904e0ced015caecd23f308f",
                "user": "USER-0123456789",
                "description": "Fish",
                "hs_code": "12756789090",
                "hs_code_id": "HS-XXVNQ5K52LUH78CO",
                "created_at": "2025-10-31T16:16:14.928Z",
                "updated_at": "2025-10-31T16:16:14.928Z",
                "__v": 0,
                "id": "6904e0ced015caecd23f308f"
            },
            {
                "_id": "691b14afc977a6c47c618e16",
                "user": "USER-0123456789",
                "description": "Apple MacBook Pro 14-inch M4",
                "hs_code": "8471302000",
                "hs_code_id": "HS-AALSBCOF6N23F1B0",
                "created_at": "2025-11-17T12:27:27.863Z",
                "updated_at": "2025-11-17T12:44:54.505Z",
                "__v": 0,
                "id": "691b14afc977a6c47c618e16"
            }
        ],
        "pagination": {
            "page": 1,
            "perPage": 50,
            "prevPage": null,
            "nextPage": null,
            "currentPage": 1,
            "total": 3,
            "pageCount": 1,
            "pagingCounter": 1,
            "hasPrevPage": false,
            "hasNextPage": false
        }
    }
}