Return the current Store

Returns the current Store. Read more about Stores

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 - application/vnd.api+json

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.

Show child attributes

data.attributes

object

required

Show child attributes

data.attributes.address

string

Address of the Store which is visible in the Footer

data.attributes.contact_phone

string

Contact phone number of the Store which is visible in the Footer

data.attributes.customer_support_email

string

This email is visible to your Store visitors in the Footer section

data.attributes.default

boolean

Indicates if the Store is the default one

data.attributes.default_currency

string

Default currency of the store

data.attributes.default_locale

string

Default locale of the Store

data.attributes.description

string

Description of the Store which is visible in the Footer

data.attributes.facebook

string

URL of Facebook page

data.attributes.favicon_path

string

data.attributes.instagram

string

URL of Instagram page

data.attributes.meta_description

string

Meta description for SEO

data.attributes.meta_keywords

string

Meta keywords for SEO

data.attributes.name

string

Name of the Store

data.attributes.seo_title

string

The title for SEO

data.attributes.supported_currencies

string

All currencies supported by store

data.attributes.supported_locales

string

Supported locales of the Store

data.attributes.twitter

string

URL of Twitter page

data.attributes.url

string

Store Url

data.id

string

required

data.relationships

object

required

Show child attributes

data.relationships.cms_pages

object

CMS Pages

Show child attributes

data.relationships.cms_pages.data

array

Show child attributes

data.relationships.cms_pages.data.id

string

required

data.relationships.cms_pages.data.type

string

required

data.relationships.default_country

object

Default Country of the Store

Show child attributes

data.relationships.default_country.data

object | null

Show child attributes

data.relationships.default_country.data.id

string

required

data.relationships.default_country.data.type

string

required

data.relationships.menus

object

Menus

Show child attributes

data.relationships.menus.data

array

Show child attributes

data.relationships.menus.data.id

string

required

data.relationships.menus.data.type

string

required

data.type

string

default:

store

required

included

object[]

• Store Includes
• Store Includes
• Store Includes

Show child attributes

included.attributes

object

required

Show child attributes

included.attributes.default

boolean

included.attributes.iso

string

included.attributes.iso_name

string

included.attributes.iso3

string

included.attributes.name

string

included.attributes.states_required

boolean

included.attributes.zipcode_required

boolean

included.id

string

required

included.relationships

object

required

Show child attributes

included.relationships.states

object

States associated with this Country

Show child attributes

included.relationships.states.data

object[]

Show child attributes

included.relationships.states.data.abbr

string

State abbreviation

included.relationships.states.data.name

string

State name

included.type

string

default:

country

required