Skip to main content
GET
/
api
/
v1
/
hub
/
shop
/
{shopId}
/
storefront-settings
Get Storefront Settings
curl --request GET \
  --url https://api.sabivendor.com/api/v1/hub/shop/{shopId}/storefront-settings \
  --header 'X-Shop-API-Key: <x-shop-api-key>'
{
  "status": "success",
  "data": {
    "themeColor": "#22162B",
    "fontFamily": "Inter",
    "templateId": "default",
    "announcementBarText": "Free shipping on orders over ₦5000!",
    "showAnnouncementBar": true,
    "socialLinks": {
      "instagram": "https://instagram.com/bestshoes",
      "twitter": "https://twitter.com/bestshoes"
    },
    "checkoutConfig": {
      "guestCheckout": true
    },
    "maintenanceMode": false,
    "showOutOfStock": true,
    "lowStockThreshold": 5,
    "orderSuccessMessage": "Thank you for shopping with us!",
    "shopPolicy": "All sales are final.",
    "defaultTheme": "light"
  }
}
Retrieve the active configuration settings, theme colors, template IDs, announcements, and policies for the shop storefront.

​
Authorizations

​
X-Shop-API-Key
string
required
Your Secret API Key (sk_live_... or sk_test_...) generated from the Developer dashboard. Must be kept secret.

​
Path Parameters

​
shopId
string
required
The unique UUID of the shop.
{
  "status": "success",
  "data": {
    "themeColor": "#22162B",
    "fontFamily": "Inter",
    "templateId": "default",
    "announcementBarText": "Free shipping on orders over ₦5000!",
    "showAnnouncementBar": true,
    "socialLinks": {
      "instagram": "https://instagram.com/bestshoes",
      "twitter": "https://twitter.com/bestshoes"
    },
    "checkoutConfig": {
      "guestCheckout": true
    },
    "maintenanceMode": false,
    "showOutOfStock": true,
    "lowStockThreshold": 5,
    "orderSuccessMessage": "Thank you for shopping with us!",
    "shopPolicy": "All sales are final.",
    "defaultTheme": "light"
  }
}