Get summary

GET

/back_in_stock/reports/summary

curl --request GET \
  --url 'https://app.stoqapp.com/api/v2/external/back_in_stock/reports/summary?from=string&to=string&range=string&variant_id=45000000001&product_id=78000000001&channel=string&market_id=gid%3A%2F%2Fshopify%2FMarket%2F12345' \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

Back-in-stock totals over a window: signups created, signups waiting now, signups and distinct customers notified in the window, attributed orders, conversion rate and recovered revenue. range=all_time covers the shop’s whole history.

Note: Unscoped requests match the Back in Stock Overview: all-time signups, orders and revenue come from the shop’s lifetime counters, a window’s from the daily rollups plus today (source says which). pending and pending_by_channel are the waitlist now and ignore the window. last_notified_at is the latest send for the scope, whatever the window.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

from

Example

string

to

Example

string

range

Example

string

variant_id

Example

45000000001

product_id

Example

78000000001

channel

Example

string

market_id

Example

gid://shopify/Market/12345

Responses

200

Success — the requested resource.

Media typeapplication/json

object

Example ^generated

{}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

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

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}