Node.js

import Shoply from "@shoplygg/node";

const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

const result = await shoply.finance.profit();

package main

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

func main() {

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

	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}/finance/profit")

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": {
    "period": {
      "from": "2026-10-01",
      "to": "2026-10-22",
      "label": "1 to 22 October 2026",
      "previousFrom": "2026-09-01",
      "previousTo": "2026-09-22",
      "previousLabel": "1 to 22 September 2026"
    },
    "currency": "USD",
    "now": {
      "netSales": 78.98,
      "orders": 4,
      "costOfGoods": 0,
      "fees": 1.72,
      "commission": 0,
      "expenses": 0,
      "profit": 77.26,
      "margin": 97.8,
      "units": 4,
      "uncosted": 4
    },
    "previous": {
      "netSales": 0,
      "orders": 0,
      "costOfGoods": 0,
      "fees": 0,
      "commission": 0,
      "expenses": 0,
      "profit": 0,
      "margin": null,
      "units": 0,
      "uncosted": 0
    },
    "perOrder": 19.32,
    "average": 19.75,
    "breakEven": {
      "orders": 0,
      "reachedOn": null,
      "each": 19.32
    },
    "fees": {
      "rated": true,
      "unrated": [
        "Custom c009621ccc3e9d74",
        "PayPal"
      ]
    },
    "months": [
      {
        "month": "2025-11",
        "sales": 0,
        "profit": 0
      },
      {
        "month": "2025-12",
        "sales": 0,
        "profit": 0
      }
    ],
    "products": [
      {
        "id": "f463e265-097a-4235-bc2f-5239b19a9874",
        "name": "Northwind Pro",
        "image": null,
        "expenses": 0,
        "variants": [
          {
            "id": "00e1d395-9ba2-4db3-900a-cb5e2811a2a9",
            "label": "1 month",
            "price": 9.99,
            "costAmount": 2.5,
            "costPercent": null,
            "sold": 4,
            "sales": 78.99,
            "cost": 0,
            "uncosted": 4,
            "profit": null
          },
          {
            "id": "defa3f9e-8aaf-423d-a0a6-fe65ab8043d4",
            "label": "1 year",
            "price": 79,
            "costAmount": null,
            "costPercent": null,
            "sold": 0,
            "sales": 0,
            "cost": 0,
            "uncosted": 0,
            "profit": 0
          }
        ],
        "sold": 4,
        "sales": 78.99,
        "cost": 0,
        "uncosted": 4,
        "profit": null,
        "costSet": "some"
      }
    ]
  }
}

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

Finance

Get profit

What the store kept in a period and how that is made up, beside the period before: net sales, the cost of goods, payment fees, affiliate commission, expenses and net profit, twelve months of sales and profit, and every product with what each variant sold and cost. A sale is what the buyer paid: at its sale price, after its coupon and any affiliate link’s discount, without tax. Payment fees are worked out from the rates the store typed, never read from a provider, so they can be slightly off. A store makes at most 20 reports every 10 minutes, counting this one, the other report, their files and the dashboard’s Generate Report together: after that the answer is 429. Refused with business_details_required until the store has its business details.

Needs the finance.read permission (Read Finance). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key.

GET

stores

{storeId}

finance

profit

Node.js

import Shoply from "@shoplygg/node";

const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

const result = await shoply.finance.profit();

package main

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

func main() {

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

	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}/finance/profit")

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": {
    "period": {
      "from": "2026-10-01",
      "to": "2026-10-22",
      "label": "1 to 22 October 2026",
      "previousFrom": "2026-09-01",
      "previousTo": "2026-09-22",
      "previousLabel": "1 to 22 September 2026"
    },
    "currency": "USD",
    "now": {
      "netSales": 78.98,
      "orders": 4,
      "costOfGoods": 0,
      "fees": 1.72,
      "commission": 0,
      "expenses": 0,
      "profit": 77.26,
      "margin": 97.8,
      "units": 4,
      "uncosted": 4
    },
    "previous": {
      "netSales": 0,
      "orders": 0,
      "costOfGoods": 0,
      "fees": 0,
      "commission": 0,
      "expenses": 0,
      "profit": 0,
      "margin": null,
      "units": 0,
      "uncosted": 0
    },
    "perOrder": 19.32,
    "average": 19.75,
    "breakEven": {
      "orders": 0,
      "reachedOn": null,
      "each": 19.32
    },
    "fees": {
      "rated": true,
      "unrated": [
        "Custom c009621ccc3e9d74",
        "PayPal"
      ]
    },
    "months": [
      {
        "month": "2025-11",
        "sales": 0,
        "profit": 0
      },
      {
        "month": "2025-12",
        "sales": 0,
        "profit": 0
      }
    ],
    "products": [
      {
        "id": "f463e265-097a-4235-bc2f-5239b19a9874",
        "name": "Northwind Pro",
        "image": null,
        "expenses": 0,
        "variants": [
          {
            "id": "00e1d395-9ba2-4db3-900a-cb5e2811a2a9",
            "label": "1 month",
            "price": 9.99,
            "costAmount": 2.5,
            "costPercent": null,
            "sold": 4,
            "sales": 78.99,
            "cost": 0,
            "uncosted": 4,
            "profit": null
          },
          {
            "id": "defa3f9e-8aaf-423d-a0a6-fe65ab8043d4",
            "label": "1 year",
            "price": 79,
            "costAmount": null,
            "costPercent": null,
            "sold": 0,
            "sales": 0,
            "cost": 0,
            "uncosted": 0,
            "profit": 0
          }
        ],
        "sold": 4,
        "sales": 78.99,
        "cost": 0,
        "uncosted": 4,
        "profit": null,
        "costSet": "some"
      }
    ]
  }
}

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

Authorization

string

header

required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Path Parameters

storeId

string

required

The store's ID. A key reaches the store it was made in: GET /key answers which.

Query Parameters

range

enum<string>

default:this_month

The period.

Available options:

today,

yesterday,

7d,

30d,

this_week,

last_week,

this_month,

last_month,

this_year

from

string

The first day of a period of your own, as YYYY-MM-DD. With to, in place of range.

string

Its last day, as YYYY-MM-DD.

string

The time zone those days are in, as an IANA name. Left out, UTC.

Example:

"Europe/Berlin"

Response

It worked.

success

boolean

message

unknown

code

unknown

data

object

Show child attributes