List notifications

GET

/back_in_stock/notifications

curl --request GET \
  --url 'https://app.stoqapp.com/api/v2/external/back_in_stock/notifications?channel=email&status=sent&group_by=product&variant_id=45000000001&product_id=78000000001&from=string&to=string&page=string&per_page=string' \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

List back-in-stock notifications (the send log) in this shop, paginated.

Note: status=blocked surfaces sends that did not go out, with blocked_reason (the stored text), blocked_reason_code and blocked_reason_label. Every response has a summary (total, sent, blocked, blocked_by_reason) that counts every row matching the filters, not only this page. group_by=product returns counts per product (sent, blocked, and blocked by reason code) instead of rows, paginated by product. A bare from/to date is that whole day in the shop’s time zone.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

channel

Allowed values: email sms push

Example

email

status

Allowed values: sent blocked

Example

sent

group_by

Allowed values: product

Example

product

variant_id

Example

45000000001

product_id

Example

78000000001

from

Example

string

to

Example

string

page

Example

string

per_page

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