Fulfillment

An order fulfillment workflow from warehouse pick through packing and shipping to customer delivery.

Properties

• id (string): Unique identifier for the fulfillment.
• number (string): Human-readable fulfillment number.
• order ([[Order]]): The customer order being fulfilled.
• status (string): Current status (pending, picking, picked, packing, packed, shipped, delivered, cancelled, returned).
• type (string): Fulfillment type (standard, expedited, drop_ship, backorder).
• warehouse ([[Warehouse]]): The warehouse fulfilling this order.
• items (object[]): Line items being fulfilled with quantities.
• pickList ([[PickList]]): The generated pick list for this fulfillment.
• packingList ([[PackingList]]): The packing list for this fulfillment.
• shipments ([[Shipment]][]): Shipments created from this fulfillment.
• picker ([[User]]): User assigned to pick the order.
• packer ([[User]]): User assigned to pack the order.
• pickStarted (number): When picking started (Unix timestamp).
• pickCompleted (number): When picking was completed (Unix timestamp).
• packStarted (number): When packing started (Unix timestamp).
• packCompleted (number): When packing was completed (Unix timestamp).
• shippedDate (number): When order was shipped (Unix timestamp).
• deliveredDate (number): When order was delivered (Unix timestamp).
• carrier ([[Carrier]]): Selected shipping carrier.
• service (string): Shipping service level.
• trackingNumber (string): Tracking number for the shipment.
• shippingCost (number): Actual shipping cost in cents.
• packages (number): Number of packages in this fulfillment.
• weight (number): Total weight in grams.
• notes (string): Special instructions or notes.
• metadata (object): Set of key-value pairs for storing additional information.

Actions

create

Create a new fulfillment for an order.

Input: [[Fulfillment]]
Output: [[Fulfillment]]

update

Update fulfillment information.

Input: [[Fulfillment]]
Output: [[Fulfillment]]

delete

Cancel the fulfillment.

Input: [[Fulfillment]]
Output: [[Fulfillment]]

pick

Generate pick list and start picking.

Input: [[PickRequest]]
Output: [[PickList]]

completePick

Mark picking as completed.

Input: [[PickCompletion]]
Output: [[Fulfillment]]

pack

Start packing process.

Input: [[PackRequest]]
Output: [[PackingList]]

completePack

Mark packing as completed.

Input: [[PackCompletion]]
Output: [[Fulfillment]]

ship

Create shipment and generate label.

Input: [[ShipRequest]]
Output: [[Shipment]]

deliver

Confirm successful delivery.

Input: [[DeliveryConfirmation]]
Output: [[Fulfillment]]

returnOrder

Process return of delivered order.

Input: [[ReturnRequest]]
Output: [[Return]]

cancel

Cancel the fulfillment.

Input: [[CancellationRequest]]
Output: [[Fulfillment]]

Events

• created: Triggered when a new fulfillment is created.
• updated: Triggered when fulfillment is modified.
• deleted: Triggered when fulfillment is cancelled.
• cancelled: Triggered when fulfillment is cancelled.
• delivered: Triggered when order is delivered to customer.
• returned: Triggered when order is returned by customer.
• shipped: Triggered when order is shipped.
• Packing.completed: Triggered when packing is completed.
• Packing.started: Triggered when packing begins.
• Picking.completed: Triggered when picking is completed.
• Picking.started: Triggered when picking begins.
• PickList.generated: Triggered when pick list is created.
• Shipment.created: Triggered when shipment is created.