Skip to content

Get shipping email

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

GET/preorders/templates/shipping_update

Costs 1 rate-limit point · Rate limits

Read the preorder shipping-update notification's email copy (it has no SMS). ?locale= picks the language (omit it for the shop default).

Change the copy with PATCH /preorders/templates/shipping_update. It is the default for the email that POST /preorders/orders/:id/send_shipping_update and /preorders/orders/bulk_send_shipping_update send, and that the reschedule_fulfillment and bulk_reschedule_fulfillment order actions send with send_shipping_update: true; each call can override subject, heading and body. STOQ never sends it on its own. A language with no translation of a field returns the shop default's text for it.

Also searched asshipping update email copy

Query parameters

  • localestring

    Language of the copy, such as fr or pt-BR. Omit for the shop's default language.

Returns

  • keystring
    Example: string
  • localestring
    Example: string
  • emailobject
    Show 6 child attributesHide child attributes
    • subjectstring
      Example: string
    • headingstring
      Example: string
    • bodystring
      Example: string
    • klaviyo_flow_namestring, nullable
      Example: string
    • klaviyo_flow_verifiedboolean
      Example: true
    • integrationnull

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
validation_failed

The request failed validation.

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.

GET/preorders/templates/shipping_update
curl "https://app.stoqapp.com/api/v2/external/preorders/templates/shipping_update" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "key": "string",
  "locale": "string",
  "email": {
    "subject": "string",
    "heading": "string",
    "body": "string",
    "klaviyo_flow_name": "string",
    "klaviyo_flow_verified": true,
    "integration": null
  }
}