AlmondTill/G3N API

Fulfillment

object type

A Fulfillment — groups order lines fulfilled together by ONE method from ONE LF: pick → pack → ship-or-stage → deliver. Ship = delivered (the operator ruling — the ship call fires BOTH edges); delivery relieves stock through the sell-relief lane (release of the ecom reserve rides it), stamps the ORDER line fulfilledQty rollups, and recomputes both delivery vectors; the completion evaluator flips a paid-and-delivered order to completed. After pack the record IS the Packing-List node (packedAt + the immutable lines; the FF-… sysId is the document number). Carryout lines NEVER ride a Fulfillment (the paid-completion till lane); dropship + ship-from-other-store are the named /Transfer-composition deferrals.

Fields

FieldTypeNotes
idID ID!The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it.
sysIdString String!The group-scoped human-facing system id (FF-…).
typeString String!The kind of record — always Fulfillment here.
captionString String!The record’s display name — what people see it called.
statusString String!The FSM state: pending | picking | packed | shipped | ready_for_pickup | fulfilled | cancelled.
parentIdID ID!The fulfilling LogicalFacility; rootId = the org group; parentId!== rootId always.
rootIdID ID!The org-group family root.
createdAtString String!When the record was created, as a UTC timestamp.
updatedAtString String!When the record last changed, as a UTC timestamp.
revisionNumInt Int!How many times this record has been edited; the first save is 0.
revisionID ID!The OCC revision token — supply it on every mutation of this record; rotates on every write.
refCaptionsRefCaption [RefCaption!]!The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption.
orderIdID ID!The fulfilled Order.
organizationIdID ID!The selling Organization (copied from the Order at create — attribution).
methodFulfillmentMethod FulfillmentMethod!The delivery lane — decides the packed→[shipped | ready_for_pickup] conditional edge.
shipToFulfillmentShipToThe inline ship-to snapshot (method=ship — captured at create or at ship; the ship payload wins as the label truth).
carrierNameStringSHIP-stamped carrier capture (carrier-API integration is build-time-flagged).
trackingRefStringSHIP-stamped tracking reference capture.
packedAtStringPACK-stamped: the Packing-List instant (the document node = this record after pack).
linesFulfillmentLine [FulfillmentLine!]!The claimed lines (1..45); each refs an order line by its frozen lineNo.

Used by