Storefront messages

Read and customize localized storefront response messages.

Storefront messages are localized shopper-facing responses used by storefront and hosted-action workflows. They use translation scopes: read_translations for reads and write_translations for overrides.

Every message has a stable code and a platform default. An override replaces only one store locale. Templates must preserve exactly the placeholders declared by that code; resetting an override returns the effective message to the platform default.

Endpoints#

List storefront messages

GET read_translations

List storefront response messages and locale overrides.

Messages are keyed by stable code. The response distinguishes inherited defaults from merchant overrides and lists required placeholders.

Query parameters

Name	Type	Description
`locale`	`string`	Enabled store locale. Example: `en`
`namespace`	`string`	Message namespace. Example: `cart`
`surface`	`string`	Storefront surface. Example: `hosted_actions`
`search`	`string`	Search code or effective message. Example: `stock`
`page`	`integer`	Page number. Default: `1` Example: `1`
`limit`	`integer`	Page size. Example: `25`
`sort_by`	`string`	Sortable column. Example: `code`
`sort_direction`	`string`	Asc or desc. Example: `asc`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.

curl 'https://api-store.tringify.com/api/2025-01/storefront-messages?limit=25&locale=en&namespace=cart&page=1&search=stock&sort_by=code&sort_direction=asc&surface=hosted_actions' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/storefront-messages?limit=25&locale=en&namespace=cart&page=1&search=stock&sort_by=code&sort_direction=asc&surface=hosted_actions", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/storefront-messages?limit=25&locale=en&namespace=cart&page=1&search=stock&sort_by=code&sort_direction=asc&surface=hosted_actions",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"locales":[{"locale":"en","label":"English","native_name":"English","rtl":false,"is_default":true}],"selected_locale":"en","default_locale":"en","namespaces":["account"],"surfaces":["ctx","hosted_action"],"messages":[{"code":"STOREFRONT_CUSTOMER_LOGIN_SUCCESS","family":"action_message","namespace":"account","surfaces":["ctx","hosted_action"],"english_message":"Signed in.","default_message":"Signed in.","has_locale_default":true,"override_message":null,"effective_message":"Signed in.","placeholders":[],"overrideable":true,"template_max_length":500,"template_rune_length":0}],"total":1,"page":1,"limit":20,"limits":{"list_default_limit":20,"list_max_limit":200,"page_size_options":[20,50,100,200],"search_max_length":100,"template_max_runes":500}}}

Save a storefront message

PUT write_translations

Create or replace one localized message override.

The override must preserve exactly the placeholders declared for the message code.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`locale` required	`string`	Enabled store locale. Example: `en`
`code` required	`string`	Stable message code. Example: `STOREFRONT_CUSTOMER_LOGIN_SUCCESS`
`message_template` required	`string`	Localized message with required placeholders. Example: `Welcome back.`

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.

curl -X PUT 'https://api-store.tringify.com/api/2025-01/storefront-messages/overrides' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "STOREFRONT_CUSTOMER_LOGIN_SUCCESS",
  "locale": "en",
  "message_template": "Welcome back."
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/storefront-messages/overrides", {
  method: "PUT",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "code": "STOREFRONT_CUSTOMER_LOGIN_SUCCESS",
    "locale": "en",
    "message_template": "Welcome back."
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/storefront-messages/overrides",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "code": "STOREFRONT_CUSTOMER_LOGIN_SUCCESS",
        "locale": "en",
        "message_template": "Welcome back.",
    },
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"message":{"code":"STOREFRONT_CUSTOMER_LOGIN_SUCCESS","family":"action_message","namespace":"account","surfaces":["ctx","hosted_action"],"english_message":"Signed in.","default_message":"Signed in.","has_locale_default":true,"override_message":"Welcome back.","effective_message":"Welcome back.","placeholders":[],"overrideable":true,"updated_at":"Aug 3, 2026, 8:00 PM","template_max_length":500,"template_rune_length":13}}}

Reset a storefront message

DELETE write_translations

Remove one locale override and return to the platform default.

Pass the locale as a query parameter. The message code is URL encoded in the path.

Path parameters

Name	Type	Description
`code` required	`string`	Stable message code. Example: `STOREFRONT_CUSTOMER_LOGIN_SUCCESS`

Query parameters

Name	Type	Description
`locale` required	`string`	Enabled store locale. Example: `en`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

401 UNAUTHORIZED
Authorization header missing, malformed, or token invalid/expired.
402 SUBSCRIPTION_REQUIRED
The store does not have an active or trialing subscription.
403 STORE_API_SCOPE_REQUIRED
Token is valid but lacks the required scope for this call.
429 RATE_LIMITED
The token's request allowance is exhausted. Retry after the Retry-After header.

curl -X DELETE 'https://api-store.tringify.com/api/2025-01/storefront-messages/overrides/STOREFRONT_CUSTOMER_LOGIN_SUCCESS?locale=en' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/storefront-messages/overrides/STOREFRONT_CUSTOMER_LOGIN_SUCCESS?locale=en", {
  method: "DELETE",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.delete(
    "https://api-store.tringify.com/api/2025-01/storefront-messages/overrides/STOREFRONT_CUSTOMER_LOGIN_SUCCESS?locale=en",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{"success":true,"data":{"message":{"code":"STOREFRONT_CUSTOMER_LOGIN_SUCCESS","family":"action_message","namespace":"account","surfaces":["ctx","hosted_action"],"english_message":"Signed in.","default_message":"Signed in.","has_locale_default":true,"override_message":"Welcome back.","effective_message":"Welcome back.","placeholders":[],"overrideable":true,"updated_at":"Aug 3, 2026, 8:00 PM","template_max_length":500,"template_rune_length":13}}}