Update reports

PATCH

/preorders/settings/reports

curl --request PATCH \
  --url https://app.stoqapp.com/api/v2/external/preorders/settings/reports \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "notify_payment_collection_enabled": true }'

• Production

Update the merchant’s preorder report preferences (Settings > Reports): the email to the merchant when balances of partially paid preorders are collected automatically.

Note: Deep partial. Returns the reports section.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

object

notify_payment_collection_enabled

Email the merchant when STOQ automatically collects the remaining balance of partially paid preorders. A notice to the merchant, not to customers.

boolean

Example

{
  "notify_payment_collection_enabled": true
}

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

Saved. Returns the updated section, with also_changed for cascades.

Media typeapplication/json

object

Example ^generated

{}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

Invalid fields, keyed by canonical section paths. Nothing was saved.

Media typeapplication/json

object

errors

required

object

key

additional properties

Array<string>

Example ^generated

{
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

429

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

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}