Retrieve a Vendor - Spree Commerce documentation

GET

api

storefront

vendors

{vendor_slug}

Retrieve a Vendor

const options = {method: 'GET'};

fetch('https://demo.spreecommerce.org/api/v2/storefront/vendors/{vendor_slug}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "e1171601-a4ce-47d2-a795-c96fbdf20029",
    "type": "vendor",
    "attributes": {
      "name": "Best Shoes",
      "email": "contact@example.com",
      "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"
    }
  }
}

Path Parameters

vendor_slug

string

required

Look for Vendor by ID or their slug

Query Parameters

fields[vendor]

string

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

Response

200 Success - Returns the vendor object.

data

Vendor · object

required

Vendors are Sellers in the marketplace.

Show child attributes

List all Vendors

List all Wishlists

⌘I

Retrieve a Vendor

const options = {method: 'GET'};

fetch('https://demo.spreecommerce.org/api/v2/storefront/vendors/{vendor_slug}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "e1171601-a4ce-47d2-a795-c96fbdf20029",
    "type": "vendor",
    "attributes": {
      "name": "Best Shoes",
      "email": "contact@example.com",
      "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"
    }
  }
}