Node.js

import { ShoplyCustomer } from "@shoplygg/node";

const buyer = new ShoplyCustomer({ storeId: "YOUR_STORE_ID", token });

const result = await buyer.show();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shoply.gg/v1/stores/{storeId}/customer"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.shoply.gg/v1/stores/{storeId}/customer")

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": {
    "email": "grace@example.com",
    "customerSince": "2026-10-22T16:20:19Z",
    "balance": null,
    "affiliate": {
      "member": false,
      "canJoin": true
    },
    "totals": {
      "spent": [
        {
          "currencyCode": "USD",
          "amount": 9.99
        }
      ],
      "orders": 2,
      "keys": 1
    },
    "orders": [
      {
        "id": "bc44febe-0f25-4076-92eb-03a5045a57e7",
        "status": "completed",
        "dateCreated": "2026-10-22T16:20:19Z",
        "currencyCode": "USD",
        "total": 9.99,
        "productName": "Northwind Pro",
        "variantName": "1 month",
        "quantity": 1,
        "moreItems": 0,
        "imageUrl": null
      },
      {
        "id": "e9ae5h0p1ye-cd7fded3be6-1006662",
        "status": "pending",
        "dateCreated": "2026-10-22T16:20:19Z",
        "currencyCode": "USD",
        "total": 9.99,
        "productName": "Northwind Pro",
        "variantName": "1 month",
        "quantity": 1,
        "moreItems": 0,
        "imageUrl": null
      }
    ],
    "subscriptions": true,
    "support": false,
    "downloads": {
      "buttons": [],
      "guideUrl": "",
      "files": [],
      "instructions": [
        {
          "productName": "Northwind Pro",
          "variantName": "1 month",
          "text": "Paste the key under Help, Activate."
        }
      ],
      "general": "",
      "orders": [
        {
          "id": "bc44febe-0f25-4076-92eb-03a5045a57e7",
          "dateCreated": "2026-10-22T16:20:19Z",
          "products": [
            "Northwind Pro"
          ],
          "imageUrl": null,
          "files": [],
          "instructions": [
            {
              "productName": "Northwind Pro",
              "variantName": "1 month",
              "text": "Paste the key under Help, Activate."
            }
          ]
        }
      ]
    },
    "supportUrl": "https://example.com/support"
  }
}

{
  "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": {}
}

Customer API

Get the signed-in buyer

Everything the customer panel’s first page shows: the buyer’s email, what they have spent, their store balance, their 200 newest orders, and the downloads, files and setup instructions their paid orders hand over.

downloads.files and downloads.instructions are every paid order’s together. downloads.orders is the same an order at a time, newest first, as the customer panel shows it: each with what it bought, its own files and its own instructions. The store’s buttons and general notes go with every order.

affiliate is null unless the store has an affiliate programme the buyer is in or may join, and subscriptions says whether they have ever had one. Keys are not listed here: Get an order has them.

Needs the buyer’s token: Authorization: Bearer shoply_ct_..., from Sign in with the code.

It is counted for the buyer’s token: 300 reads in ten minutes.

GET

stores

{storeId}

customer

Node.js

import { ShoplyCustomer } from "@shoplygg/node";

const buyer = new ShoplyCustomer({ storeId: "YOUR_STORE_ID", token });

const result = await buyer.show();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shoply.gg/v1/stores/{storeId}/customer"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.shoply.gg/v1/stores/{storeId}/customer")

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": {
    "email": "grace@example.com",
    "customerSince": "2026-10-22T16:20:19Z",
    "balance": null,
    "affiliate": {
      "member": false,
      "canJoin": true
    },
    "totals": {
      "spent": [
        {
          "currencyCode": "USD",
          "amount": 9.99
        }
      ],
      "orders": 2,
      "keys": 1
    },
    "orders": [
      {
        "id": "bc44febe-0f25-4076-92eb-03a5045a57e7",
        "status": "completed",
        "dateCreated": "2026-10-22T16:20:19Z",
        "currencyCode": "USD",
        "total": 9.99,
        "productName": "Northwind Pro",
        "variantName": "1 month",
        "quantity": 1,
        "moreItems": 0,
        "imageUrl": null
      },
      {
        "id": "e9ae5h0p1ye-cd7fded3be6-1006662",
        "status": "pending",
        "dateCreated": "2026-10-22T16:20:19Z",
        "currencyCode": "USD",
        "total": 9.99,
        "productName": "Northwind Pro",
        "variantName": "1 month",
        "quantity": 1,
        "moreItems": 0,
        "imageUrl": null
      }
    ],
    "subscriptions": true,
    "support": false,
    "downloads": {
      "buttons": [],
      "guideUrl": "",
      "files": [],
      "instructions": [
        {
          "productName": "Northwind Pro",
          "variantName": "1 month",
          "text": "Paste the key under Help, Activate."
        }
      ],
      "general": "",
      "orders": [
        {
          "id": "bc44febe-0f25-4076-92eb-03a5045a57e7",
          "dateCreated": "2026-10-22T16:20:19Z",
          "products": [
            "Northwind Pro"
          ],
          "imageUrl": null,
          "files": [],
          "instructions": [
            {
              "productName": "Northwind Pro",
              "variantName": "1 month",
              "text": "Paste the key under Help, Activate."
            }
          ]
        }
      ]
    },
    "supportUrl": "https://example.com/support"
  }
}

{
  "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

Authorization

string

header

required

A buyer's token, from Sign in with the code: Authorization: Bearer shoply_ct_.... It reaches that buyer's own orders at one store, and no route that takes a key.

Path Parameters

storeId

string

required

The store's ID, from Settings, General in its dashboard. It is not a secret: a page may show it.

Response

It worked.

success

boolean

message

unknown

code

unknown

data

object

Show child attributes