AlmondTill/G3N API

On this page

shipFulfillment

mutation · in the family Inventory operations

What it does

Ship a fulfilment — it leaves with the carrier.

SHIP a packed Fulfillment: packed→shipped→FULFILLED in ONE call (ship = delivered, the operator ruling — both edges evented, one transaction): the claimed lines relieve through the sell-relief lane (partial quantities; the ecom reserve releases; COGS at the current WMA; the composed action budget pre-gates ≤ 100), the ORDER line fulfilledQty stamps + both delivery rollups recompute, and a paid-and-delivered order COMPLETES (system:fully_paid_and_delivered). The capture seam is DECLARED-dormant. Requires the unrestricted capability.

What happens

The order’s delivery story advances; shipped stock leaves your books.

Who may call it

Capability area: Inventory operations — Receiving, counting, transferring and moving stock.

Arguments

NameTypeRequiredNotes
inputShipFulfillmentInput ShipFulfillmentInput!yesNo further notes.

Returns

Fulfillment Fulfillment! — 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.

Example request

mutation ExampleShipFulfillment($input: ShipFulfillmentInput!) {
  shipFulfillment(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    orderId
    organizationId
    method
    carrierName
    trackingRef
    packedAt
  }
}

Variables:

{
  "input": {
    "fulfillmentId": "01900000-0000-7000-8000-82dcede40000",
    "expectedRevision": "01900000-0000-7000-8000-e02b2e6c0000",
    "shipTo": {
      "name": "Blue jeans",
      "addressLines": [
        "<address lines>"
      ],
      "city": "Toronto",
      "region": "ON",
      "countryCode": "CA"
    }
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "shipFulfillment": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "FF-EXMP-0000-000F",
      "type": "Fulfillment",
      "caption": "Blue jeans",
      "status": "pending",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "orderId": "01900000-0000-7000-8000-f6d8263a0000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "method": "ship",
      "carrierName": "Blue jeans",
      "trackingRef": "<tracking ref>",
      "packedAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in