Product HS Code

Search products HS codes.

get

This endpoint is the recommended way to find the correct HS code for what the customer is shipping.

Recommended integration flow:

1. Add a searchable item input in your UI.

2. As the user types, call this endpoint with the typed value.

3. Use the response to populate a dropdown/autocomplete list.

4. Let the user select the best match and save the returned HS code.

5. Send that HS code in boxes.*.items.*.product_hs_code when creating/purchasing shipment.

Important:

• It is strongly advised to use HS codes returned by this API.

• Submitting an HS code that is not recognized in our system will cause shipment validation to fail.

• This is critical because global carriers (for example DHL) require valid HS codes for customs.

Authorizations

AfricaniesAuth

AuthorizationstringRequired

Base64-encoded public_key:private_key value.

Path parameters

valuestringRequired

The search term for products.

Example: smartphone

Header parameters

X-Shipment-Modestring · enumRequired

Required shipment mode. Use SFN for shipping from Nigeria or STN for shipping to Nigeria.

Example: SFNPossible values:

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Product HS code search completed successfully

500Error

application/json

get/api/v1/product/search/{value}

HTTPcURLJavaScriptPython

GET /api/v1/product/search/{value} HTTP/1.1
Host: api-sandbox.africaniestest.com
Authorization: YOUR_API_KEY
X-Shipment-Mode: SFN
Accept: */*

{
  "success": true,
  "status_code": 200,
  "message": "Product HS code search completed successfully",
  "data": [
    {
      "id": 2896,
      "hs_code": "5113000000",
      "name": "Woven fabrics of coarse animal hair or of horsehair.",
      "active": true,
      "deleted_at": null,
      "created_at": "2024-12-17T12:05:32.000000Z",
      "updated_at": null
    }
  ]
}

Verify product.

post

This endpoint verifies whether an HS code is valid and recognized in our system. Use it when you need an explicit validation check before submitting shipment items.

Authorizations

AfricaniesAuth

AuthorizationstringRequired

Base64-encoded public_key:private_key value.

Header parameters

X-Shipment-Modestring · enumRequired

Required shipment mode. Use SFN for shipping from Nigeria or STN for shipping to Nigeria.

Example: SFNPossible values:

Body

application/json

hs_codestringRequired

The HS code of the product to verify.

Example: 0101210000

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Product verified successfully

404Error

application/json

500Error

application/json

post/api/v1/product/verify

HTTPcURLJavaScriptPython

POST /api/v1/product/verify HTTP/1.1
Host: api-sandbox.africaniestest.com
Authorization: YOUR_API_KEY
X-Shipment-Mode: SFN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "hs_code": "0101210000"
}

{
  "success": true,
  "status_code": 200,
  "message": "Product verified successfully",
  "data": {
    "hs_code": "0101210000",
    "valid": true,
    "description": "Live animals; horses, asses, mules and hinnies",
    "category": "Animals"
  }
}

Get products and HS codes.

get

This endpoint retrieves products and their HS code metadata used during shipment creation. HS code selection is required for international shipping and customs processing.

Authorizations

AfricaniesAuth

AuthorizationstringRequired

Base64-encoded public_key:private_key value.

Path parameters

idintegerRequired

Optional parameter. optional The ID of the specific product to retrieve.

Example: {"summary":"When the value is omitted","value":""}

Header parameters

X-Shipment-Modestring · enumRequired

Required shipment mode. Use SFN for shipping from Nigeria or STN for shipping to Nigeria.

Example: SFNPossible values:

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Products HS codes retrieved successfully

500Error

application/json

get/api/v1/product/{id}

HTTPcURLJavaScriptPython

GET /api/v1/product/{id} HTTP/1.1
Host: api-sandbox.africaniestest.com
Authorization: YOUR_API_KEY
X-Shipment-Mode: SFN
Accept: */*

{
  "success": true,
  "status_code": 200,
  "message": "Products HS codes retrieved successfully",
  "data": [
    {
      "id": 2896,
      "hs_code": "5113000000",
      "name": "Woven fabrics of coarse animal hair or of horsehair.",
      "active": true,
      "deleted_at": null,
      "created_at": "2024-12-17T12:05:32.000000Z",
      "updated_at": null
    }
  ]
}