Skip to content

Get confirmation settings

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

GET/preorders/notification_settings/confirmation

Costs 1 rate-limit point · Rate limits

Read whether the preorder confirmation email and SMS send, and whether customers may cancel their preorder from the confirmation.

Change them with PATCH /preorders/notification_settings/confirmation; the copy is GET /preorders/templates/confirmation. STOQ checks the switches when a new preorder order comes in, so turning email or SMS on sends nothing for orders already placed, and the SMS goes only to orders with a phone number. With customer_cancellation_enabled false the email has no cancel link and an old link no longer cancels. Whether STOQ has paused a channel for the shop is sending_paused on GET /preorders/notification_settings.

Also searched asshow preorder confirmation switches

Returns

  • keystring
    Example: string
  • email_enabledboolean
    Example: true
  • sms_enabledboolean
    Example: true
  • customer_cancellation_enabledboolean
    Example: true

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/notification_settings/confirmation
curl "https://app.stoqapp.com/api/v2/external/preorders/notification_settings/confirmation" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "key": "string",
  "email_enabled": true,
  "sms_enabled": true,
  "customer_cancellation_enabled": true
}