List Suppliers

Retrieves a list of suppliers.

HTTP Request


Query Parameters

entityFilterTypeStringFilter by entity (Supplier, Marketplace, Purchaser)
entityFilterIdStringFilter by entity ID

Custom Headers

  • x-page: The page number (default is 1)
  • x-limit: Number of items per page (max 100, default is 10)

Example Request

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" ""

Create or Update a Supplier

This endpoint creates a new supplier or updates an existing one by upserting based on the supplier_id.

HTTP Request


Request Headers

  • Authorization: Bearer YOUR_ACCESS_TOKEN
  • Content-Type: application/json

Request Body Parameters

supplier_idStringUnique identifier for the supplierNo
nameStringName of the supplierYes
methodsStringPayment methods availableNo
websiteStringWebsite URLNo
logoStringLogo URLNo
slugStringURL slugNo
descriptionStringDescription (max 500 characters)No
year_foundedIntegerYear foundedNo
geo_cityStringGeographic cityNo
geo_countryStringGeographic countryNo
twitterStringTwitter handleNo
is_verifiedBooleanVerification statusNo

Example Request

curl -X GET \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Content-Type: application/json" 

Example Response

  "suppliers": [{
    "supplier_id": "sup_sample",
    "name": "Sample Supplier",
    "methods": "Credit Card",
    "website": "",
    "logo": "",
    "slug": "sample-supplier",
    "tagline": "The best supplier",
    "description": "This is a sample supplier",
    "year_founded": 2010,
    "geo_city": "New York",
    "geo_country": "USA",
    "twitter": "@sample",
    "is_verified": true

Error Responses

If the request is not successful, you will receive a 400 Bad Request or 401 Unauthorized response along with an error message indicating the issue.