Get confirmation settings
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/notification_settings/confirmationCosts 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
keystringExample:stringemail_enabledbooleanExample:truesms_enabledbooleanExample:truecustomer_cancellation_enabledbooleanExample:true
Errors
not_foundThe path is valid but nothing with that id exists in this store.
validation_failedThe 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.
curl "https://app.stoqapp.com/api/v2/external/preorders/notification_settings/confirmation" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/notification_settings/confirmation", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/preorders/notification_settings/confirmation",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/notification_settings/confirmation")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"key": "string",
"email_enabled": true,
"sms_enabled": true,
"customer_cancellation_enabled": true
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}