Skip to content

Get store config

GET
/api/v1/business/website/config/

Everything needed to render the shell of the shop — identity, theme, hero, navigation, footer, payment methods, announcement bar, layout settings, and per-section home-page configuration. Cached server-side, so call it freely on every page render.

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)

Responses

The store configuration.

application/json
JSON
{
  
"status": true,
  
"status_code": 0,
  
"message": "string",
  
"data": {
  
  
"subdomain": "string",
  
  
"template": "string",
  
  
"theme_color": "string",
  
  
"is_active": true,
  
  
"email_otp_enabled": true,
  
  
"business_type": "string",
  
  
"header_layout": "string",
  
  
"footer_layout": "string",
  
  
"product_card_layout": "string",
  
  
"product_grid_layout": "string",
  
  
"product_detail_layout": "string",
  
  
"store": {
  
  
  
"name": "string",
  
  
  
"description": "string",
  
  
  
"logo": "string",
  
  
  
"email": "string",
  
  
  
"phone": "string",
  
  
  
"address": "string",
  
  
  
"logo_display": "string",
  
  
  
"logo_size": "string",
  
  
  
"currency_symbol": "string"
  
  
},
  
  
"hero": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"footer": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"newsletter": {
  
  
  
"enabled": true,
  
  
  
"title": "string",
  
  
  
"subtitle": "string"
  
  
},
  
  
"seo": {
  
  
  
"title": "string",
  
  
  
"description": "string",
  
  
  
"keywords": "string"
  
  
},
  
  
"banners": [
  
  
  
{
  
  
  
  
"id": 0,
  
  
  
  
"title": "string",
  
  
  
  
"subtitle": "string",
  
  
  
  
"description": "string",
  
  
  
  
"image": "string",
  
  
  
  
"link": "string",
  
  
  
  
"button_text": "string",
  
  
  
  
"sort_order": 0,
  
  
  
  
"is_active": true
  
  
  
}
  
  
],
  
  
"navigation": [
  
  
  
{
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
],
  
  
"payment_methods": [
  
  
  
{
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
],
  
  
"announcement_bar": [
  
  
],
  
  
"chat_widget": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"bottom_nav": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"additionalProperties": "string"
  
}
}

Playground

Server
Authorization

Samples

Powered by VitePress OpenAPI

© Periscale