AlmondTill/G3N API

OrderLine

object type

One embedded Order line — lineNo frozen at placed; money audit server-stamped per write.

Fields

FieldTypeNotes
lineNoInt Int!1-based input position — the cross-document addressing key once placed.
variantIdIDThe sold variant (the 3-way entry-mode XOR with openItem / storedValue).
inventoryItemIdIDThe resolved (variant × LF) InventoryItem — present ⟺ variantId (price capture + reserve junction).
salePriceIdIDThe SalePrice record whose window governed the capture — present ⟺ variantId (audit provenance).
openItemOrderOpenItemNo further notes.
storedValueOrderStoredValueThe stored-value payload.
taxCategoryTaxCategory TaxCategory!The resolved tax category — the variant→product→style walk answer, or the open-item/stored-value explicit one.
quantityString String!Positive decimal-string quantity (the stock-UoM grammar; open items unit-counted).
capturedUnitPriceMinorInt Int!The captured unit sale price in minor units.
discountsOrderDiscount [OrderDiscount!]!No further notes.
fulfillmentMethodOrderFulfillmentMethod OrderFulfillmentMethod!No further notes.
nonReturnableBooleanNo further notes.
finalSaleBooleanNo further notes.
restockingFeePpmIntNo further notes.
requiresApprovalToSellBooleanNo further notes.
commissionAgentsOrderCommissionAgent [OrderCommissionAgent!]No further notes.
referralCodeStringNo further notes.
reservedQtyStringThe LIVE reservation claim stamped by the ecom place — the release entries + the terminal status are the history.
invoicedQtyStringThe cumulative INVOICED quantity: stamped by issueInvoice / un-stamped by voidInvoice under this doc's OCC; the un-invoiced remainder = quantity − invoicedQty (absent = 0).
returnedQtyStringThe cumulative RETURNED quantity: stamped by receiveReturn under this doc's OCC; the returnable remainder = quantity − returnedQty (absent = 0).
fulfillmentClaimedQtyStringThe cumulative FULFILLMENT-CLAIMED quantity: Σ open + delivered Fulfillment claims, stamped by createFulfillment / un-stamped by cancelFulfillment under this doc's OCC; the unclaimed remainder = quantity − fulfillmentClaimedQty (absent = 0). Carryout lines claim at the paid-completion delivery.
fulfilledQtyStringThe cumulative DELIVERED quantity: stamped by the delivery lanes (ship/handover/the carryout paid-completion) under this doc's OCC; both delivery vectors aggregate it (absent = 0).
relievedQtyStringThe cumulative RELIEVED quantity: stamped by the sell-relief lane in ITS transaction (absent = 0).
warrantyIdsID [ID!]The Warranties born on this line at the sale's completion: engine-stamped in the birth transaction under this doc's OCC (the idempotency mark — a re-run births nothing twice); ABSENT until the birth; never caller-typed. Ref-only — THE ORDER-SIDE LINK; each warranty's parentId is this order and its orderLineNo this line.
sourcingTypeOrderLineSourcingTypeThe sourcing path this special_order line rides.
sourcingDocIdIDThe linked sourcing document (transfer → the TransferRequest; backorder → the PurchaseOrder) — re-stamped only when the linked doc is DEAD (the re-link retry lane).
sourcingDocLineNoIntThe 1-based line on THAT doc (the TR-b per-line shape mirrored).
arrivedQtyStringThe cumulative ARRIVED quantity: stamped by the arrival follow-ups (receiveTransfer / the Receipt post) in their per-order transactions; on_hand landings ONLY; the line is arrived when arrivedQty ≥ quantity (absent = 0).
cogsUnitCostMoneyEntryThe per-unit COGS snapshot at relief.
baseMinorInt Int!Step-1 base = round(quantity × capturedUnitPriceMinor), half away from zero.
lineDiscountMinorInt Int!Σ applied line discounts (step 2).
orderDiscountShareMinorInt Int!This line largest-remainder share of the order-level discounts (exact — no lost minor units).
taxableBaseMinorInt Int!base − line discounts − order share (floored at zero) — the taxable base.
lineTotalMinorInt Int!taxableBase + exclusive-regime tax; pre-place = taxableBase.
taxOrderLineTaxThe tax slot — pipeline-written at place; absent while the cart is open/held.