Stores
Return the current Store
Storefront API
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Stripe
- Products
- Vendors
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Vendors
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Stores
Return the current Store
Returns the current Store. Read more about Stores
GET
/
api
/
v2
/
storefront
/
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": "[email protected]",
"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
User token to authorize Cart and Checkout requests.
It is required to associate Cart with the User.
Query Parameters
Specify what related resources (relationships) you would like to receive in the response body. Eg.
default_country,menus,cms_pages
Specify the fields you would like returned in the response body. More information.
Response
200
application/vnd.api+json
200 Success - Returns the `store` object.
The response is of type object
.
Was this page helpful?
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": "[email protected]",
"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"
}
}
}
}
}