AlmondTill/G3N API

On this page

receiveReturn

mutation · in the family Gated floor actions

What it does

Take returned goods physically back in.

RECEIVE an approved Return: the disposition cover addresses every NON-STOCKLESS line EXACTLY (splits across codes legal; incomplete/over/unknown refuse VALIDATION/INVALID naming residuals); restock/inspect/damaged post return movements at the RECEIVING LF's (variant × LF) IIs cost-entering at CURRENT WMA (the average never moves; uncosted books qty-only; a variant never stocked at the LF refuses CONFLICT/REF_STATE naming the junction); scrap posts NO movement (the write-off is reports-only). The refund money stamps by cumulative telescoping over the order line's captured figures; the restocking fee applies ONLY where the sale captured the flag. ONE transaction: the doc rewrite + the legs + the ORDER returnedQty rollup stamp under the Order's OCC (remainder = quantity − returnedQty; over refuses CONFLICT/OVER_RETURNABLE naming the line — concurrent receives serialize CONFLICT/REVISION_STALE, retryable). Requires the doc CURRENT revision (OCC) + the unrestricted capability.

What happens

Stock returns to your books, bucketed as sellable or damaged as you receive it.

Who may call it

Capability area: Gated floor actions — Voids, returns and the requests that need an approval.

Arguments

NameTypeRequiredNotes
inputReceiveReturnInput ReceiveReturnInput!yesNo further notes.

Returns

Return Return! — A sales Return / RMA — the customer→merchant goods-back document (distinct from vendor RTV; the disjoint law: a billing correction is a CreditNote/DebitNote, never a Return). References the original Order (+ optionally one of its Invoices); returns WHOLE units of order lines; receive posts per-line disposition legs at the RECEIVING LF and stamps the telescoping refund money; refund RECORDS the routing (tender mechanics; store-credit issuance).

Example request

mutation ExampleReceiveReturn($input: ReceiveReturnInput!) {
  receiveReturn(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    orderId
    invoiceId
    organizationId
    currency
    refundTotalMinor
  }
}

Variables:

{
  "input": {
    "returnId": "01900000-0000-7000-8000-4d4c03d20000",
    "expectedRevision": "01900000-0000-7000-8000-e02b2e6c0000",
    "dispositions": [
      {
        "lineNo": 1,
        "disposition": "restock",
        "quantity": "2",
        "reason": "Correcting a miscount."
      }
    ]
  }
}

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

Example response

{
  "data": {
    "receiveReturn": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "RT-EXMP-0000-000F",
      "type": "Return",
      "caption": "Blue jeans",
      "status": "requested",
      "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",
      "invoiceId": "01900000-0000-7000-8000-504ef4ed0000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "currency": "USD",
      "refundTotalMinor": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in