Product

Get product categories.

get

This endpoint retrieves product categories.

Path parameters

idintegerRequired

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

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

Header parameters

X-Shipment-ModestringOptionalExample: SFN

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Product categories retrieved successfully

500Error

application/json

get

/api/v1/product/categories/{id}

HTTPcURLJavaScriptPython

GET /api/v1/product/categories/{id} HTTP/1.1
Host: api-sandbox.africaniestest.com
Accept: */*

{
  "success": true,
  "status_code": 200,
  "message": "Product categories retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Electronics",
      "description": "Electronic devices and accessories",
      "active": true
    }
  ]
}

Search products.

get

This endpoint searches for products.

Path parameters

valuestringRequired

The search term for products.

Example: smartphone

Header parameters

X-Shipment-ModestringOptionalExample: SFN

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Product 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
Accept: */*

{
  "success": true,
  "status_code": 200,
  "message": "Product search completed successfully",
  "data": [
    {
      "id": 1,
      "name": "Smartphone",
      "description": "Latest smartphone model",
      "price": 599.99,
      "active": true
    }
  ]
}

Verify product.

post

This endpoint verifies a product using its HS code.

Header parameters

X-Shipment-ModestringOptionalExample: SFN

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
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.

get

This endpoint retrieves products.

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-ModestringOptionalExample: SFN

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Products retrieved successfully

500Error

application/json

get

/api/v1/product/{id}

HTTPcURLJavaScriptPython

GET /api/v1/product/{id} HTTP/1.1
Host: api-sandbox.africaniestest.com
Accept: */*

{
  "success": true,
  "status_code": 200,
  "message": "Products retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Smartphone",
      "description": "Latest smartphone model",
      "price": 599.99,
      "active": true
    }
  ]
}