Access detailed information about available API endpoints and how to use them.

Location: Sidebar → API Documentation

All API requests must include an API key in the request headers.

Header – Description

Authorization: Bearer {api_key} – Required for authenticating API requests.

Errors:

• 401 – Missing or invalid API key

• 403 – Access forbidden due to insufficient permissions

API requests are limited to prevent abuse.

Details:

• Default limit: 60 requests per minute

• If exceeded, you will receive:

{

 "success": false,

 "message": "Too many requests."

}

All responses follow a standard structure:

{

 "success": true,

 "message": "",

 "data": {

   // response data

 }

}

The API provides multiple endpoints grouped by modules.

Modules Include:

• Products

• Inventory

• Categories

• Brands

• Orders

• Customers

• Suppliers

• Warehouses

• Returns

• Reports

• Transactions

• Users

• Settings

Each endpoint includes:

Field – Description

• Method – HTTP method (GET, POST, PUT, DELETE)

•  URL – API endpoint path

•  Parameters – Required and optional request parameters

•  Description – Purpose of the endpoint

curl -X GET "https://your-domain.com/api/products" \

 -H "Authorization: Bearer {api_key}"

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/api/products', [

   'headers' => [

       'Authorization' => 'Bearer YOUR_API_KEY',

   ],

]);

echo $response->getBody();