Update the settings

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

PATCH/back_in_stock/settings

Costs 2 rate-limit points · Rate limits

Update back-in-stock settings for the shop: channels, delivery, compliance, tagging, merchant alerts and the signup widget, in one request.

Accepts any combination of section blobs: channels, delivery, compliance, tagging, alerts, widget: deep partial. Every section is validated first; any error rejects the whole request (422, keyed "section.path") and nothing is saved. Unknown keys are rejected. widget takes the PATCH /back_in_stock/settings/widget body, with widget.locale for its text. Turning each notification on or off is PATCH /back_in_stock/notification_settings/:key; the email sender and SMS number are PATCH /account/sending; market setup is PATCH /account/markets.

Also searched asedit settingschange settingsmodify settingsupdate back in stock settingsconfigure notifications

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

channelsstring
Example: string
deliverystring
Example: string
compliancestring
Example: string
taggingstring
Example: string
alertsstring
Example: string
widgetstring
Example: string

Errors

401

Missing or invalid X-Auth-Token.

409

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

422

The request failed validation.

429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Every error has the same shape: see Errors.

PATCH/back_in_stock/settings

curl -X PATCH "https://app.stoqapp.com/api/v2/external/back_in_stock/settings" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channels": "string",
    "delivery": "string",
    "compliance": "string",
    "tagging": "string",
    "alerts": "string",
    "widget": "string"
  }'

const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/settings", {
  method: "PATCH",
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "channels": "string",
    "delivery": "string",
    "compliance": "string",
    "tagging": "string",
    "alerts": "string",
    "widget": "string"
  }),
});
const data = await res.json();

import os
import requests

res = requests.patch(
    "https://app.stoqapp.com/api/v2/external/back_in_stock/settings",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
    json={
        "channels": "string",
        "delivery": "string",
        "compliance": "string",
        "tagging": "string",
        "alerts": "string",
        "widget": "string"
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/settings")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
  channels: "string",
  delivery: "string",
  compliance: "string",
  tagging: "string",
  alerts: "string",
  widget: "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "A request with this Idempotency-Key is still running"
  ],
  "code": "idempotency_key_in_progress",
  "details": [
    {
      "code": "idempotency_key_in_progress",
      "message": "A request with this Idempotency-Key is still running",
      "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
    }
  ]
}