> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shoppex.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Store API
> Fetch store metadata, branding, and configuration
The Store API provides access to your shop's public information including name, branding, and settings.
For simple use cases like displaying the store logo, use `getStoreLogoUrl()` or `getStoreBannerUrl()` — they are lightweight wrappers that avoid fetching the full store metadata.
## getStore
Fetches the store's public metadata.
```javascript theme={"system"}
const { data: store } = await shoppex.getStore();
console.log(store.name); // "My Awesome Store"
console.log(store.currency); // "USD"
```
### Response
Unique store identifier
Store display name
URL-friendly store identifier
Custom domain if configured
Store description
Default currency (ISO 4217)
Logo image URL
Banner image URL
Average store rating (1-5)
Whether terms of service are enabled
Social media links
Discord URL
Twitter URL
Instagram URL
Facebook URL
Telegram URL
YouTube URL
Reddit URL
TikTok URL
### Example: Display Store Header
```javascript theme={"system"}
async function renderStoreHeader() {
const { data: store } = await shoppex.getStore();
document.getElementById('store-header').innerHTML = `
${store.name}
${store.rating ? `${store.rating.toFixed(1)} / 5` : ''}
`;
}
```
## getStoreLogoUrl
Returns the store's logo URL directly.
```javascript theme={"system"}
const logoUrl = await shoppex.getStoreLogoUrl();
if (logoUrl) {
document.getElementById('logo').src = logoUrl;
}
```
### Response
Logo URL or `null` if no logo is set
## getStoreBannerUrl
Returns the store's banner URL directly.
```javascript theme={"system"}
const bannerUrl = await shoppex.getStoreBannerUrl();
if (bannerUrl) {
document.getElementById('hero').style.backgroundImage = `url(${bannerUrl})`;
}
```
### Response
Banner URL or `null` if no banner is set
## Error Handling
```javascript theme={"system"}
try {
const { data, success, message } = await shoppex.getStore();
if (!success) {
console.error('Failed to load store:', message);
return;
}
// Use store data
} catch (error) {
if (error.name === 'NotInitializedError') {
console.error('SDK not initialized. Call shoppex.init() first.');
} else if (error.name === 'NetworkError') {
console.error('Network error. Check your connection.');
}
}
```
***
## Next Steps
Fetch products, variants, and categories
Full TypeScript type reference