createFulfillment

mutation · in the family Fulfillment

What it does

Start a fulfilment — the pick/pack/ship (or pickup) job for an order’s items.

Create a Fulfillment; requires the unrestricted capability.

Who may call it

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

• Owner
• Manager
• Associate Manager
• Warehouse Associate
• An API key whose scope allows api:createFulfillment

Arguments

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 ExampleCreateFulfillment($input: NewFulfillmentInput!) {
  createFulfillment(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    orderId
    organizationId
    method
    carrierName
    trackingRef
    packedAt
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "orderId": "01900000-0000-7000-8000-f6d8263a0000",
    "method": "ship",
    "lines": [
      {
        "orderLineNo": 1,
        "quantity": "2"
      }
    ]
  }
}

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

Example response

{
  "data": {
    "createFulfillment": {
      "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

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
• NOT_FOUND/* — That record could not be found. (NOT_FOUND)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

• Pick, pack and ship or hand over an order