AlmondTill/G3N API

On this page

removeRegistryItem

mutation · in the family Selling

What it does

Remove an item from a gift registry, as staff.

STAFF: remove ONE item (= the TWO_STATE doom, history preserved): the row flips active → doomed through the runner (at.customer.registry_item.doom.ok.v1); the marker STAYS with the doomed holder for takeover (ruling). The registry must be ACTIVE (ruling). Requires the unrestricted capability. Template class (hand-derived v22).

Who may call it

Capability area: Selling — Ringing sales, serving customers and issuing invoices.

Arguments

NameTypeRequiredNotes
registryIdID ID!yesNo further notes.
itemIdID ID!yesNo further notes.
reasonStringnoNo further notes.

Returns

RegistryItem RegistryItem! — One desired variant on a GiftRegistry. variantId is the membership identity (IMMUTABLE — remove + re-add instead); REMOVE = doom, history preserved (re-adding TAKES OVER the doomed marker — ruling).

Example request

mutation ExampleRemoveRegistryItem($registryId: ID!, $itemId: ID!, $reason: String) {
  removeRegistryItem(registryId: $registryId, itemId: $itemId, reason: $reason) {
    id
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    variantId
    desiredQty
    priority
    note
  }
}

Variables:

{
  "registryId": "01900000-0000-7000-8000-5a9f6ff30000",
  "itemId": "01900000-0000-7000-8000-140bfb5b0000",
  "reason": "Correcting a miscount."
}

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

Example response

{
  "data": {
    "removeRegistryItem": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "type": "<type>",
      "caption": "Blue jeans",
      "status": "<status>",
      "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",
      "variantId": "01900000-0000-7000-8000-8415e73b0000",
      "desiredQty": 1,
      "priority": "<priority>",
      "note": "Restock before the weekend."
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer