Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const page = await shoply.coupons.list();
// Or every row of every page:
for await (const row of shoply.coupons.list()) {
console.log(row);
}<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$page = $shoply->coupons->list();
// Or every row of every page:
foreach ($shoply->coupons->list() as $row) {
print_r($row);
}
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
page = client.coupons.list()
# Or every row of every page:
for row in client.coupons.list():
print(row)
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/coupons \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/coupons"
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}/coupons")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/coupons")
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": "e6ffacf4-0cef-460d-9a1d-a17c6f295a29",
"storeId": "743d82fb-6aad-44bb-ab00-d54c4b0eecb7",
"categoryId": "62fc3f0e-0160-47f3-9ba0-b02592d4590f",
"code": "WELCOME10",
"discountType": "percent",
"value": 10,
"maxUses": 100,
"uses": 0,
"remainingUses": 100,
"minSubtotal": 0,
"expiresAt": null,
"active": true,
"appliesTo": "all",
"targets": [],
"customerTag": null,
"sort": 0,
"discountGiven": 0,
"revenue": 0,
"dateCreated": "2026-10-22T16:20:18Z",
"updatedAt": "2026-10-22T16:20:18.777Z"
}
],
"pages": 1,
"total": 1,
"meta": {
"counts": {
"all": 1,
"expired": 0,
"inactive": 0,
"active": 1
},
"perPageMax": 500,
"types": [
"percent",
"fixed"
],
"currencyCode": "USD"
}
}{
"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": {}
}Coupons
List coupons
The store’s coupons, a page at a time, each with how often it has been used and what it has taken off. meta.counts says how many there are in each state.
Needs the coupons.read permission (Read Coupons).
GET
/
stores
/
{storeId}
/
coupons
Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const page = await shoply.coupons.list();
// Or every row of every page:
for await (const row of shoply.coupons.list()) {
console.log(row);
}<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$page = $shoply->coupons->list();
// Or every row of every page:
foreach ($shoply->coupons->list() as $row) {
print_r($row);
}
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
page = client.coupons.list()
# Or every row of every page:
for row in client.coupons.list():
print(row)
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/coupons \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/coupons"
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}/coupons")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/coupons")
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": "e6ffacf4-0cef-460d-9a1d-a17c6f295a29",
"storeId": "743d82fb-6aad-44bb-ab00-d54c4b0eecb7",
"categoryId": "62fc3f0e-0160-47f3-9ba0-b02592d4590f",
"code": "WELCOME10",
"discountType": "percent",
"value": 10,
"maxUses": 100,
"uses": 0,
"remainingUses": 100,
"minSubtotal": 0,
"expiresAt": null,
"active": true,
"appliesTo": "all",
"targets": [],
"customerTag": null,
"sort": 0,
"discountGiven": 0,
"revenue": 0,
"dateCreated": "2026-10-22T16:20:18Z",
"updatedAt": "2026-10-22T16:20:18.777Z"
}
],
"pages": 1,
"total": 1,
"meta": {
"counts": {
"all": 1,
"expired": 0,
"inactive": 0,
"active": 1
},
"perPageMax": 500,
"types": [
"percent",
"fixed"
],
"currencyCode": "USD"
}
}{
"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.
Query Parameters
Which page of the list. The first is 1.
How many a page holds, up to 500.
Only coupons whose code contains this.
Only coupons in this state.
Available options:
active, inactive, expired Only coupons in this coupon category.

