Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.storefronts.list();<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->storefronts->list();
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.storefronts.list()
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/storefronts \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/storefronts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.shoply.gg/v1/stores/{storeId}/storefronts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/storefronts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": null,
"code": null,
"data": [
{
"id": "93618f34-cfad-44d8-a677-253b7238f272",
"name": "Autumn look",
"theme": "keystone",
"themeVersion": "2.6.0",
"published": false,
"publishedAt": null,
"live": false,
"createdAt": "2026-10-22T16:20:20Z",
"updatedAt": "2026-10-22T16:20:20Z",
"code": true,
"engine": "files",
"codeOnCopy": null,
"unpublished": false,
"accent": null,
"headingFont": null,
"pages": 6
}
],
"meta": {
"liveId": null,
"limit": 10,
"themes": [
{
"id": "simplistic",
"name": "Simplistic",
"description": "Product cards, a search bar at the top, categories as tiles and a slide-out cart.",
"version": "2.5.0",
"schemes": [
"light",
"dark"
],
"headingFont": "Inter",
"features": [
"Light and dark mode",
"Your logo, favicon and accent colour"
],
"demoUrl": "https://simplistic-demo.myshoply.gg"
},
{
"id": "keystone",
"name": "Keystone",
"description": "A full-screen hero with search, category covers and a product page built around one buy panel.",
"version": "2.6.0",
"schemes": [
"dark"
],
"headingFont": "Red Hat Display",
"features": [
"Dark look in your accent colour, pictures included",
"Full-screen hero with search and shortcuts"
],
"demoUrl": "https://keystone-demo.myshoply.gg"
}
],
"storeUrl": "https://northwind.myshoply.gg",
"storeAccent": "#6a3ce2"
}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}Storefronts
List storefronts
The store’s storefronts: each a design of its site, on a theme. One of them is live (meta.liveId), which is the one buyers see. A store holds up to 10. meta.themes is the themes a new one can start from.
Needs the storefronts.read permission (Read Storefronts).
GET
/
stores
/
{storeId}
/
storefronts
Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.storefronts.list();<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->storefronts->list();
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.storefronts.list()
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/storefronts \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/storefronts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.shoply.gg/v1/stores/{storeId}/storefronts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/storefronts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": null,
"code": null,
"data": [
{
"id": "93618f34-cfad-44d8-a677-253b7238f272",
"name": "Autumn look",
"theme": "keystone",
"themeVersion": "2.6.0",
"published": false,
"publishedAt": null,
"live": false,
"createdAt": "2026-10-22T16:20:20Z",
"updatedAt": "2026-10-22T16:20:20Z",
"code": true,
"engine": "files",
"codeOnCopy": null,
"unpublished": false,
"accent": null,
"headingFont": null,
"pages": 6
}
],
"meta": {
"liveId": null,
"limit": 10,
"themes": [
{
"id": "simplistic",
"name": "Simplistic",
"description": "Product cards, a search bar at the top, categories as tiles and a slide-out cart.",
"version": "2.5.0",
"schemes": [
"light",
"dark"
],
"headingFont": "Inter",
"features": [
"Light and dark mode",
"Your logo, favicon and accent colour"
],
"demoUrl": "https://simplistic-demo.myshoply.gg"
},
{
"id": "keystone",
"name": "Keystone",
"description": "A full-screen hero with search, category covers and a product page built around one buy panel.",
"version": "2.6.0",
"schemes": [
"dark"
],
"headingFont": "Red Hat Display",
"features": [
"Dark look in your accent colour, pictures included",
"Full-screen hero with search and shortcuts"
],
"demoUrl": "https://keystone-demo.myshoply.gg"
}
],
"storeUrl": "https://northwind.myshoply.gg",
"storeAccent": "#6a3ce2"
}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}Authorizations
A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...
Path Parameters
The store's ID. A key reaches the store it was made in: GET /key answers which.

