Skip to content

Get report settings

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

GET/preorders/settings/reports

Costs 1 rate-limit point · Rate limits

The merchant's preorder report preferences (Settings > Reports): whether STOQ emails the merchant each time the remaining balance of a partially paid preorder is collected.

Change it with PATCH /preorders/settings/reports. The email goes to the report address, scheduled_reports.email on GET /back_in_stock/settings/alerts. It is off on a new shop. A failed collection always emails the merchant, whatever this says.

Also searched aspreorder report settings

Returns

  • notify_payment_collection_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/settings/reports
curl "https://app.stoqapp.com/api/v2/external/preorders/settings/reports" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "notify_payment_collection_enabled": true
}