StoreLyne API docs 2026-11

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_...)required
  • namestringrequired
  • handlestringrequired
  • statusenumrequired

    One of active suspended closed

  • modeenumrequired

    Development stores use test payments only and cannot take real money.

    One of live development

  • countrystringrequired

    At least 2 characters · Up to 2 characters

  • currencyenumrequired

    One of INR GBP

  • timezonestringrequired
  • localestringrequired
  • free_domainstringrequired
  • themeobjectrequired

    The online store theme and brand colour (D-107).

  • theme.presetenumrequired

    One of the ten online store themes.

    One of essential bazaar minimal boutique bold fresh tech craft studio luxe

  • theme.accentstring or nullrequired

    Your brand colour for buttons and links; null uses the theme colour.

  • created_attimestamprequired

Errors

401authentication_requiredSend a valid access token or session.
429rate_limitedToo many requests. Wait for the time in RateLimit-Reset.
500internal_errorSomething 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_..."
Response 200
{
  "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

scope write_store

Headers

  • X-CSRF-Tokenstring

    Required with a seller session cookie: the value of the orb_csrf cookie.

Request body

  • namestring

    At least 2 characters · Up to 80 characters

  • timezonestring
  • localeenum

    One of en-IN hi-IN

  • themeobject
  • theme.presetenumrequired

    One of the ten online store themes.

    One of essential bazaar minimal boutique bold fresh tech craft studio luxe

  • theme.accentstring or nullrequired

    Your brand colour for buttons and links; null uses the theme colour.

Response 200

  • idID (sto_...)required
  • namestringrequired
  • handlestringrequired
  • statusenumrequired

    One of active suspended closed

  • modeenumrequired

    Development stores use test payments only and cannot take real money.

    One of live development

  • countrystringrequired

    At least 2 characters · Up to 2 characters

  • currencyenumrequired

    One of INR GBP

  • timezonestringrequired
  • localestringrequired
  • free_domainstringrequired
  • themeobjectrequired

    The online store theme and brand colour (D-107).

  • theme.presetenumrequired

    One of the ten online store themes.

    One of essential bazaar minimal boutique bold fresh tech craft studio luxe

  • theme.accentstring or nullrequired

    Your brand colour for buttons and links; null uses the theme colour.

  • created_attimestamprequired

Errors

400validation_failedA field in the request is missing or invalid. See param.
401authentication_requiredSend a valid access token or session.
403missing_scopeThe app token does not have the scope this endpoint needs.
429rate_limitedToo many requests. Wait for the time in RateLimit-Reset.
500internal_errorSomething 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"
}'
Response 200
{
  "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"
}