Skip to main content
The Suppliers API allows you to manage supplier information, including contact details and active status. Suppliers are companies or individuals who provide furniture products to your inventory.

​
Base URL

All supplier endpoints are relative to: 
/api/v1/suppliers

​
Resource Overview

The Supplier resource contains the following information:
​
id
integer
required
Unique identifier for the supplier
​
name
string
required
Name of the supplier company or individual
​
contactEmail
string
required
Contact email address for the supplier
​
contactPhone
string
required
Contact phone number for the supplier
​
isActive
boolean
required
Indicates whether the supplier is currently active

​
Available Endpoints

​
Core Operations

​
Search Operations

​
Common Use Cases

​
Adding a New Supplier

When onboarding a new supplier, use the create endpoint with their contact information: 
curl -X POST https://api.example.com/api/v1/suppliers \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Premium Furniture Co.",
    "contactEmail": "[email protected]",
    "contactPhone": "+1-555-0100",
    "isActive": true
  }'

​
Finding Active Suppliers

Retrieve only active suppliers for current operations: 
curl https://api.example.com/api/v1/suppliers/active

​
Searching by Name

Find suppliers whose name contains a specific term: 
curl https://api.example.com/api/v1/suppliers/search/contains/Premium

Build docs developers (and LLMs) love

Get started for freeTalk to us