Customer Cancel Reasons

Reference for the customer_cancel_reasons resource. Requests follow the conventions in Requests and Responses; fields you receive and may write are filtered by your user's permissions, so responses can contain a subset of the fields below.

Operations

Not available as a standard REST operation for this resource: create, update, delete — such requests return 402 feature_not_enabled or 403 permission_denied.

How it works

customer_cancel_reasons is the read-only catalog of cancellation reasons — the valid customer_cancel_reason_id values on a customer cancel (optional). dealer_code is the partner/central-station code when the reason maps to one.

Visible to any caller holding Customer Sale Info or Cancel Customer.

curl "https://portal.securitytrax.com/acme/user/v4/customer_cancel_reasons?name=Moved" \
  -H "Authorization: Bearer stx_acme_..."

Filters: name and dealer_code (each matches anywhere), active (true / false / all; default true). Sort by id, name, or dealer_code; GET /{id} fetches one, including an off reason. Soft-deleted rows return 404 by id and are omitted from the list.

Note. The list matches the in-app picker: on reasons only unless you pass ?active=false or ?active=all. See Filtering collections.

Fields

Fields are grouped by the permission that gates them. A group you may not view is absent from responses; a group you may not write is rejected with 422 when sent in a write.

Customer Cancel Reason

View: any of: Customer Sale Info; Customer Cancel.

Pagination

The list endpoint uses client-controlled offset pagination: ?page= (1-based) and ?per_page= (default 25, max 100). The response mirrors meta.pagination (page, per_page, total, last_page) and sends an RFC5988 Link header; follow rel="next" to walk pages. See Pagination.

Filters

The list endpoint accepts these query-param filters: name, dealer_code, active. An unsupported filter parameter returns 422. See Filtering collections for matching semantics.

Sorting

GET .../customer_cancel_reasons?sort= orders the list by: id, name, dealer_code. Prefix a field with - for descending; comma-separate for tie-breakers. An unsupported field returns 422. See Sorting collections.

Related

• Requests and Responses — envelope, errors, pagination, and rate limits.
• Authentication — API access tokens and the Authorization header.