GET
/
api
/
v2
/
storefront
/
vendors
curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/vendors
{
  "data": [
    {
      "id": "eb261155-1ddc-47e5-8178-8c3da6e607a8",
      "type": "vendor",
      "attributes": {
        "name": "Best Shoes",
        "email": "[email protected]",
        "slug": "best-shoes",
        "about_us": "<p>We are your #1 shoe store.</p>\n<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": "[email protected]",
        "slug": "best-shirts",
        "about_us": "<p>We are your #1 shirts store.</p>\n<p>Follow us on social media.</p>",
        "logo_url": "https://assets.com/images/logo_name34553",
        "cover_photo_url": "https://assets.com/images/coverfn5ig"
      }
    }
  ]
}

Query Parameters

​
page
integer

Number of requested page when paginating collection

​
per_page
integer

Number of requested records per page when paginating collection

​
fields[vendor]
string

Specify the fields you would like returned in the response body. More information.

Response

200 - application/vnd.api+json
200 Success - Returns an array of `vendor` objects.
​
data
object[]
required

Vendors are Sellers in the marketplace.

​
meta
object
required
​
links
object
required

Was this page helpful?

Suggest editsRaise issue