> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getscale.ng/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Storefront Settings

Retrieve the active configuration settings, theme colors, template IDs, announcements, and policies for the shop storefront.

### Authorizations

<ParamField header="X-Shop-API-Key" type="string" required>
  Your Secret API Key (`sk_live_...` or `sk_test_...`) generated from the Developer dashboard. Must be kept secret.
</ParamField>

### Path Parameters

<ParamField path="shopId" type="string" required>
  The unique UUID of the shop.
</ParamField>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "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"
    }
  }
  ```

  ```json 400 Bad Request theme={null}
  {
    "message": "FORM_VALIDATION_ERROR",
    "code": 400,
    "validationErrors": [
      {
        "path": [
          "shopId"
        ],
        "message": "Shop not found"
      }
    ]
  }
  ```
</ResponseExample>