List suppliers

Lists the suppliers of the team.

get/api/v1/sa/inventory/suppliers

Request

Base URL: https://app.sellerassistant.app (the document declares no server; this is the origin it was published from)
URL: https://app.sellerassistant.app/api/v1/sa/inventory/suppliers
Auth: one of:
- API key in query parameter api_key
- API key in header X-Api-Key

Query parameters

searchstring

A term the list looks for. Each list names the columns it reads.

sortstring

Example:-created_at

The column to order by: name, status, website, mov, currency, type, lead_time_min, lead_time_max, warehouse_name, user_name, created_at, updated_at. A minus sign in front of the name orders from the highest down. Without a sort the order is -created_at. Another name answers 400.

pageinteger

Example:1

The page to read. It starts at 1.

per_pageinteger

Example:25

The rows a page carries. The maximum is 200.

Response

Successful response

Example response

{
  "data": [
    {
      "id": 1,
      "team_id": 123,
      "user_id": 456,
      "name": "Acme Wholesalers",
      "website": "https://acme.com",
      "status": "New",
      "type": "Distributor",
      "payment_method": [
        "Credit card",
        "ACH"
      ],
      "payment_terms": "Net 30",
      "currency": "USD",
      "contacts": "contact@acme.com",
      "contact_name": "John Doe",
      "phone": "+1234567890",
      "address": "123 Main St, City, State",
      "default_prep_center_id": 3,
      "note": "Preferred supplier for electronics",
      "mov": 5000.75,
      "free_shipping_ov": 150,
      "lead_time_min": 3,
      "lead_time_max": 10,
      "created_at": "2025-12-22T10:00:00Z",
      "updated_at": "2025-12-22T12:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total": 137,
      "last_page": 6
    },
    "trial_limit": {
      "max_rows": 25,
      "total": 137,
      "code": "trial_list_limited",
      "message": "The trial shows only the first rows of a list. Subscribe to see all rows.",
      "subscribe_url": "https://app.sellerassistant.app/subscription"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.