AlmondTill/G3N API

On this page

receiveStock

mutation · in the family Inventory operations

What it does

Book stock in against a purchase — goods arriving at your door.

RECEIVE stock onto an InventoryItem. The II must be ACTIVE (CONFLICT/REF_STATE else) and STOCKED (a service/bundle II is VALIDATION/INVALID naming its styleType — IV-c); the unit-cost currency must match the II cost currency once fixed (VALIDATION/INVALID naming the expected currency). Movements thread NO revision (the ledger-posting stance); a raced concurrent movement is retryable CONFLICT/REVISION_STALE. Requires the unrestricted capability.

What happens

Posts receipt movements; your on-hand rises and the receipt document records what arrived.

Who may call it

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

Arguments

NameTypeRequiredNotes
inputReceiveStockInput ReceiveStockInput!yesNo further notes.

Returns

StockMovement StockMovement! — A movement outcome: the POSTED entry + the post-movement InventoryItem — written in ONE transaction, so they can never disagree.

Example request

mutation ExampleReceiveStock($input: ReceiveStockInput!) {
  receiveStock(input: $input) {
    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",
    "unitCost": {
      "currency": "USD",
      "amount": "10.00"
    },
    "caption": "Blue jeans"
  }
}

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

Example response

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