Clear an unaccepted order and return its resources

Purpose

Staff clear a sale that cannot reach acceptance and account for resources and money already attached to it. The order retains its history after it is voided.

How It Works

An administrator opens the unpaid order and supplies a reason to void it. Commerce verifies that the order still permits this intervention. The void releases the associated resources and records what it clears. Accounting receives the follow-on invoice or refund work appropriate to the amounts already processed. Failure in that follow-on work remains distinguishable from the committed void. Window-expiry processing can perform the same clearing as a system action.

Relationships

Placement supplies claims and order history; billing and Accounting provide invoice clearing and money returns; promotion use is released with the void.

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: Window-expiry processing releases an unpaid order’s stock and redemption uses.Voiding a partly paid order returns its captured payments through their original treatment.
Surfaces: consoleapijob
Intent sources: services-commerce:docs/milestones/plans/COMM-M2-plan.md#A2services-commerce:docs/milestones/plans/COMM-M2-plan.md#A8services-commerce:docs/milestones/plans/COMM-M2-plan.md#2. Scope

Controls

32 controls apply, from the corpus control catalogue.

TC-IAM-006 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-DAT-004 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-AVL-004 TC-MON-001 TC-MON-002 TC-MON-004 TC-PI-001 TC-PI-002 TC-PI-003 TC-PI-004 TC-PI-005 TC-PRV-001 TC-PRV-002

Permissions

Key	Checked at	Scope
`commerce.orders.void`	api	tenant

Business Rules

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

Id	Rule	Kind	Enforced at	Provenance
`01`must prove Confirmed	A console void requires the void permission and a reason of no more than 500 characters; portal buyers cannot use it. origin: services-commerce:docs/milestones/plans/COMM-M2-plan.md#2. Scope proved by `ATS-COM-ORD-001-20`, `ATS-COM-ORD-008-01`, `ATS-COM-ORD-008-14`, `TST-COM-ORD-032`, `TST-COM-ORD-137`	permission	api, service	test services-commerce:modules/checkout/tests/e2e/order-void.e2e.spec.js#refuses a reader without commerce.orders.void, 403 permission_missing, and a portal member the route
`02`must prove Confirmed	Only orders still placed can be voided, with accepted, payment-uncertain and already voided orders refused. origin: services-commerce:docs/milestones/plans/COMM-M2-plan.md#2. Scope proved by `ATS-COM-ORD-008-02`, `TST-COM-ORD-032`	validation	service	test services-commerce:modules/checkout/tests/e2e/order-void.e2e.spec.js#refuses a second void, 409 order_not_voidable, and a read answers the order voided
`03`must prove Confirmed	Voiding releases the applications’ resource claims and reservation records, cancels pending delivery obligations and records the release in order history. origin: services-commerce:docs/milestones/plans/COMM-M2-plan.md#A2 proved by `ATS-COM-ORD-008-03`, `ATS-COM-ORD-008-13`, `TST-COM-ORD-029`, `TST-COM-ORD-032`	lifecycle	service, database	test services-commerce:modules/checkout/tests/e2e/order-void.e2e.spec.js#released the participant’s claim, the ledger and the obligations
`04`must prove Confirmed	Voiding releases the order’s redeemed promotion and code uses. origin: services-commerce:docs/milestones/plans/COMM-M2-plan.md#A8 proved by `ATS-COM-ORD-008-04`, `TST-COM-ORD-110`	lifecycle	service, database	test services-commerce:modules/orders/tests/integration/services/placement/promotion-placement.integration.spec.js#voids the order and releases its redemption with order_voided
`05`must prove Confirmed	After the void commits, Commerce requests deletion of the pro forma and records Accounting’s response, retaining the void even if deletion does not succeed. origin: services-commerce:docs/milestones/plans/COMM-M2-plan.md#A2 proved by `ATS-COM-ORD-008-05`, `ATS-COM-ORD-008-12`, `TST-COM-ORD-075`	policy	service	test services-commerce:modules/orders/tests/e2e/billing-and-tender.e2e.spec.js#deletes the pro forma in Accounting and records it on the history
`06`must prove Confirmed	A partial-payment void refunds captured card or bank payments before crediting the invoice, returns store credit through the credit process and escalates unreadable payment legs. proved by `ATS-COM-ORD-007-17`, `ATS-COM-ORD-008-06`, `TST-COM-ORD-075`, `TST-COM-ORD-097`, `TST-COM-ORD-136`	calculation	service	test services-commerce:modules/orders/tests/unit/orders/void-refund.spec.js#refunds the paid part of a part-paid order before the memo of its line is cut
`07`must prove Confirmed	Void replay and adjustment replay send no duplicate refunds, and a later independent void request is refused. proved by `ATS-COM-ORD-008-07`, `TST-COM-ORD-075`	invariant	service	test services-commerce:modules/orders/tests/e2e/billing-and-tender.e2e.spec.js#refunds nothing twice: a second void is 409, a re-run of the plan sends nothing and a replayed request answers the same plan
`08`must prove Confirmed	The minute sweep voids expired placed pay-now orders in bounded window order within their workspaces, recording a system reason and leaving terms, accepted and voided orders alone. origin: services-commerce:docs/milestones/plans/COMM-M2-plan.md#A2 proved by `ATS-COM-ORD-008-08`, `TST-COM-ORD-096`	lifecycle	service, database	test services-commerce:modules/orders/tests/integration/services/orders/tender-window-sweeper.integration.spec.js#voided each in its own tenant: the reason tender_window_expired, the reservation released, the obligation cancelled, the history told by the system
`09`must prove Confirmed	A configured tender window is measured from the exact placement instant, including when it crosses midnight. origin: services-commerce:docs/milestones/plans/COMM-M1-plan.md#A3 proved by `ATS-COM-ORD-008-10`, `TST-COM-ORD-140`	calculation	service	test services-commerce:modules/orders/tests/unit/placement/tender-window.spec.js#ends a thirty-minute window across midnight UTC on the next day
`10`must prove Confirmed	After the pay-now window expires, Order 360 removes Take Payment but retains Void Order for an unpaid order. proved by `ATS-COM-ORD-008-11`, `TST-COM-ORD-017`	policy	console	test react-console:components/console/order/__tests__/order-360-live-cards.test.tsx#shows neither once the tender window has passed, except Void Order

Scenarios

Id	Given	When	Then	Provenance
`01`	A duplicate phone order reserves mugs and the only use of a code.	An administrator voids it with an explanation.	Its resources and code use become available, and Accounting is asked to delete the provisional invoice.	unknown FND-COM-ORD-032

Planning

Implementation

Clear an unaccepted order and return its resources ​

Purpose ​

How It Works ​

Relationships ​