Skip to content

Get confirmation email

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

GET/preorders/templates/confirmation

Costs 1 rate-limit point · Rate limits

Read the preorder confirmation notification's email and SMS copy. ?locale= picks the language (omit it for the shop default); the response names it in locale. Whether it sends is GET /preorders/notification_settings/confirmation.

Change the copy with PATCH /preorders/templates/confirmation. The copy uses Liquid variables such as {{order.name}} and {{shop.name}}. A language with no translation of a field returns the shop default's text for it. integration is set when the shop sends that channel through Klaviyo, Postscript or Shopify Flow, and klaviyo_flow_name is the Klaviyo flow it uses then. 404 not_found when the shop has no single preorder confirmation template.

Also searched aspreorder confirmation email copypreorder confirmation sms copyget preorder templateshow preorder emaillocalized preorder notification template

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 14 child attributesHide child attributes
    • subjectstring
      Example: string
    • preheadernull
    • headingstring
      Example: string
    • bodystring
      Example: string
    • footerstring
      Example: string
    • buttonobject
      Show 4 child attributesHide child attributes
      • textstring
        Example: string
      • background_colorstring
        Example: string
      • text_colorstring
        Example: string
      • radiusinteger
        Example: 1
    • colorsobject
      Show 3 child attributesHide child attributes
      • backgroundstring
        Example: string
      • sectionstring
        Example: string
      • textstring
        Example: string
    • radiusinteger
      Example: 1
    • cssnull
    • reviewsobject
      Show 4 child attributesHide child attributes
      • enabledboolean
        Example: true
      • countinteger
        Example: 1
      • min_ratinginteger
        Example: 1
      • titlestring
        Example: string
    • socialobject
      Show 8 child attributesHide child attributes
      • facebooknull
      • instagramnull
      • pinterestnull
      • twitternull
      • tiktoknull
      • whatsappnull
      • youtubenull
      • icon_colorstring
        Example: string
    • klaviyo_flow_namestring, nullable
      Example: string
    • klaviyo_flow_verifiedboolean
      Example: true
    • integrationnull
  • smsobject
    Show 5 child attributesHide child attributes
    • bodystring
      Example: string
    • klaviyo_flow_namestring, nullable
      Example: string
    • klaviyo_flow_verifiedboolean
      Example: true
    • postscript_flow_verifiedboolean
      Example: true
    • integrationnull

Errors

404
not_found

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

422
invalid_params

One or more fields failed the action's schema.

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/confirmation
curl "https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "key": "string",
  "locale": "string",
  "email": {
    "subject": "string",
    "preheader": null,
    "heading": "string",
    "body": "string",
    "footer": "string",
    "button": {
      "text": "string",
      "background_color": "string",
      "text_color": "string",
      "radius": 1
    },
    "colors": {
      "background": "string",
      "section": "string",
      "text": "string"
    },
    "radius": 1,
    "css": null,
    "reviews": {
      "enabled": true,
      "count": 1,
      "min_rating": 1,
      "title": "string"
    },
    "social": {
      "facebook": null,
      "instagram": null,
      "pinterest": null,
      "twitter": null,
      "tiktok": null,
      "whatsapp": null,
      "youtube": null,
      "icon_color": "string"
    },
    "klaviyo_flow_name": "string",
    "klaviyo_flow_verified": true,
    "integration": null
  },
  "sms": {
    "body": "string",
    "klaviyo_flow_name": "string",
    "klaviyo_flow_verified": true,
    "postscript_flow_verified": true,
    "integration": null
  }
}