Skip to content

Update shipping email

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

PATCH/preorders/templates/shipping_update

Costs 2 rate-limit points · Rate limits

Update the shipping-update email STOQ sends when a preorder ships late or its date changes: its subject, heading, body and optional Klaviyo flow. The body is the GET shape, email{...}; an optional body locale writes the copy in that language only (omit it for the shop default).

Deep partial: absent fields are unchanged, unknown or read-only keys are rejected. Errors are 422 keyed "template.<path>". Returns the template.

Also searched aschange shipping update email

Headers

  • Idempotency-Keystring

    A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Request body

  • emailobject

    Copy of the email sent when a preorder's shipping date changes.

    Show 4 child attributesHide child attributes
    • subjectstring

      Email subject of the shipping-update email. Liquid variables such as {{order.name}} work.

    • headingstring

      Heading at the top of the shipping-update email.

    • bodystring

      Message body of the shipping-update email.

    • klaviyo_flow_namestring

      Klaviyo flow to trigger for the shipping update instead of sending it here. Only used while the email platform is Klaviyo.

  • localestring

    Language the translated fields are written in, such as 'fr' or 'pt-BR'. Omitted: the shop's default language. Untranslated fields ignore it.

Returns

  • keystring
    Example: shipping_update
  • localestring
    Example: en
  • emailobject
    Show 6 child attributesHide child attributes
    • subjectstring
      Example: Shipping update for Order {{order.name}}
    • headingstring
      Example: Shipping update for Order {{order.name}}
    • bodystring
      Example: Thanks for preordering from {{shop.name}}. Your preorder …
    • klaviyo_flow_namestring, nullable
    • klaviyo_flow_verifiedboolean
      Example: false
    • integrationnull

Errors

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_params

One or more fields failed the action's schema.

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.

PATCH/preorders/templates/shipping_update
curl -X PATCH "https://app.stoqapp.com/api/v2/external/preorders/templates/shipping_update" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": {
      "body": "Thanks for preordering from {{shop.name}}. Your preorder in order {{order.name}} is running a little late. We'\''ll email you again as soon as it ships."
    }
  }'
Response
{
  "key": "shipping_update",
  "locale": "en",
  "email": {
    "subject": "Shipping update for Order {{order.name}}",
    "heading": "Shipping update for Order {{order.name}}",
    "body": "Thanks for preordering from {{shop.name}}. Your preorder in order {{order.name}} is running a little late. We'll email you again as soon as it ships.",
    "klaviyo_flow_name": null,
    "klaviyo_flow_verified": false,
    "integration": null
  }
}