Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.affiliates.history("AFFILIATE_ID");<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->affiliates->history('AFFILIATE_ID');
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.affiliates.history("AFFILIATE_ID")
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/affiliates/{affiliateId}/history \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/affiliates/{affiliateId}/history"
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}/affiliates/{affiliateId}/history")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/affiliates/{affiliateId}/history")
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": {
"changes": [
{
"id": "6b4221ce-60ee-4856-99c2-8efe0af9321b",
"kind": "add",
"amount": 12.5,
"balanceAfter": 12.5,
"currencyCode": "USD",
"dateCreated": "2026-10-22T16:20:19Z",
"note": "Commission from before the programme",
"orderId": null,
"by": "api-docs-25aa8416@noblecheats.net"
}
],
"payouts": []
}
}{
"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": {}
}Affiliates
Get an affiliate's history
One affiliate’s balance line by line (changes), and the payouts they have asked for (payouts).
Needs the affiliates.read permission (Read Affiliates).
GET
/
stores
/
{storeId}
/
affiliates
/
{affiliateId}
/
history
Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.affiliates.history("AFFILIATE_ID");<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->affiliates->history('AFFILIATE_ID');
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.affiliates.history("AFFILIATE_ID")
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/affiliates/{affiliateId}/history \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/affiliates/{affiliateId}/history"
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}/affiliates/{affiliateId}/history")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/affiliates/{affiliateId}/history")
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": {
"changes": [
{
"id": "6b4221ce-60ee-4856-99c2-8efe0af9321b",
"kind": "add",
"amount": 12.5,
"balanceAfter": 12.5,
"currencyCode": "USD",
"dateCreated": "2026-10-22T16:20:19Z",
"note": "Commission from before the programme",
"orderId": null,
"by": "api-docs-25aa8416@noblecheats.net"
}
],
"payouts": []
}
}{
"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 affiliate.

