Admin API
Stores
The store, its settings, theme and storefront tokens.
The store this token or session acts on
GET/admin/2026-11/shop
any app token
Response 200
idID (sto_...)requirednamestringrequiredhandlestringrequiredstatusenumrequiredOne of
activesuspendedclosedmodeenumrequiredDevelopment stores use test payments only and cannot take real money.
One of
livedevelopmentcountrystringrequiredAt least 2 characters · Up to 2 characters
currencyenumrequiredOne of
INRGBPtimezonestringrequiredlocalestringrequiredfree_domainstringrequiredthemeobjectrequiredThe online store theme and brand colour (D-107).
theme.presetenumrequiredOne of the ten online store themes.
One of
essentialbazaarminimalboutiqueboldfreshtechcraftstudioluxetheme.accentstring or nullrequiredYour brand colour for buttons and links; null uses the theme colour.
created_attimestamprequired
Errors
| 401 | authentication_required | Send a valid access token or session. |
| 429 | rate_limited | Too many requests. Wait for the time in RateLimit-Reset. |
| 500 | internal_error | Something went wrong on our side. Quote the trace_id to support. |
curl https://api.storelyne.com/admin/2026-11/shop \
-H "Authorization: Bearer pat_live_..."const res = await fetch('https://api.storelyne.com/admin/2026-11/shop', {
method: 'GET',
headers: {
'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
},
});
const data = await res.json();{
"id": "sto_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
"name": "Festive saree",
"handle": "festive-saree",
"status": "active",
"mode": "live",
"country": "IN",
"currency": "INR",
"timezone": "string",
"locale": "string",
"free_domain": "string",
"theme": {
"preset": "essential",
"accent": "string"
},
"created_at": "2026-11-04T10:00:00.000Z"
}Update store details
PATCH/admin/2026-11/shop
Headers
X-CSRF-TokenstringRequired with a seller session cookie: the value of the orb_csrf cookie.
Request body
namestringAt least 2 characters · Up to 80 characters
timezonestringlocaleenumOne of
en-INhi-INthemeobjecttheme.presetenumrequiredOne of the ten online store themes.
One of
essentialbazaarminimalboutiqueboldfreshtechcraftstudioluxetheme.accentstring or nullrequiredYour brand colour for buttons and links; null uses the theme colour.
Response 200
idID (sto_...)requirednamestringrequiredhandlestringrequiredstatusenumrequiredOne of
activesuspendedclosedmodeenumrequiredDevelopment stores use test payments only and cannot take real money.
One of
livedevelopmentcountrystringrequiredAt least 2 characters · Up to 2 characters
currencyenumrequiredOne of
INRGBPtimezonestringrequiredlocalestringrequiredfree_domainstringrequiredthemeobjectrequiredThe online store theme and brand colour (D-107).
theme.presetenumrequiredOne of the ten online store themes.
One of
essentialbazaarminimalboutiqueboldfreshtechcraftstudioluxetheme.accentstring or nullrequiredYour brand colour for buttons and links; null uses the theme colour.
created_attimestamprequired
Errors
| 400 | validation_failed | A field in the request is missing or invalid. See param. |
| 401 | authentication_required | Send a valid access token or session. |
| 403 | missing_scope | The app token does not have the scope this endpoint needs. |
| 429 | rate_limited | Too many requests. Wait for the time in RateLimit-Reset. |
| 500 | internal_error | Something went wrong on our side. Quote the trace_id to support. |
curl -X PATCH https://api.storelyne.com/admin/2026-11/shop \
-H "Authorization: Bearer pat_live_..." \
-H "Content-Type: application/json" \
-d '{
"name": "Festive saree",
"timezone": "string",
"locale": "en-IN"
}'const res = await fetch('https://api.storelyne.com/admin/2026-11/shop', {
method: 'PATCH',
headers: {
'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "Festive saree",
"timezone": "string",
"locale": "en-IN"
}),
});
const data = await res.json();{
"id": "sto_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
"name": "Festive saree",
"handle": "festive-saree",
"status": "active",
"mode": "live",
"country": "IN",
"currency": "INR",
"timezone": "string",
"locale": "string",
"free_domain": "string",
"theme": {
"preset": "essential",
"accent": "string"
},
"created_at": "2026-11-04T10:00:00.000Z"
}