Skip to main content
GET
/
api
/
v2
/
storefront
/
store
Return the current Store
curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/store \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3",
    "type": "store",
    "attributes": {
      "name": "Mystore",
      "url": "spree-demo.com",
      "meta_description": "Luxury clothing store for men and women.",
      "meta_keywords": "luxury clothing men women",
      "seo_title": "",
      "default_currency": "USD",
      "default": true,
      "supported_currencies": "EUR,GBP,USD",
      "facebook": "https://www.facebook.com/mystorename",
      "twitter": "https://twitter.com/mystorename",
      "instagram": "https://instagram.com/mystorename",
      "default_locale": "en",
      "customer_support_email": "support@mystore.com",
      "description": "Mystore has been selling luxury clothing for more than 20 years and has 15 stores currently.",
      "address": "813 Howard Street, Oswego NY 13126, USA",
      "contact_phone": "+123456789",
      "supported_locales": "en",
      "favicon_path": "/assets/favicon.ico"
    },
    "relationships": {
      "menus": {
        "data": [
          {
            "id": "10",
            "type": "menu"
          },
          {
            "id": "11",
            "type": "menu"
          }
        ]
      },
      "cms_pages": {
        "data": [
          {
            "id": "5",
            "type": "cms_page"
          }
        ]
      },
      "default_country": {
        "data": {
          "id": "2",
          "type": "country"
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

User token to authorize Cart and Checkout requests.

It is required to associate Cart with the User.

Query Parameters

​
include
string

Specify what related resources (relationships) you would like to receive in the response body. Eg.

default_country,menus,cms_pages

More information

​
fields[store]
string

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

Response

200 Success - Returns the store object.

​
data
object
required

Stores are the center of the Spree ecosystem. Each Spree installation can have multiple Stores. Each Store operates on a different domain or subdomain.

​
included
(Country · object | Menu · object | CMS Page · object)[]
  • Country
  • CMS Page
⌘I