Update storefront text

PATCH

/preorders/settings/storefront_text

curl --request PATCH \
  --url https://app.stoqapp.com/api/v2/external/preorders/settings/storefront_text \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "locale": "fr", "currency_format": "string", "button": "string", "modal": "string" }'

• Production

Update the shop-wide preorder storefront text: the currency format, the button’s out-of-stock and add-to-cart text, and the preorder modal’s continue and cancel buttons and error heading. Shared by every preorder offer, not per offer.

Note: Deep partial. Shop-wide: one change applies to every preorder offer. The per-offer Preorder button text and per-state overrides are on the offer’s widget and advanced settings. Text fields are written in locale (optional); currency_format is not translated.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

object

locale

currency_format

button

modal

Example

{
  "locale": "fr",
  "currency_format": "string",
  "button": "string",
  "modal": "string"
}

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object

job_id

string

status_url

string

Example

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

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