Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.customers.show("CUSTOMER_ID");<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->customers->show('CUSTOMER_ID');
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.customers.show("CUSTOMER_ID")
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/customers/{customerId} \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/customers/{customerId}"
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}/customers/{customerId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/customers/{customerId}")
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": {
"balance": 5,
"balanceAtCheckout": true,
"tags": [
{
"id": "a537f7cb-125f-43a0-bd90-e29657620d76",
"name": "Wholesale",
"tone": "primary",
"automatic": false
}
],
"balanceHistory": [
{
"id": "ce46d95e-769f-4a0d-9469-7298d67f7a7b",
"kind": "add",
"amount": 5,
"balanceAfter": 5,
"currencyCode": "USD",
"note": "Goodwill credit",
"orderId": null,
"by": "api-docs-25aa8416@noblecheats.net",
"dateCreated": "2026-10-22T16:20:19Z"
}
],
"affiliate": null,
"blacklisted": false,
"blacklistedBy": [],
"blacklistRules": 0,
"knownAddresses": 0,
"id": "f637fc21-973d-43ec-a7db-f819a9ebf73a",
"emailAddress": "ada@example.com",
"dateCreated": "2026-10-22T16:20:18Z",
"totalOrders": 0,
"totalSpend": 0,
"paidOrders": 0,
"lastOrderAt": null,
"currencyCode": "USD",
"ordersTruncated": false,
"orders": []
}
}{
"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": {}
}Customers
Get a customer
One customer: their orders, their balance and its history, their tags, whether they are blacklisted, and their affiliate figures if they are one.
Needs the customers.read permission (Read Customers).
GET
/
stores
/
{storeId}
/
customers
/
{customerId}
Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.customers.show("CUSTOMER_ID");<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->customers->show('CUSTOMER_ID');
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.customers.show("CUSTOMER_ID")
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/customers/{customerId} \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/customers/{customerId}"
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}/customers/{customerId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/customers/{customerId}")
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": {
"balance": 5,
"balanceAtCheckout": true,
"tags": [
{
"id": "a537f7cb-125f-43a0-bd90-e29657620d76",
"name": "Wholesale",
"tone": "primary",
"automatic": false
}
],
"balanceHistory": [
{
"id": "ce46d95e-769f-4a0d-9469-7298d67f7a7b",
"kind": "add",
"amount": 5,
"balanceAfter": 5,
"currencyCode": "USD",
"note": "Goodwill credit",
"orderId": null,
"by": "api-docs-25aa8416@noblecheats.net",
"dateCreated": "2026-10-22T16:20:19Z"
}
],
"affiliate": null,
"blacklisted": false,
"blacklistedBy": [],
"blacklistRules": 0,
"knownAddresses": 0,
"id": "f637fc21-973d-43ec-a7db-f819a9ebf73a",
"emailAddress": "ada@example.com",
"dateCreated": "2026-10-22T16:20:18Z",
"totalOrders": 0,
"totalSpend": 0,
"paidOrders": 0,
"lastOrderAt": null,
"currencyCode": "USD",
"ordersTruncated": false,
"orders": []
}
}{
"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.
The customer.

