Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tutosrive/ferreandina-nosql/llms.txt

Use this file to discover all available pages before exploring further.

The Supplier resource represents a vendor that provides hardware products to Ferreandina. Each supplier document stores the company name, contact email, phone number, and a profile image URL. Suppliers are referenced in two places: as an embedded supplier object inside each Product document, and as an embedded supplier object inside each Supply (delivery) record. The seed dataset ships with hundreds of supplier entries. All CRUD operations are available at /api/suppliers.

​
Document Schema

​
_id
integer
required
Unique integer identifier for the supplier.
​
name
string
required
Company or trading name of the supplier (e.g., "Fierros La Central", "Wright Ltd").
​
email
string
required
Primary contact email address for the supplier.
​
phone
string
required
Contact phone number (format varies by record).
​
image
string
required
URL of the supplier’s profile/logo image.

​
Endpoints

​
GET /api/suppliers

Returns an array of all supplier documents. 
curl http://localhost:7070/api/suppliers

[
  {
    "_id": 0,
    "name": "Holder, Lawrence and Rose",
    "email": "zpage@murray.com",
    "phone": "910.887.5652",
    "image": "https://ui-avatars.com/api/?name=Holder,LawrenceandRose&background=random&color=a53ec9&size=512"
  },
  {
    "_id": 1,
    "name": "Wright Ltd",
    "email": "michael86@petersen-freeman.com",
    "phone": "(633)358-1461",
    "image": "https://ui-avatars.com/api/?name=WrightLtd&background=random&color=cdf5f7&size=512"
  }
]

​
GET /api/suppliers/{id}

Returns a single supplier by its integer _id. 
curl http://localhost:7070/api/suppliers/1

{
  "_id": 1,
  "name": "Wright Ltd",
  "email": "michael86@petersen-freeman.com",
  "phone": "(633)358-1461",
  "image": "https://ui-avatars.com/api/?name=WrightLtd&background=random&color=cdf5f7&size=512"
}

​
POST /api/suppliers

Creates a new supplier document. Request Body
​
_id
integer
required
Unique integer ID for the new supplier.
​
name
string
required
Supplier company name.
​
email
string
required
Contact email address.
​
phone
string
required
Contact phone number.
​
image
string
URL of the supplier profile image.
curl -X POST http://localhost:7070/api/suppliers \
  -H "Content-Type: application/json" \
  -d '{
    "_id": 500,
    "name": "Fierros La Central",
    "email": "contacto@fierroslac.com",
    "phone": "+57-601-555-0100",
    "image": "https://ui-avatars.com/api/?name=FierrosLaCentral&background=random&size=512"
  }'

{ "insertedId": 500 }

​
PATCH /api/suppliers/{id}

Partially updates a supplier. Include only the fields to change. Request Body
​
name
string
Updated company name.
​
email
string
Updated email address.
​
phone
string
Updated phone number.
​
image
string
Updated image URL.
curl -X PATCH http://localhost:7070/api/suppliers/1 \
  -H "Content-Type: application/json" \
  -d '{ "email": "support@wrightltd.com", "phone": "+1-800-555-0191" }'

{ "modifiedCount": 1 }

​
DELETE /api/suppliers/{id}

Deletes the supplier with the given integer _id. 
curl -X DELETE http://localhost:7070/api/suppliers/1

{ "deletedCount": 1 }

​
Example Document

{
  "_id": 2,
  "name": "Weber Inc",
  "email": "wesley57@collins.com",
  "phone": "559.469.7175",
  "image": "https://ui-avatars.com/api/?name=WeberInc&background=random&color=2176d5&size=512"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us