Skip to content

CON-COM-FUL-004Shipment

Markdown

CON-COM-FUL-004

Shipment

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-COM-FUL-03
Owned by
MOD-COM-FUL
Acted on by
CAP-COM-FUL-010, CAP-COM-FUL-011, CAP-COM-FUL-012, CAP-COM-FUL-013, CAP-COM-FUL-014, CAP-COM-FUL-015
Visible to
ACT-COM-010, ACT-COM-009, ACT-COM-008
Not to be confused with
The commercial order owning the sale, An individual parcel within shipment work, The return document authorizing incoming goods

Design

Specified by
DOM-COM-FUL-004

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
A shipment organizes the picking, packing and departure of an order's physical units at one warehouse, through carriage or collection.
Synonyms
waveparcel shipmentpick-up

Relationships

ToStatementProvenance
CON-COM-FUL-001Handover records completion for the shipment units' 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-005Shipment departure records the stock movement associated with its committed allocations.test
services-commerce:modules/shipping/tests/integration/services/fulfillment/shipping-flow.integration.spec.js#hands off: the line handed to the carrier with its whole quantity shipped, the units shipped in the ledger, one shipment movement of minus three on the item, three fewer on hand

Lifecycle

StateMeaningHow it changes
openOrder units have been assigned to shipment work.Staff release the work or cancel it before departure.
released, picking, pickedWarehouse staff are preparing the units.Pick results advance the applicable lines and batch.
packing, packedUnits are being assigned to parcels.Carrier labels or pickup handover continue after packing.
labelled, manifestedCarrier preparation is recorded.Handoff confirms physical departure.
handed to carrier or collectedGoods have departed through carriage or collection.Requested tracking can supply the subsequent delivery result.
delivered or cancelledThe shipment retains its delivered or cancelled result.Further handling follows the applicable shipment and parcel guards.

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.