API reference
Store
Your store as its seller sees it, and the basic settings. Themes, payment methods, payouts and domains stay in the dashboard.
Endpoints
GET/storestore:read
Get the store.
curl https://api.sellhidden.com/v1/store \
-H "Authorization: Bearer hsk_live_…"200 OKjson
{ "ok": true, "store": { "id": "clx…", "slug": "my-store", "name": "My Store", "url": "https://my-store.sellhidden.com", "plan": "pro", "balanceUsd": 1240.5, "feeBornBy": "seller", "support": { "email": "help@example.com", "discord": null, "telegram": null }, "settings": { "maintenanceMode": false, "hideOutOfStock": false, … }, … } }PATCH/storestore:write
Update basic settings. Only the fields you send change.
| Body | Type | Description |
|---|---|---|
| name | Type: string | 2-80 characters. |
| description | Type: string | Up to 500 characters. |
| logoUrl | Type: string | null | |
| bannerUrl | Type: string | null | |
| supportEmail | Type: string | null | |
| supportDiscord | Type: string | null | Invite URL. |
| supportTelegram | Type: string | null | |
| maintenanceMode | Type: boolean | Closes the storefront to buyers. |
| hideOutOfStock | Type: boolean | |
| showStockCount | Type: boolean | |
| showStats | Type: boolean | |
| recentSalesWidget | Type: boolean | Live sale notifications toggle. |
| liveSalesCorner | Type: string | bottom-left | bottom-right | top-left | top-right (default bottom-left). |
| autoReviews | Type: boolean | |
| autoCurrency | Type: boolean | Deprecated; use currencyMode ("auto"). |
| currencyMode | Type: usd | fixed | auto | Default display currency: USD, a fixed one you pick, or the currency of the buyer's location. |
| defaultCurrency | Type: string | ISO 4217 code used when currencyMode is "fixed". |
| showCurrencyPicker | Type: boolean | False hides the currency picker everywhere and the shop stays in USD. |
| feeBornBy | Type: seller | customer | Who would pay a platform fee. Every plan has a 0% platform fee, so this has no effect today. |
| productsPerPage | Type: 4..48 | |
| subscriptionReminderDays | Type: 1..14 | Days before a renewal the reminder email goes out. |
| subscriptionGraceDays | Type: 0..3 | Days a buyer keeps access after a missed renewal. |
curl -X PATCH https://api.sellhidden.com/v1/store \
-H "Authorization: Bearer hsk_live_…" \
-H "Content-Type: application/json" \
-d '{"maintenanceMode":true}'Get help
Send us the endpoint, the request or delivery id and the response you got. Security findings go through responsible disclosure. Live platform status is on the support page.
See also