Material suppliers

Get all material suppliers

get

The API gives the ability to get all existing suppliers in the company.

Authorizations

PublicApiKey

x-api-keystringRequired

Query parameters

company_namestringOptional

The name of the company that supplies materials.

emailstringOptional

The supplier’s e-mail address.

phonestringOptional

The supplier’s phone number.

skipnumberOptional

takenumberOptional

Header parameters

x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Responses

200Success

application/json

429

Returned when the rate limit is exceeded

get

/api/public/material-suppliers

HTTPcURLJavaScriptPython

GET /api/public/material-suppliers HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e",
      "company_name": "ABC Materials Co.",
      "country": "United States",
      "first_name": "John",
      "last_name": "Smith",
      "phone": "[phone]",
      "email": "[email protected]",
      "created_at": "2025-01-23T17:01:31.692Z",
      "updated_at": "2025-01-24T10:30:45.123Z"
    }
  ],
  "meta": {
    "total": 1,
    "lastPage": 1,
    "currentPage": 1,
    "perPage": 1,
    "prev": 1,
    "next": 1
  }
}

Create material supplier

post

The API gives the ability to create a new supplier.

Authorizations

PublicApiKey

x-api-keystringRequired

Header parameters

x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Body

application/json

company_namestringRequired

Company name of the material supplier

Example: ABC Materials Co.

countrystringOptional

Country where the supplier is located

Example: United States

first_namestringOptional

First name of the supplier contact person

Example: John

last_namestringOptional

Last name of the supplier contact person

Example: Smith

phonestringOptional

Phone number of the supplier

Example: [phone]

emailstring · emailOptional

Email address of the supplier

Example: [email protected]

Responses

201Success

application/json

429

Returned when the rate limit is exceeded

post

/api/public/material-suppliers

HTTPcURLJavaScriptPython

POST /api/public/material-suppliers HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "company_name": "ABC Materials Co.",
  "country": "United States",
  "first_name": "John",
  "last_name": "Smith",
  "phone": "[phone]",
  "email": "[email protected]"
}

{
  "id": "b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e",
  "company_name": "ABC Materials Co.",
  "country": "United States",
  "first_name": "John",
  "last_name": "Smith",
  "phone": "[phone]",
  "email": "[email protected]",
  "created_at": "2025-01-23T17:01:31.692Z",
  "updated_at": "2025-01-24T10:30:45.123Z"
}

Update material supplier

patch

The API gives the ability to update an existing supplier's information.

Authorizations

PublicApiKey

x-api-keystringRequired

Path parameters

idstringRequired

Header parameters

x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Body

application/json

company_namestringOptional

Company name of the material supplier

Example: XYZ Materials Inc.

countrystringOptional

Country where the supplier is located

Example: Canada

first_namestringOptional

First name of the supplier contact person

Example: Jane

last_namestringOptional

Last name of the supplier contact person

Example: Doe

phonestringOptional

Phone number of the supplier

Example: [phone]

emailstring · emailOptional

Email address of the supplier

Example: [email protected]

Responses

200Success

application/json

429

Returned when the rate limit is exceeded

patch

/api/public/material-suppliers/{id}

HTTPcURLJavaScriptPython

PATCH /api/public/material-suppliers/{id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "company_name": "XYZ Materials Inc.",
  "country": "Canada",
  "first_name": "Jane",
  "last_name": "Doe",
  "phone": "[phone]",
  "email": "[email protected]"
}

{
  "message": "The operation was done successfully"
}