Retrieve product revenue

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/back_in_stock/reports/product_revenue

Costs 1 rate-limit point · Rate limits

Revenue, units and orders from back-in-stock alerts per variant (or product), as the dashboard's revenue table.

revenue is the line revenue of the alerted items only (not whole orders), so rows add up to the total without overlap. units_sold is item quantity; orders is distinct orders containing the item. image_url is the variant's stored image, else the product's (null if none is stored).

Also searched asrevenue by productwhich products recovered revenueback in stock product revenuetop selling restocked productsunits sold from alerts

Query parameters

group_bystring
One of variantproduct
fromstring
tostring
rangestring
sort_bystring
directionstring
pagestring
per_pagestring

Errors

401

Missing or invalid X-Auth-Token.

422

The request failed validation.

429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Every error has the same shape: see Errors.

Example

GET/back_in_stock/reports/product_revenue

curl "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/product_revenue" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/product_revenue", {
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/product_revenue",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/product_revenue")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

GET/back_in_stock/reports/product_revenue

curl "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/product_revenue?group_by=variant" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/product_revenue?group_by=variant", {
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.stoqapp.com/api/v2/external/back_in_stock/reports/product_revenue?group_by=variant",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/reports/product_revenue?group_by=variant")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}