Get widget

GET

/back_in_stock/settings/widget

curl --request GET \
  --url 'https://app.stoqapp.com/api/v2/external/back_in_stock/settings/widget?locale=fr' \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

Read the storefront back-in-stock signup widget configuration: the notify-me button, where it appears, and the signup form’s copy, styling and inputs.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

locale

Example

fr

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