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

# List all Vendors

> Returns a list of Vendors. Only available in [Enterprise Edition](https://spreecommerce.org/pricing)



## OpenAPI

````yaml /api-reference/storefront.yaml get /api/v2/storefront/vendors
openapi: 3.0.3
info:
  version: 2.0.0
  title: Storefront API
  description: >-
    Storefront API is a modern REST API based on the [JSON API
    spec](https://jsonapi.org/) which provides you with all the necessary
    endpoints to build amazing user interfaces either in JavaScript frameworks
    or native mobile libraries.


    Import to
    [Postman](https://raw.githubusercontent.com/spree/spree/main/docs/api-reference/storefront.yaml)
  contact:
    name: Vendo Connect Inc.
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  license:
    name: BSD-3-Clause
    url: https://github.com/spree/spree/blob/main/LICENSE.md
servers:
  - url: https://demo.spreecommerce.org
    description: demo
  - url: http://localhost:3000
    description: localhost
security: []
tags:
  - name: Account
  - name: Account / Address
  - name: Account / Credit Cards
  - name: Account / Orders
  - name: Cart
  - name: Cart / Line Items
  - name: Cart / Coupons
  - name: Cart / Other
  - name: Checkout
  - name: Checkout / State
  - name: Checkout / Shipments
  - name: Checkout / Payments
  - name: Checkout / Store Credit
  - name: Stripe
  - name: Adyen
  - name: Countries
  - name: Digital Downloads
  - name: Order Status
  - name: Products
  - name: Variants
  - name: Stores
  - name: Policies
  - name: Taxons
  - name: Vendors
  - name: Wishlists
  - name: Wishlists / Wished Items
paths:
  /api/v2/storefront/vendors:
    get:
      tags:
        - Vendors
      summary: List all Vendors
      description: >-
        Returns a list of Vendors. Only available in [Enterprise
        Edition](https://spreecommerce.org/pricing)
      operationId: vendors-list
      parameters:
        - $ref: '#/components/parameters/PageParam'
        - $ref: '#/components/parameters/PerPageParam'
        - $ref: '#/components/parameters/SparseFieldsVendor'
      responses:
        '200':
          $ref: '#/components/responses/VendorList'
components:
  parameters:
    PageParam:
      name: page
      in: query
      description: Number of requested page when paginating collection
      schema:
        type: integer
      example: 1
    PerPageParam:
      name: per_page
      in: query
      description: Number of requested records per page when paginating collection
      schema:
        type: integer
      example: 25
    SparseFieldsVendor:
      name: fields[vendor]
      in: query
      description: >-
        Specify the fields you would like returned in the response body. [More
        information](https://jsonapi.org/format/#fetching-sparse-fieldsets).
      schema:
        type: string
      example: name,slug,about_us,facebook
  responses:
    VendorList:
      description: 200 Success - Returns an array of `vendor` objects.
      content:
        application/vnd.api+json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  $ref: '#/components/schemas/Vendor'
              meta:
                $ref: '#/components/schemas/ListMeta'
              links:
                $ref: '#/components/schemas/ListLinks'
            required:
              - data
              - meta
              - links
          examples:
            List of Vendors:
              value:
                data:
                  - id: eb261155-1ddc-47e5-8178-8c3da6e607a8
                    type: vendor
                    attributes:
                      name: Best Shoes
                      email: contact-1@example.com
                      slug: best-shoes
                      about_us: |-
                        <p>We are your #1 shoe store.</p>
                        <p>Follow us on social media.</p>
                      logo_url: https://assets.com/images/logo_name
                      cover_photo_url: https://assets.com/images/wide_tree_wzxgak
                  - id: 4f46f04f-fa2c-42d0-b69c-ce2b2997f5fd
                    type: vendor
                    attributes:
                      name: Best Shirts
                      email: contact-2@example.com
                      slug: best-shirts
                      about_us: |-
                        <p>We are your #1 shirts store.</p>
                        <p>Follow us on social media.</p>
                      logo_url: https://assets.com/images/logo_name34553
                      cover_photo_url: https://assets.com/images/coverfn5ig
  schemas:
    Vendor:
      title: Vendor
      description: Vendors are Sellers in the marketplace.
      type: object
      x-internal: true
      properties:
        id:
          type: string
          example: 980a80d5-f51b-4065-b3a0-622fc5cb6bf6
        type:
          type: string
          default: vendor
        attributes:
          type: object
          properties:
            name:
              type: string
              example: Shoes For Everyone
            email:
              type: string
              example: contact@example.com
            slug:
              type: string
              example: shoes-for-everyone
            about_us:
              type: string
              example: >-
                <p>We are the #1 shoe store for you.</p>\n<p>Located in 20
                countries.</p>
              description: Information about the Vendor stored as HTML
            logo_url:
              type: string
              example: https://somewebsite.com/our-logo
              description: URL of the Logo
            cover_photo_url:
              type: string
              example: https://somewebsite.com/our-cover-photo
              description: URL of the Cover Photo
        relationships:
          type: object
          properties:
            products:
              type: object
              description: List of active and available products from this vendor
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/Relation'
      required:
        - id
        - type
        - attributes
        - relationships
    ListMeta:
      type: object
      x-internal: false
      title: Pagination Meta
      properties:
        count:
          type: number
          example: 7
          description: Number of items on the current listing
        total_count:
          type: number
          example: 145
          description: Number of all items matching the criteria
        total_pages:
          type: number
          example: 10
          description: Number of all pages containing items matching the criteria
    ListLinks:
      x-internal: false
      type: object
      title: Pagination Links
      properties:
        self:
          type: string
          description: URL to the current page of the listing
        next:
          type: string
          description: URL to the next page of the listing
        prev:
          type: string
          description: URL to the previous page of the listing
        last:
          type: string
          description: URL to the last page of the listing
        first:
          type: string
          description: URL to the first page of the listing
    Relation:
      type: object
      nullable: true
      properties:
        id:
          type: string
        type:
          type: string
      required:
        - id
        - type
      x-internal: false
      description: ''

````