Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.store.show();<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->store->show();
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.store.show()
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId} \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}")
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": "743d82fb-6aad-44bb-ab00-d54c4b0eecb7",
"name": "Northwind Keys",
"slug": "northwind",
"urlChangeableAt": null,
"supportUrl": "",
"guideUrl": "",
"panelUrl": "",
"socialLinks": {
"discord": "",
"youtube": "",
"tiktok": "",
"x": "",
"instagram": "",
"telegram": ""
},
"customLinks": [],
"description": "Software licences, delivered at once.",
"currencyCode": "USD",
"adaptivePricing": false,
"currencies": [
{
"code": "AED",
"name": "UAE dirham"
},
{
"code": "ARS",
"name": "Argentine peso"
}
],
"ratesFetchedAt": "2026-09-29T06:00:05Z",
"locale": "en-US",
"logoUrl": null,
"faviconUrl": null,
"storefrontPassword": "",
"storefrontPasswordUnreadable": false,
"accentColor": "#4f8ef7",
"theme": "simplistic",
"publishStock": true,
"lowStockThreshold": 5,
"dashboardCards": [
"conversion",
"status"
],
"termsOfService": "",
"refundPolicy": "",
"autoReviews": true,
"publicStats": false,
"saleNotifications": false,
"publicOnline": true,
"active": true,
"blocked": null,
"businessType": "",
"businessName": "Northwind Keys Ltd",
"businessTaxId": "",
"businessVatNumber": "",
"businessLine1": "",
"businessLine2": "",
"businessCity": "",
"businessRegion": "",
"businessPostalCode": "",
"businessCountry": "DE",
"invoiceFooter": "",
"originCountry": "",
"hasDynamicSecret": false,
"dynamicSecretEnd": "",
"updatedAt": "2026-10-22T16:20:18.454Z",
"settingsVersion": "a1593e9245ecff300c6ad568"
}
}{
"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": {}
}Store
Get the store
The store’s details and settings: its name and address, currency, branding, links, policies, what its storefront shows, and its business details.
Needs the store.read permission (Read Store).
GET
/
stores
/
{storeId}
Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.store.show();<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->store->show();
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.store.show()
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId} \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}")
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": "743d82fb-6aad-44bb-ab00-d54c4b0eecb7",
"name": "Northwind Keys",
"slug": "northwind",
"urlChangeableAt": null,
"supportUrl": "",
"guideUrl": "",
"panelUrl": "",
"socialLinks": {
"discord": "",
"youtube": "",
"tiktok": "",
"x": "",
"instagram": "",
"telegram": ""
},
"customLinks": [],
"description": "Software licences, delivered at once.",
"currencyCode": "USD",
"adaptivePricing": false,
"currencies": [
{
"code": "AED",
"name": "UAE dirham"
},
{
"code": "ARS",
"name": "Argentine peso"
}
],
"ratesFetchedAt": "2026-09-29T06:00:05Z",
"locale": "en-US",
"logoUrl": null,
"faviconUrl": null,
"storefrontPassword": "",
"storefrontPasswordUnreadable": false,
"accentColor": "#4f8ef7",
"theme": "simplistic",
"publishStock": true,
"lowStockThreshold": 5,
"dashboardCards": [
"conversion",
"status"
],
"termsOfService": "",
"refundPolicy": "",
"autoReviews": true,
"publicStats": false,
"saleNotifications": false,
"publicOnline": true,
"active": true,
"blocked": null,
"businessType": "",
"businessName": "Northwind Keys Ltd",
"businessTaxId": "",
"businessVatNumber": "",
"businessLine1": "",
"businessLine2": "",
"businessCity": "",
"businessRegion": "",
"businessPostalCode": "",
"businessCountry": "DE",
"invoiceFooter": "",
"originCountry": "",
"hasDynamicSecret": false,
"dynamicSecretEnd": "",
"updatedAt": "2026-10-22T16:20:18.454Z",
"settingsVersion": "a1593e9245ecff300c6ad568"
}
}{
"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.

