Search by Description

This service searches through HS code descriptions based on a given keyword and returns matching HS code records. It helps access the correct HS code by searching through product names or description contents.

Endpoint Information

Property	Value
URL	`{{APP_URL}}/api/v1/gtip/search/description/{keyword}`
HTTP Method	`GET`
Content Type	`application/json`
Authentication	`APIKEY` header

Request Parameters

Path Parameters

Parameter Name	Parameter Type	Required	Description
`keyword`	String	Required	Keyword to search (the keyword must appear in the description).

Example Usage

API Request

In this example, the word "trout" is searched in HS code descriptions and all HS codes related to trout are returned.

GET {{APP_URL}}/api/v1/gtip/search/description/trout
Content-Type: application/json
APIKEY: {{APIKEY}}

API Response

{
    "status": true,
    "message": null,
    "data": [
        {
            "id": "1277",
            "code": "030314",
            "description": "Balıklar (dondurulmuş)  (0304 pozisyonundaki balık filetoları ve > Alabalıklar  Salmo trutta, Oncorhynchus mykiss, Oncorhynchus clarki, Oncorhynchus aguabonita, Oncorhynchus gilae, Oncorhynchus  apache ve Oncorhynchus chrysogaster",
            "description_en": "Fish (frozen) (excluding fish fillets and other fish meat of heading 0304) > Trout Salmo trutta, Oncorhynchus mykiss, Oncorhynchus clarki, Oncorhynchus aguabonita, Oncorhynchus gilae, Oncorhynchus apache and Oncorhynchus chrysogaster:"
        },
        {
            "id": "1504",
            "code": "030442",
            "description": "Balık filetoları ve diğer balık etleri (kıyılmış olsun olmasın) (taze, > Alabalık  Salmo trutta, Oncorhynchus mykiss, Oncorhynchus clarki, Oncorhynchus aguabonita, Oncorhynchus gilae, Oncorhynchus apache ve Oncorhynchus chrysogaster :",
            "description_en": "Fish fillets and other fish meat (whether or not minced) (fresh, > Trout Salmo trutta, Oncorhynchus mykiss, Oncorhynchus clarki, Oncorhynchus aguabonita, Oncorhynchus gilae, Oncorhynchus apache and Oncorhynchus chrysogaster:"
        }
        // Other results...
    ]
}

Note: The keyword in the description field is searched case-insensitively. Matching records are listed in the data field. Response Summary: For all products where the keyword appears in the HS code description, the relevant codes and definitions are listed. Descriptions are provided in both Turkish and English.

Error Responses

{
    "status": false,
    "errors": [
        {
            "message": "invalid description data"
        }
    ]
}