Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.sales.show("SALE_ID");<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->sales->show('SALE_ID');
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.sales.show("SALE_ID")
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/sales/{saleId} \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/sales/{saleId}"
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}/sales/{saleId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/sales/{saleId}")
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": "b9f77894-db3d-4db7-8fdf-22d434957cf3",
"name": "Autumn sale",
"enabled": true,
"status": "scheduled",
"discountType": "percent",
"value": 20,
"appliesTo": "all",
"targets": [],
"startsAt": "2026-10-23T16:20:18Z",
"endsAt": "2026-10-29T16:20:18Z",
"couponRule": "rest",
"exceptions": [],
"showBar": true,
"orders": 0,
"revenue": 0,
"dateCreated": "2026-10-22T16:20:18Z",
"updatedAt": "2026-10-22T16:20:18.820Z"
}
}{
"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": {}
}Sales
Get a sale
One sale, with the products it covers and its coupon exceptions.
Needs the sales.read permission (Read Sales).
GET
/
stores
/
{storeId}
/
sales
/
{saleId}
Node.js
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.sales.show("SALE_ID");<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->sales->show('SALE_ID');
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.sales.show("SALE_ID")
curl --request GET \
--url https://api.shoply.gg/v1/stores/{storeId}/sales/{saleId} \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/sales/{saleId}"
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}/sales/{saleId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/sales/{saleId}")
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": "b9f77894-db3d-4db7-8fdf-22d434957cf3",
"name": "Autumn sale",
"enabled": true,
"status": "scheduled",
"discountType": "percent",
"value": 20,
"appliesTo": "all",
"targets": [],
"startsAt": "2026-10-23T16:20:18Z",
"endsAt": "2026-10-29T16:20:18Z",
"couponRule": "rest",
"exceptions": [],
"showBar": true,
"orders": 0,
"revenue": 0,
"dateCreated": "2026-10-22T16:20:18Z",
"updatedAt": "2026-10-22T16:20:18.820Z"
}
}{
"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 sale.

