Admin APIs

Get Vendors

GET /vendors
Api key auth

Get a list of vendors

Query parameters

  • page integer(int32)

    Page Number

  • limit integer(int32)

    Number of items per page

Responses

  • 200 application/json

    A list of vendors

    Hide response attributes Show response attributes object
    • pagination object
      Hide pagination attributes Show pagination attributes object
      • current integer(int32)
      • previous integer(int32)
      • next integer(int32)
      • limit integer(int32)
      • total_pages integer(int32)
      • total_count integer(int32)
    • data array[object]
      Hide data attributes Show data attributes object
      • id string(guid)

        System generated unique identifier. Don't include this in POST request body.

      • name string
      • minimum_order_value number
      • minimum_order_quantity integer(int32)
      • address1 string
      • address2 string | null
      • city string
      • state string(ISO 3166-2)
      • zip string
      • country string(ISO 3166-1 alpha-2)
      • website string | null
      • email string | null
      • phone string | null
      • ein string | null
      • order_contact_name string | null
      • order_contact_phone string(phone)
      • payment_contact_name string | null
      • payment_contact_phone string(phone) | null
      • shipping_type string | null
      • shipping_scheme object
        Hide shipping_scheme attribute Show shipping_scheme attribute object
        • 0 string | null
      • status string
      • order_processing_time string | null
      • order_processing_on string | null
      • order_shipping_days array[object]
      • order_processing_cut_off_time string | null
      • order_terms string | null
      • description string | null

        excluded from index

      • created_at string(date-time)
      • updated_at string(date-time)
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • error string

      401: Invalid Credentials

      404: Resource not found

      422: Unprocessable Entity

    • details string

      404: empty

      401: The credentials presented are not valid to access this resource
GET /vendors 
curl \
 --request GET 'https://stg.getfoundation.com/api/external/v1/vendors' \
 --header "X-API-Key: $API_KEY"
Response examples (200) 
{
  "pagination": {
    "current": 42,
    "previous": 42,
    "next": 42,
    "limit": 42,
    "total_pages": 42,
    "total_count": 42
  },
  "data": [
    {
      "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
      "name": "Acme Corp",
      "minimum_order_value": 200,
      "minimum_order_quantity": 10,
      "address1": "123 Main St",
      "address2": "string",
      "city": "Seattle",
      "state": "WA",
      "zip": 98101,
      "country": "US",
      "website": "string",
      "email": "string",
      "phone": "string",
      "ein": "string",
      "order_contact_name": "string",
      "order_contact_phone": "string",
      "payment_contact_name": "John Doe",
      "payment_contact_phone": "string",
      "shipping_type": "VendorCalculators::Shipping::SubtotalBased",
      "shipping_scheme": {
        "0": "string"
      },
      "status": "active",
      "order_processing_time": "string",
      "order_processing_on": "string",
      "order_shipping_days": [
        {}
      ],
      "order_processing_cut_off_time": "string",
      "order_terms": "string",
      "description": "string",
      "logo": "string",
      "created_at": "2025-05-04T09:42:00Z",
      "updated_at": "2025-05-04T09:42:00Z"
    }
  ]
}
Response examples (401) 
{
  "error": "string",
  "details": "string"
}