Get templates

GET

/back_in_stock/templates/{key}

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

• Production

Read one back-in-stock notification’s email and SMS copy. key is “signup_thank_you” (sent right after a customer signs up), “restock_alert” (sent when the product restocks) or “reminder” (the follow-up). ?locale= picks the language of the copy (omit it for the shop default); the response names it in locale. Whether it sends, and when, is GET /back_in_stock/notification_settings.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

key

required

string

Query Parameters

locale

string

>= 1 characters

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

404

The resource does not exist for this shop, or the action path is not registered.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Offer not found"
  ]
}

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