AlmondTill/G3N API

Reading your records

96 operations.

Looking up and listing the records of your organization.

Operations

OperationKindWhat it does
abcClassesqueryABC inventory classification — ranks what you sell into A/B/C classes by value and how fast it moves. “A” items are your most valuable, fastest movers; “C” items the slowest.
affiliateEntryListqueryThe ledger of what an affiliate has earned, entry by entry.
affiliatePayoutReportqueryThe payout report for affiliates — what you owe each partner for the period.
agentChannelCatalogLookupqueryResolve product, variant, SKU or barcode identifiers to the listed products an agent would see.
agentChannelCatalogProductqueryOne listed product as an agent sees it in full — its variants narrowed by chosen options, each option value marked available or not.
agentChannelCatalogSearchqueryWhat AI shopping agents can see and buy from this channel right now — the listed products searched by words and filters, priced at the selling location, with in-stock words.
agentChannelCheckoutqueryRead one agent checkout as the platform sees it — the lines, the quote, the delivery options, the status and its messages.
agentChannelOrderqueryRead a completed agent checkout’s order as the platform sees it — what was bought, how it ships, what has happened since.
allocationSuggestionsquerySuggestions for pushing genuine excess stock from a hub out to your stores, shared fairly by each store’s weight.
arAgingqueryThe aging report — who owes what, and for how long (30/60/90 buckets).
arLedgerqueryA customer’s house-account ledger — every charge and payment, in order.
assistantAskqueryAsk the page assistant a question about using Almond Till — it knows which page you are on and answers with the same words the Guide shows.
binStockqueryWhat is sitting in one bin.
cancelExportJobmutationStop one of your own background exports — it ends as cancelled and no file is produced.
cancelSearchJobmutationStop one of your own background searches — it ends as cancelled and keeps the matches found so far.
cannedCharacteristicsqueryThe canned characteristic list — each entry is a platform-preset product characteristic you can copy into your group.
cannedConsentPurposesqueryThe canned consent purpose list — each entry is a platform-preset consent purpose you can copy into your group.
cannedFiscalRegimesqueryThe fiscal regimes we support, per market — each key names a country scheme (sign-and-journal, or authority-cleared before issuing); receipts only accept listed keys. Markets with no scheme (like the US) simply never issue one.
cannedPeripheralModelsqueryThe platform’s supported-hardware presets — the printers, scanners, and card readers Almond Till knows how to drive. A device peripheral names one of these.
cannedRolesqueryThe canned role list — each entry is a platform-preset role template you can copy into your group.
cannedStorefrontThemesqueryThe canned storefront themes to pick from — each key names a ready-made look; storefronts only accept listed keys.
cannedUomsqueryThe platform’s preset units of measure (each, pair, kilogram…) — copy or reference them instead of redefining the basics.
caseMessagesqueryOne case’s message thread — staff replies, internal notes, and the customer’s messages.
casesByConsumerqueryAll the service cases one customer has had — their support history.
categoryChildrenqueryOne category’s direct children — browse your merchandise tree level by level.
collectionProductsqueryWhat a collection actually contains right now — the evaluated product list (pins plus rule matches).
commissionEntryListqueryThe commission ledger — what staff earned, entry by entry.
commissionPayoutReportqueryThe commission payout report — what you owe each seller for the period.
consultationTurnsqueryOne page of a consultation's transcript, oldest first.
couponBatchCodesqueryOne batch’s unique codes with their redemption status — the list you export for a campaign.
dashboardMetricsqueryOne dashboard’s widgets answered with live figures — counts and per-currency totals computed at read time, each stamped with when it was read.
draftReportqueryDescribe the report you want in plain words and get a report definition back — which records, and what to say about them (the columns to list, or the groups and totals) — shown in words before anything runs.
draftSearchPlanqueryDescribe what you are looking for in plain words and get a search plan back — the start, the relationships to follow, the conditions on each step — shown in words before anything runs.
drawerLedgerqueryThe drawer’s cash movements for one till session — every entry, in order.
effectivePermissionsqueryThis page — the full picture of what a user may and may not do at an organization.
expectedReceiptsqueryWhat is expected to arrive — open purchase-order lines by item and date.
explainWizardStepqueryAsk AI to explain where you are on this wizard page — what is happening, what you have provided, and what is still needed and why.
exportJobDownloadqueryGet a short-lived link to download the file a finished export wrote — its name, size, row count and format come with it.
fillDraftqueryLook up one of your own wizard drafts — its status, the sheet page by page once it is ready, the questions the assistant asked, and why it stopped if it failed.
fillDraftTurnsqueryThe conversation on one of your own wizard drafts, oldest first — what you said and what the assistant answered — one page at a time.
fillDraftsqueryYour own wizard drafts, newest first — being made, ready, or failed — one page at a time.
fiscalReceiptqueryLook up one fiscal receipt — the legal tax artifact of a sale: its sequential fiscal number, signature or authorization code, and the QR the printed receipt shows.
fiscalReceiptsqueryList your fiscal receipts, newest first — the gap-free compliance journal; receipts are permanent and never edited or removed.
interpretFilterqueryTurn a written request — “issued orders from Acme since June” — into filter conditions you can review and apply.
inventoryOnOrderAuditqueryCheck the on-order figures — each stock item’s stored on order against what your open purchase orders actually add up to, one page of items at a time.
loyaltyLedgerqueryA loyalty member’s points history — every earn, redemption, and adjustment.
myOrganizationGroupqueryYour own organization group — the tenant root: its name, code, classification, status, and owners.
notesqueryThe notes attached to one record.
orderTendersqueryThe payments applied to one order — the tender-by-tender money story.
orgBusqueryWhat’s happening across your whole organization — every create, edit, and status change on every record, newest first, over roughly the last three months.
orgLayoutqueryYour organization’s operational map in one call — every physical facility (with its location site), the logical facilities inside each, and the registers inside those.
organizationqueryLook up one record — an organization — one store or business unit in your group.
organizationsqueryThe organization list — each entry is an organization — one store or business unit in your group.
purchaseOrderLinesqueryThe lines on one purchase order — what you ordered, where each lot is going, and how much of it has landed.
rebalanceSuggestionsqueryStock-balancing suggestions between your locations — pull stock to where it sells.
receiptLinesqueryThe lines on one goods receipt — which purchase-order lines arrived, how many of each, and where they landed.
registriesByConsumerqueryAll of one customer’s registries.
registryFulfillmentsqueryWho bought what against one registry — the fulfilment audit.
registryItemsqueryThe items on one gift registry.
relationshipCountsqueryHow many records point at this one, per family — the folder counts on a record’s Explore page.
replenishmentParametersqueryThe reorder maths per item — min/max, lead times, safety stock — that replenishment suggestions use.
replenishmentSuggestionsqueryWhat to reorder — suggested purchase quantities from your sales pace and stock levels.
reportRunqueryRun a report — group and total the last step’s records (count, sums, smallest, largest, average per currency) or list chosen columns of them, newest first.
resolveFxRatequeryWhat exchange rate applies right now for a foreign currency at your organization.
resolveIdentifierqueryScan lookup — which variant does this barcode belong to?
resolveStoredValueInstrumentqueryLook up a gift card or store credit by its number — balance and state, the till’s check before redeeming.
resolveTaxJurisdictionByPostalqueryFind the tax jurisdiction that applies at a postal code — type a ZIP, get the place.
reviewRecordqueryAsk AI to review this record for issues — incomplete, inconsistent, or suspicious-looking values.
revisionsqueryA record’s full change history — every saved version, what changed, when, and why, with the stated reason kept word for word.
rolePermissionsqueryThe full picture of what ONE role may and may not do at an organization — before anyone holds it (the guide’s “show this guide for a different role”).
schedulableResourceAvailabilityqueryOne resource’s availability facts over a window (at most 31 days) — its advisory hours, capacity and the reserved bookings; compose free slots from them.
searchqueryName search across your records — type-ahead by caption within your own group.
searchAllqueryOne search over every kind of record you may read — a word, a code or an id finds products, vendors, contacts and more, grouped by kind.
searchJobMatchesqueryRead the matches a background search found — the last step’s records newest first, the whole match count, how many records were examined, and whether the set is partial or has expired.
searchPlanRunqueryRun a search plan — start at one kind of record, follow its links to related records step by step, and read the last step’s matches newest first.
segmentMembersqueryOne segment’s member list, in shopper-id order.
sizeRunFillquerySpread a total over a size run’s ratio — whole units, the remainder to the largest shares, ties to the earlier size.
startExportJobmutationExport records to a file in the background — start at one kind of record, follow its links step by step, and let the platform write every matching record as CSV or JSON Lines while you carry on; download the file when it is done.
startSearchJobmutationStart a search plan in the background — start at one kind of record, follow its links step by step, and let the platform dig while you carry on; read the matches when it is done.
stockCardqueryOne item’s full stock story at a location — every movement, in order.
stockRecordsqueryThe stock balances — what you own, where, in which bucket.
storedValueLedgerqueryA gift card / store credit’s full money story — every load and redemption.
styleStockMatrixqueryThe cells of one style at one location — on hand, reserved, available and on order per variant, the axes in scheme and size order.
suggestCaptionquerySuggest a cleaned-up version of a record name you are typing — casing, spacing, and obvious typos fixed.
suggestCodequerySuggest a code for a record, built from its name — and free to take where codes must be unique.
suggestFormFillqueryAsk AI to draft values for the empty inputs on this wizard page, predicted from what you already answered.
suggestNotequeryAsk AI to draft one internal note — from the thread so far, or by cleaning up words you already wrote.
suggestReasonqueryDraft a short reason for the change you are about to save — composed from what actually changed.
summarizeThreadqueryAsk AI for a short synopsis of this record’s note thread — what it is about, what was decided, what still hangs.
tasksByConstructqueryThe tasks attached to one record — “what’s to do about this?”.
taxJurisdictionChildrenqueryOne tax jurisdiction’s direct children — drill a country into its states, a state into its counties.
taxJurisdictionCountriesqueryThe countries with a live tax-jurisdiction tree — what the tax page’s country picker offers.
teamTasksqueryOne team’s task inbox — the to-dos assigned to that team.
transferLaneRankingqueryWhich transfer lanes (location pairs) serve a move best, ranked.
variantIdentifiersqueryThe identifiers (barcodes/SKUs) assigned to one variant.
verifyInventoryItemqueryReconcile one item’s ledger against its cached balances — “do the books add up?”.