Get summary

GET

/preorders/reports/summary

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

• Production

High-level overview of preorder activity over a date window.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

range

null | string

Example

string

from

Example

string

to

Example

string

offer_id

Example

string

offer_ids

Example

[
  "string"
]

product_id

Example

78000000001

variant_id

Example

45000000001

market_id

Example

gid://shopify/Market/12345

currency

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