Get wait duration

GET

/back_in_stock/reports/wait_duration

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

• Production

How long back-in-stock shoppers have been waiting: median wait days, the longest wait, and a binned wait-time histogram (paid plans only). Also returns total_waiting, the current pending/opted-in signup count.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

variant_id

Example

45000000001

product_id

Example

78000000001

market_id

Example

gid://shopify/Market/12345

from

Example

string

to

Example

string

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"
  ]
}