AlmondTill/G3N API

On this page

breakStock

mutation · in the family Inventory operations

What it does

Disassemble kits — break finished kits back into their component stock.

BREAK kits back into component stock. Requires the unrestricted capability.

What happens

One transaction: the kit goes down, components come back, the kit’s value spreads back across components exactly.

Who may call it

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

Arguments

NameTypeRequiredNotes
inputBreakStockInput BreakStockInput!yesNo further notes.

Returns

StockAssembly StockAssembly! — An assembly movement outcome: the KIT leg + the component legs of the ONE transaction, in recipe order (BOM-edge id ASC). The entry movement types (build_consume | build_produce | break_consume | break_produce) carry direction.

Example request

mutation ExampleBreakStock($input: BreakStockInput!) {
  breakStock(input: $input) {
    kit {
      inventoryItem {
        id
        sysId
        type
        caption
        status
        parentId
        rootId
        createdAt
        updatedAt
        revisionNum
        revision
        logicalFacilityId
        styleType
        controlClass
        onHandQty
        reservedQty
        inTransitQty
        damagedQty
        heldQty
        onOrderQty
        availableQty
      }
    }
  }
}

Variables:

{
  "input": {
    "inventoryItemId": "01900000-0000-7000-8000-9307d9650000",
    "quantity": "2",
    "caption": "Blue jeans"
  }
}

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

Example response

{
  "data": {
    "breakStock": {
      "kit": {
        "inventoryItem": {
          "id": "01900000-0000-7000-8000-37386ae00000",
          "sysId": "IV-EXMP-0000-000F",
          "type": "InventoryItem",
          "caption": "Blue jeans",
          "status": "active",
          "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",
          "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
          "styleType": "<style type>",
          "controlClass": "<control class>",
          "onHandQty": "<on hand qty>",
          "reservedQty": "<reserved qty>",
          "inTransitQty": "<in transit qty>",
          "damagedQty": "<damaged qty>",
          "heldQty": "<held qty>",
          "onOrderQty": "<on order qty>",
          "availableQty": "<available qty>"
        }
      }
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in