> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cdr.fyi/llms.txt
> Use this file to discover all available pages before exploring further.

# Suppliers

> Create, update & list supplier records.

## List Suppliers

Retrieves a list of suppliers.

### HTTP Request

`GET https://api.cdr.fyi/v1/suppliers`

### Query Parameters

| Parameter        | Type   | Description                                         |
| ---------------- | ------ | --------------------------------------------------- |
| entityFilterType | String | Filter by entity (Supplier, Marketplace, Purchaser) |
| entityFilterId   | String | Filter 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

```bash theme={null}
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.cdr.fyi/suppliers?entityFilterType=Supplier&entityFilterId=123"
```

### 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

`POST https://api.cdr.fyi/v1/suppliers`

#### Request Headers

* **Authorization**: Bearer YOUR\_ACCESS\_TOKEN
* **Content-Type**: application/json

#### Request Body Parameters

| Parameter     | Type    | Description                        | Required |
| ------------- | ------- | ---------------------------------- | -------- |
| supplier\_id  | String  | Unique identifier for the supplier | No       |
| name          | String  | Name of the supplier               | Yes      |
| methods       | String  | Payment methods available          | No       |
| website       | String  | Website URL                        | No       |
| logo          | String  | Logo URL                           | No       |
| slug          | String  | URL slug                           | No       |
| tagline       | String  | Tagline                            | No       |
| description   | String  | Description (max 500 characters)   | No       |
| year\_founded | Integer | Year founded                       | No       |
| geo\_city     | String  | Geographic city                    | No       |
| geo\_country  | String  | Geographic country                 | No       |
| twitter       | String  | Twitter handle                     | No       |
| is\_verified  | Boolean | Verification status                | No       |

Example Request

```bash theme={null}
curl -X GET https://api.cdr.fyi/v1/suppliers \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Content-Type: application/json" 
```

Example Response

```json theme={null}
{
  "suppliers": [{
    "supplier_id": "sup_sample",
    "name": "Sample Supplier",
    "methods": "Credit Card",
    "website": "https://sample.com",
    "logo": "https://sample.com/logo.png",
    "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.