Cancel accepted purchases and settle the result

Purpose

A customer can stop or undo an accepted purchase through a planned cancellation. Domain work, approval and money remain connected to the affected lines.

How It Works

The requester selects the accepted order lines they want to cancel. Commerce obtains application advice and presents a plan with allowed quantities, financial estimates and approval needs. Requests requiring review wait for an authorized person. Execution coordinates the original delivery, held resources and financial adjustment. The requester can follow the cancellation’s progress rather than treating a refund as the whole operation. Unavailable or refused domain work remains visible through the document and operational handling.

Relationships

Order inspection supplies the purchase, selling applications advise on reversal, entitlements and reservations release rights and capacity, and Accounting settles the money.

Show evidence (sources, provenance, origins, pinned commits)

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes: Cancellation settles the affected purchase line while retaining the rest of the sale.Required domain cancellation completes before its financial adjustment.
Surfaces: consoleportalapi
Intent sources: services-commerce:docs/milestones/COMM-M1-set-up-what-you-sell.md#D13

Controls

30 controls apply, from the corpus control catalogue.

TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-005 TC-AZ-006 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-TEN-004 TC-CRY-001 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-AVL-004 TC-MON-002 TC-PI-001 TC-PI-003 TC-PI-004 TC-PI-005 TC-VEN-001 TC-VEN-002 TC-VEN-003 TC-PRV-001 TC-PRV-002

Permissions

Key	Checked at	Scope
`commerce.cancellations.read`	api	tenant
`commerce.cancellations.create`	api	tenant
`commerce.cancellations.update`	api	tenant
`commerce.cancellations.approve`	api	tenant
`commerce.cancellations.override`	service	tenant

Business Rules

15 rules, 15 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

Id	Rule	Kind	Enforced at	Provenance
`01`must prove Proposed	Cancellation requires an accepted order and authorized parties, rejecting placed orders, unauthorized members, readers and records in another workspace. proved by `ATS-COM-ORD-009-09`, `ATS-COM-ORD-010-12`, `ATS-COM-ORD-013-15`, `ATS-COM-ORD-014-01`, `ATS-COM-ORD-014-19`, `TST-COM-ORD-076`	validation	api, service	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#refuses a placed order 409 order_not_cancellable, another member 403 not_your_party, a reader 403 permission_missing, another tenant 404
`02`must prove Proposed	The request immediately combines application cancellation advice with money and approval facts into a plan, and can execute that plan in the request when no approval is needed. proved by `ATS-COM-ORD-014-02`, `TST-COM-ORD-076`	lifecycle	service	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#answers 200 with the document completed in the one request: allowed, executed, the money moved, the customer status cancelled
`03`must prove Proposed	Cancelling waiting delivery closes the affected line and increases its cancelled quantity, with the order becoming cancelled when every line is cancelled. proved by `ATS-COM-ORD-014-03`, `TST-COM-ORD-076`	lifecycle	service, database	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#cancels the line’s waiting fulfil obligation itself, grows quantity_cancelled and closes the line; the mug untouched, the order still accepted
`04`must prove Proposed	The application undoes delivered work through a cancellation obligation, and the financial action waits for that domain cancellation when required. proved by `ATS-COM-ORD-013-14`, `ATS-COM-ORD-014-04`, `ATS-COM-ORD-014-17`, `TST-COM-ORD-076`	policy	service	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#is delivered by the worker to the participant’s cancel, which settles the document completed and runs the refund after the domain (ADR-13)
`05`must prove Proposed	Credit uses cancelled units’ discounted value and tax within the remaining invoice cap, while the refund estimate separately applies funding, refundable fraction, non-refundable amounts and fees. proved by `ATS-COM-ORD-006-15`, `ATS-COM-ORD-014-05`, `TST-COM-ORD-076`, `TST-COM-ORD-131`	calculation	service	test services-commerce:modules/orders/tests/unit/cancellations/cancellation-plan.spec.js#credits 2 of 5 units at the discounted amount with the tax share, estimates the refund from the funded part, and approves the document
`06`must prove Proposed	Fee calculation prefers application advice, then frozen line terms, using the order’s fee product as a fallback and waiving an unbillable fee with a warning before refunding the remaining freed money. proved by `ATS-COM-ORD-014-06`, `TST-COM-ORD-076`, `TST-COM-ORD-131`	calculation	service	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#raises the fee invoice, applies the freed money to it and refunds the remainder
`07`must prove Proposed	Application approval requirements or a refund exceeding the configured threshold hold the request for review and block overlapping line requests until approval and execution. proved by `ATS-COM-ORD-014-07`, `ATS-COM-ORD-015-14`, `TST-COM-ORD-076`, `TST-COM-ORD-131`	policy	service	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#holds staff’s request for approval (participant_requires_approval) and refuses a second request on the line 409 line_already_cancelling (B38)
`08`must prove Proposed	A cancellation deadline blocks customer requests, but a reasoned administrator override can proceed subject to remaining approval requirements; ordinary clerks cannot override. proved by `ATS-COM-ORD-014-08`, `TST-COM-ORD-076`	permission	service	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#allows an administrator’s override at once with its reason, and refuses a clerk’s override 403 override_not_permitted
`09`must prove Proposed	Goods handed to the carrier require a return instead of cancellation. proved by `ATS-COM-ORD-014-09`, `ATS-COM-ORD-014-18`, `TST-COM-ORD-076`	policy	service	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#answers must_return with shipment_handed_off once the shipping fence says the unit shipped
`10`must prove Proposed	Cancellation approval and rejection require console access and approval authority, which a portal buyer or an ordinary clerk lacks. proved by `ATS-COM-ORD-014-10`, `TST-COM-ORD-076`	permission	api	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#refuses a member on the console approve route 403, and a clerk approving 403 permission_missing
`11`must prove Proposed	The requester can withdraw an approved cancellation before execution, freeing the line for a later request. proved by `ATS-COM-ORD-014-13`, `TST-COM-ORD-076`	lifecycle	service	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#lets the member withdraw an approved, unexecuted request (a second request refused meanwhile), then request again
`12`must prove Proposed	Cancellation releases an application’s committed capacity claim and its reservation so another purchase can use the capacity. proved by `ATS-COM-ORD-014-14`, `TST-COM-ORD-076`	lifecycle	service	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#releases the claim through the participant’s function: one seat committed before, none after, the ledger released for cancellation
`13`must prove Proposed	The order’s money summary refreshes to show cancellation credits immediately after cancellation. proved by `ATS-COM-ORD-009-08`, `ATS-COM-ORD-010-11`, `ATS-COM-ORD-014-15`, `ATS-COM-ORD-014-16`, `TST-COM-ORD-076`	policy	service	test services-commerce:modules/orders/tests/e2e/cancellations.e2e.spec.js#shows the cancellation’s credit on the order’s money mirror at once, read right after the cancel
`14`must prove Proposed	The recorded product decision restores a personal single-use code by default when its purchased line is cancelled. origin: services-commerce:docs/milestones/COMM-M1-set-up-what-you-sell.md#D13 no proof recorded yet	policy	service	documented services-commerce:docs/milestones/COMM-M1-set-up-what-you-sell.md#D13
`15`must prove Proposed	A delivery that operates on a whole waiting line refuses cancellation of fewer units than the remaining quantity. proved by `ATS-COM-ORD-014-12`, `TST-COM-ORD-131`	validation	service	observed services-commerce:modules/orders/services/cancellations/cancellation-plan.ts:planLine

Scenarios

Id	Given	When	Then	Provenance
`01`	A member no longer wants one of two purchased shirts.	Staff cancel the unwanted line.	The illustrative refund concerns that shirt alone while the remainder continues.	unknown FND-COM-ORD-032

Planning

Implementation

Cancel accepted purchases and settle the result ​

Purpose ​

How It Works ​

Relationships ​