Skip to content

Playbooks

Playbooks are standard operating procedures (SOPs) for ICS. Use calls.md for payload shape and required fields.

Surface availability (explicit)

  • API Gateway: Available.
  • Direct Lambda: Not offered.
  • CLI: Available (g3n ics ..., API Gateway).
  • MCP: Available.

Playbook: Receive + QC + putaway

Goal: Record inbound inventory, complete QC, and place stock into bins.

Why this sequence:

  • Receipts establish inbound stock context.
  • QC approval gates stock availability.
  • Putaway moves stock into the correct bin/zone for picking.

Preconditions

  • Logical facility and zone/bin structure exist (OFM + ICS).
  • PVM variants exist for received items.

SOP (happy path)

  1. Create zones/bins (POST /zone/create, POST /bin/create) if missing.
    • Reason: putaway requires a target location.
  2. Record receipt (POST /receive/record).
    • Reason: captures inbound quantities and references.
  3. Verify receipt (POST /receive/get).
    • Reason: ensures receipt state and quantities are correct.
  4. Complete QC (POST /qc/complete) when inspection is done.
    • Reason: makes stock eligible for putaway and availability.
  5. Record putaway (POST /putaway/record) into bins.
    • Reason: moves stock to storage locations.
  6. Adjust/transition stock if needed (POST /adjustment/create, POST /stock/transition).
    • Reason: reconcile discrepancies or move stock between buckets.
  7. Confirm stock (POST /stock/get, POST /stock/list).
    • Reason: verify on-hand availability and location totals.

Outputs

  • Receipt with QC complete.
  • Stock placed in bins and visible in stock lists.

Failure modes / remediation

  • invalid-state: ensure QC is complete before putaway.
  • Quantity mismatches: use adjustments with clear reasons and source refs.

Cross-service relationships

  • OFM: facility/logical context.
  • PVM: variant identifiers for received items.

Playbook: Pick + pack + ship

Goal: Move stock through fulfillment movements for outbound orders.

Why this sequence:

  • Reservations/allocations prevent double-sell.
  • Pick/pack/ship movements must be recorded in order.

Preconditions

  • Stock is available in bins.
  • An order or allocation context exists (SCM or upstream OMS).

SOP (happy path)

  1. Reserve or allocate stock (POST /reservation/create or POST /allocation/create).
    • Reason: holds inventory for the outbound order.
  2. Pick (POST /pick/record) from bins.
    • Reason: removes stock from storage into pick state.
  3. Pack (POST /pack/record).
    • Reason: bundles picked items for shipment.
  4. Ship (POST /ship/record).
    • Reason: moves stock out of facility and records shipment.
  5. Release reservation (POST /reservation/release or POST /allocation/release) if not auto-released.
    • Reason: clears holds once fulfillment completes.
  6. Verify movements (POST /stock/card/list).
    • Reason: audit the stock movement trail.

Outputs

  • Inventory moved through pick/pack/ship with a traceable stock card.

Failure modes / remediation

  • insufficient-stock: re-run allocation or adjust stock availability.
  • invalid-state: ensure movement sequence order is respected.

Cross-service relationships

  • SCM: order and shipment context.