Skip to content

Get a notification

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

GET/back_in_stock/notification_settings/{key}

Costs 1 rate-limit point · Rate limits

Read whether one back-in-stock notification sends and, for the reminder, when. key is "signup_thank_you", "restock_alert" or "reminder".

GET /back_in_stock/notification_settings reads all three at once; PATCH this path to change one. For restock_alert, enabled is the shop's "Send automatic notification" switch: false means no automatic alerts go out when stock returns. after_n_days is returned for reminder only. A key the shop has no notification for gives 404 not_found; a key outside the three gives 422 invalid_params. The copy is GET /back_in_stock/templates/:key.

Also searched asis the reminder onis the restock alert onreminder timing

Path parameters

  • keystringRequired

    Which notification: signup_thank_you, restock_alert or reminder.

    One of signup_thank_yourestock_alertreminder

Returns

The notification setting object.

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/back_in_stock/notification_settings/{key}
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/notification_settings/{key}" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "key": "string",
  "enabled": true,
  "after_n_days": 1
}