Skip to content

Update report settings

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

PATCH/preorders/settings/reports

Costs 2 rate-limit points · Rate limits

Update the merchant's preorder report preferences (Settings > Reports): the email to the merchant each time the remaining balance of a partially paid preorder is collected.

Deep partial. Returns the reports section.

Also searched asnotify me when payments are collectedpayment collection notice

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

  • notify_payment_collection_enabledboolean

    Email the merchant each time the remaining balance of a partially paid preorder is collected. A notice to the merchant, not to customers.

Returns

  • notify_payment_collection_enabledboolean
    Example: true

Errors

409
idempotency_key_in_progress

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

422
invalid_params

One or more fields failed the action's schema.

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.

PATCH/preorders/settings/reports
curl -X PATCH "https://app.stoqapp.com/api/v2/external/preorders/settings/reports" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "notify_payment_collection_enabled": true
  }'
Response
{
  "notify_payment_collection_enabled": true
}