Skip to content

CON-COM-FUL-001Obligation

Markdown

CON-COM-FUL-001

Obligation

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-COM-FUL-01
Owned by
MOD-COM-FUL
Acted on by
CAP-COM-FUL-001, CAP-COM-FUL-002, CAP-COM-FUL-003, CAP-COM-FUL-004, CAP-COM-FUL-005, CAP-COM-FUL-006, CAP-COM-FUL-014, CAP-COM-FUL-020
Visible to
ACT-COM-008, ACT-COM-011, ACT-COM-013
Not to be confused with
The priced order line owned by Orders, The delivered membership or access owned by its application, Warehouse shipment work handling physical units

Design

Specified by
DOM-COM-FUL-001

KindKey conceptProduct areaCommerceModuleFulfillment, Shipping and InventoryRevision1

Read atservices-commerce c8b66a98react-console baf6dae3

The Formal Contract

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

Definition
An obligation follows the delivery work owed by a sold line or unit and records the responsible application's progress under its saved conditions.
Synonyms
deliveryfulfilment itemwhat the order owes

Relationships

ToStatementProvenance
CON-COM-FUL-002Placement retains the selected fulfillment policy as the obligation's gate.test
services-commerce:modules/fulfillment/tests/e2e/fulfillment-policies.e2e.spec.js#freezes the product policy on the obligation with the row’s version and source, and the replacement changes nothing on it
CON-COM-FUL-003Permanent application refusal creates an exception concerning the failed obligation.test
services-commerce:modules/fulfillment/tests/integration/services/register/obligation-worker.integration.spec.js#fails the obligation with the participant’s code, raises obligation_failed, and acknowledges the item
CON-COM-FUL-004Physical departure completes the merchandise units' delivery obligations.test
services-commerce:modules/shipping/tests/integration/services/fulfillment/shipping-flow.integration.spec.js#completes every unit’s obligation through the register (the allocation as the record), and emits one deferred cost relief fact per item
CON-COM-FUL-005Inventory reconciliation flags a committed allocation whose obligation is cancelled.test

Lifecycle

StateMeaningHow it changes
pendingThe delivery record is waiting on eligibility.Evaluation can authorize, block or retain waiting work.
blockedA staff-related condition prevents delivery.Approval, release, override or cancellation can address the applicable block.
authorized and in progressAuthorized application work has not reached its final outcome.The application reports success or failure, or staff supply manual completion evidence.
completedThe owed delivery has succeeded.A later change can supersede the completed record.
failedDelivery cannot progress after refusal or exhausted recovery.Staff can issue a fresh authorization or resolve the failure.
cancelled, resolved or supersededThe obligation is closed, resolved or replaced.The closed record retains its outcome rather than restarting delivery.

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.