Suppliers API

Get All Suppliers

Retrieve a list of all suppliers with optional filtering and pagination.

curl -X GET "https://cemac-api.vercel.app/suppliers?search=&isActive=true&page=1&limit=50" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Authentication: Required (Bearer Token) Method: GET Endpoint: /suppliers

Query Parameters

string

Search term to filter suppliers by name or contact

isActive

boolean

Filter by active status (true/false)

page

number

Page number for pagination

limit

number

Number of suppliers per page

Response

success

boolean

Indicates if the request was successful

suppliers

array

Array of supplier objects

Show Supplier object properties

string

Unique supplier identifier

name

string

Supplier’s business name

description

string

Description of the supplier’s business

contactName

string

Primary contact person name

string

Supplier’s email address

phone

string

Supplier’s phone number

address

string

Supplier’s physical address

productCount

number

Number of products from this supplier

isActive

boolean

Whether the supplier is active

createdAt

string

ISO 8601 timestamp of creation

updatedAt

string

ISO 8601 timestamp of last update

createdBy

string

User ID who created the supplier

total

number

Total number of suppliers

message

string

Response message

Create Supplier

Create a new supplier.

curl -X POST https://cemac-api.vercel.app/suppliers \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Tech Distributors Inc.",
    "description": "Leading technology product distributor",
    "contactName": "Jane Smith",
    "email": "[email protected]",
    "phone": "+1-555-0123",
    "address": "789 Business Blvd, Tech City, TC 54321"
  }'

Authentication: Required (Bearer Token) Method: POST Endpoint: /suppliers

Request Body

name

string

required

Supplier’s business name (max 100 characters)

description

string

Description of the supplier (max 500 characters)

contactName

string

Primary contact person name (max 100 characters)

string

Supplier’s email address (valid email format)

phone

string

Supplier’s phone number (max 20 characters)

address

string

Supplier’s physical address (max 500 characters)

Response

success

boolean

Indicates if the supplier was created successfully

supplier

object

Created supplier object

message

string

Success message

Update Supplier

Update an existing supplier’s information.

curl -X PUT https://cemac-api.vercel.app/suppliers/SUPPLIER_ID \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Tech Distributors Global",
    "description": "Global technology product distributor",
    "contactName": "Jane Doe",
    "email": "[email protected]",
    "phone": "+1-555-9999",
    "address": "999 Global Plaza, Tech City, TC 54321",
    "isActive": true
  }'

Authentication: Required (Bearer Token) Method: PUT Endpoint: /suppliers/{supplierId}

Path Parameters

supplierId

string

required

Unique identifier of the supplier

Request Body

name

string

Updated supplier name (max 100 characters)

description

string

Updated description (max 500 characters)

contactName

string

Updated contact name (max 100 characters)

string

Updated email address

phone

string

Updated phone number (max 20 characters)

address

string

Updated address (max 500 characters)

isActive

boolean

Updated active status

Response

success

boolean

Indicates if the supplier was updated successfully

supplier

object

Updated supplier object

message

string

Success message

Delete Supplier

Delete a supplier from the system.

curl -X DELETE https://cemac-api.vercel.app/suppliers/SUPPLIER_ID \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Authentication: Required (Bearer Token) Method: DELETE Endpoint: /suppliers/{supplierId}

Path Parameters

supplierId

string

required

Unique identifier of the supplier to delete

Response

success

boolean

Indicates if the supplier was deleted successfully

supplierId

string

ID of the deleted supplier

message

string

Success message

Get Supplier Statistics

Retrieve detailed statistics for a specific supplier.

curl -X GET https://cemac-api.vercel.app/suppliers/SUPPLIER_ID/stats \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Authentication: Required (Bearer Token) Method: GET Endpoint: /suppliers/{supplierId}/stats

Path Parameters

supplierId

string

required

Unique identifier of the supplier

Response

success

boolean

Indicates if the request was successful

supplier

object

Supplier details

stats

object

Supplier statistics

Show Statistics properties

productCount

number

Total number of products

activeProducts

number

Number of active products

limitedProducts

number

Number of products with limited stock

unlimitedProducts

number

Number of products with unlimited stock

totalStock

number

Total stock quantity across all products

lowStockProducts

number

Number of products with low stock

averagePrice

number

Average price of products from this supplier

message

string

Response message

Overview

Endpoints

Suppliers API

Get All Suppliers

Query Parameters

Response

Create Supplier

Request Body

Response

Update Supplier

Path Parameters

Request Body

Response

Delete Supplier

Path Parameters

Response

Get Supplier Statistics

Path Parameters

Response

Build docs developers (and LLMs) love

Overview

Endpoints

​Get All Suppliers

​Query Parameters

​Response

​Create Supplier

​Request Body

​Response

​Update Supplier

​Path Parameters

​Request Body

​Response

​Delete Supplier

​Path Parameters

​Response

​Get Supplier Statistics

​Path Parameters

​Response

Build docs developers (and LLMs) love

Get All Suppliers

Query Parameters

Response

Create Supplier

Request Body

Response

Update Supplier

Path Parameters

Request Body

Response

Delete Supplier

Path Parameters

Response

Get Supplier Statistics

Path Parameters

Response