# Reference

1018 operations in 149 families. Every family page lists its operations; every operation page carries a request and a response you can copy. Every id in the examples is made up and resolves nowhere.

| Family | Operations | What it is for |
| --- | --- | --- |
| [API key](/reference/api-key/) | 4 | An API key is a machine credential for integrations. |
| [Affiliate](/reference/affiliate/) | 7 | An affiliate is an outside promoter — an influencer or partner — who sends shoppers your way. |
| [Agent channel](/reference/agent-channel/) | 8 | An agent channel is your shop’s set of controls for AI shopping agents buying over the open UCP standard — which store’s stock and prices they buy from, which collections they may see (nothing until y |
| [Appointment](/reference/appointment/) | 7 | An appointment is a customer booking at one of your locations — a service visit (an alteration, a fitting) or an order pickup — holding one to eight resources for a window. |
| [Approval request](/reference/approval-request/) | 5 | An approval request is a register asking permission, live, for one action above the cashier’s own authority — a discount past the limit, voiding a transaction, approving a return, among the actions th |
| [Billing and the wallet](/reference/billing-and-the-wallet/) | 21 | Your platform bill, token purchases and the usage and cost reads. |
| [Billing charge](/reference/billing-charge/) | 2 | A platform charge is a bill from Almond Till itself — minted and settled by the platform against your kernel wallet, never entered by hand. |
| [Bin](/reference/bin/) | 7 | A bin is one stock location inside a zone — the shelf or slot stock actually sits in. |
| [Brand](/reference/brand/) | 7 | A brand is the maker label your goods sell under. |
| [Catalog editing](/reference/catalog-editing/) | 3 | Changing what you sell — the details of styles, products, variants and their identifiers. |
| [Catalog structure](/reference/catalog-structure/) | 2 | Creating and retiring catalog families and whole items. |
| [Category](/reference/category/) | 7 | Categories form your merchandise tree — the departments and sub-departments your range hangs from. |
| [Characteristic](/reference/characteristic/) | 5 | A characteristic is a named product attribute (think material, care class, compliance mark) with an optional format rule. |
| [Collaborator](/reference/collaborator/) | 7 | A collaborator is an outside person — an accountant, an agency, a consultant — who signs in with their own email and password and holds roles per organization, exactly like staff, but can never own an |
| [Collection](/reference/collection/) | 7 | A collection is a curated set of products — explicit picks, exclusions, and an optional rule that selects products automatically. |
| [Collection member](/reference/collection-member/) | 5 | A collection member is one explicit product membership inside a collection — the hand-picked edge, distinct from rule-selected products. |
| [Commission config](/reference/commission-config/) | 7 | A commission config is one cell in your commission matrix — who earns (a role or a person), on which merchandise, where, and on which channel. |
| [Consent purpose](/reference/consent-purpose/) | 7 | A consent purpose is one thing you may ask shoppers for permission to do — marketing email, marketing texts, analytics, personalization, sharing data — defined once for your whole group, one purpose p |
| [Consent record](/reference/consent-record/) | 2 | A consent record is the proof of one shopper’s decision on one purpose — granted or withdrawn — with the version of the notice they saw, where the decision was captured (the storefront, the till, the  |
| [Consultation](/reference/consultation/) | 5 | A consultation is a conversation with the assistant, kept as a record: the transcript is the record and a rolling summary on it is its memory. |
| [Consumer](/reference/consumer/) | 7 | A consumer is one shopper with an account at your group — the person who signs in to browse and buy, kept per group rather than shared across merchants. |
| [Contact](/reference/contact/) | 7 | A contact is a reusable set of contact details kept once at group level — a person (name, title, emails and phones), an address, or both, with notes — for the outside parties and functions you deal wi |
| [Contact assignment](/reference/contact-assignment/) | 5 | A contact assignment attaches one contact to one host — your group, an organization, a location, a vendor or a corporate customer — in a named role: primary, owner, manager, billing (AP), accounts rec |
| [Corporate customer](/reference/corporate-customer/) | 7 | A corporate customer is a business you sell to on business terms — the shared customer master for your whole group, kept deliberately thin: the trading name, the registered legal name, the tax id and  |
| [Count](/reference/count/) | 3 | A stock count reconciles what the books say against what the shelves actually hold, at one location. |
| [Coupon](/reference/coupon/) | 7 | A coupon is a code a shopper presents at the till or checkout — stored upper-cased, one coupon per order. |
| [Coupon batch](/reference/coupon-batch/) | 3 | A coupon batch is a set of unique single-use codes minted at once from one coupon — up to 48 per batch, each generated for you under your chosen prefix and each unlocking the parent coupon’s terms exa |
| [Credit note](/reference/credit-note/) | 3 | A credit note is the reducing correction to an invoice — it gives value back, line by line, and always says why. |
| [Custom unit of measure](/reference/custom-uom/) | 7 | A custom unit of measure is your own unit — a pack, a bundle, a length — classed by what it measures. |
| [Customer price group](/reference/customer-price-group/) | 7 | A customer price group is a pricing tier — point it at an unscoped price list and every customer placed in the group prices from that list, across the organizations the group covers. |
| [Customer-support case](/reference/cs-case/) | 5 | A case is one customer-support interaction — a subject line over a running conversation, worked through a status flow (open → in progress → resolved → closed) with references to the order, return, or  |
| [Dashboard](/reference/dashboard/) | 7 | A dashboard is a saved glance — an ordered layout of canned metric tiles (sales today, open orders, inventory value…). |
| [Debit note](/reference/debit-note/) | 3 | A debit note is the increasing correction to an invoice — the undercharge twin of the credit note. |
| [Decoration](/reference/decoration/) | 7 | A decoration is presentation content attached to one owner — a brand or a season — such as imagery or copy blocks. |
| [Device](/reference/device/) | 6 | A device is an enrolled piece of hardware. |
| [Device fleet](/reference/device-fleet/) | 5 | Enrolling, pairing, suspending and retiring the devices at your registers. |
| [Device peripheral](/reference/device-peripheral/) | 7 | A device peripheral is hardware attached to a device — a printer, a scanner, a cash drawer — referencing its canned peripheral model. |
| [Dispute](/reference/dispute/) | 3 | A dispute is a chargeback the card network raised against a payment, mirrored from the processor as it moves — needs a response, under review, won, lost or accepted. |
| [Division](/reference/division/) | 7 | A division is a branch of your group structure — merchandise divisions organize the range, operational and geographic divisions organize places and reporting. |
| [Document approvals](/reference/document-approvals/) | 3 | Approving or rejecting purchase orders and returns to vendors. |
| [Exemption certificate](/reference/exemption-certificate/) | 6 | An exemption certificate is captured proof that a purchase may go tax-free — the certificate number, the holder, the covered jurisdictions and categories, and any expiry. |
| [Export job](/reference/export-job/) | 2 | A background export is a saved search plan the platform runs for you — as you, with your own permissions — for up to five minutes, writing every matching record to ONE file: CSV (one column per field, |
| [FX rate](/reference/fx-rate/) | 5 | An FX rate is a dated exchange window between two currencies — absolute buy and sell rates at group level, with adjust and par overrides per organization or logical facility. |
| [Feed subscription](/reference/feed-subscription/) | 6 | A feed subscription exports one record kind for one organization on a schedule — a fresh file lands on the export shelf daily, weekly, or monthly, and your BI tool pulls it with a short-lived link. |
| [Fraud alert](/reference/fraud-alert/) | 5 | A fraud alert is the platform flagging a suspicious pattern — voids, refunds, overrides, cash variances — with a score, the window it scored, and the implicated person or location. |
| [Fulfillment](/reference/fulfillment/) | 8 | A fulfillment is one delivery of some order lines by one method from one location — pick, pack, then ship or stage for pickup and hand over. |
| [Gated floor actions](/reference/gated-floor-actions/) | 3 | Voids, returns and the requests that need an approval. |
| [Gift registry](/reference/gift-registry/) | 6 | A gift registry is one shopper’s list of wanted items with purchases tracked against it — a wedding, baby, birthday, anniversary or holiday registry, a wishlist, or a custom one. |
| [Identity and access](/reference/identity-and-access/) | 5 | Who can sign in and what each role allows — users, roles and their assignments. |
| [Inventory adjustments](/reference/inventory-adjustments/) | 2 | Correcting stock with a reason and posting counts. |
| [Inventory item](/reference/inventory-item/) | 7 | An inventory item is one variant’s stock position at one location — the on-hand, reserved, in-transit, damaged and held balances, what that leaves available to sell, and the average cost its movements |
| [Inventory operations](/reference/inventory-operations/) | 30 | Receiving, counting, transferring and moving stock. |
| [Invoice](/reference/invoice/) | 3 | An invoice is the billing snapshot of an order — issue it for the full un-invoiced remainder or for chosen lines, and its figures freeze at issue. |
| [Logical facility](/reference/logical-facility/) | 7 | A logical facility is an operating unit inside a building — a shop floor, a warehouse, a service point. |
| [Loyalty member](/reference/loyalty-member/) | 7 | A loyalty member is one customer enrolled in one loyalty program — identified by email (required; one enrollment per program and email), with a name and phone, an optional tier, a customer price group |
| [Loyalty program](/reference/loyalty-program/) | 7 | A loyalty program is the rule book for earning and spending points: the currency it counts in, how many points each amount of eligible spend earns and how many points make a unit of discount, plus opt |
| [Manufacturer](/reference/manufacturer/) | 7 | A manufacturer is who physically makes the goods. |
| [Markdown plan](/reference/markdown-plan/) | 4 | A markdown plan is a scheduled cadence of price cuts for a product scope — up to eight dated steps, each a percent off, an amount off or a move to a fixed price, in one currency, for the organizations |
| [Open doors](/reference/open-doors/) | 2 | Calls that need no key — the health check and the key exchange. |
| [Operating policy](/reference/operating-policy/) | 1 | The operational policies and thresholds your organization runs by. |
| [Option group](/reference/option-group/) | 7 | An option group is one axis a product can vary on — Color, Size, Material. |
| [Option value](/reference/option-value/) | 7 | An option value is one point on its option group axis — Red on Color, XL on Size. |
| [Order](/reference/order/) | 11 | An order is a sale as the till and the online channels record it — the lines, the figures, the payment and fulfillment story. |
| [Org brand](/reference/org-brand/) | 7 | An org brand is an enablement edge: this organization actually ranges that master brand. |
| [Org customer](/reference/org-customer/) | 7 | A customer account is one corporate customer enabled at one of your organizations — the selling relationship itself, and the house account behind it. |
| [Org division](/reference/org-division/) | 7 | An org division is an enablement edge tying an organization into a division of the group structure. |
| [Org manufacturer](/reference/org-manufacturer/) | 7 | An org manufacturer is an enablement edge: this organization sources from that maker. |
| [Org plugin](/reference/org-plugin/) | 7 | An organization plugin enablement switches a registered plugin ON for one organization. |
| [Org season](/reference/org-season/) | 7 | An org season is an enablement edge: this organization takes part in that master season. |
| [Org style](/reference/org-style/) | 7 | An org style is an enablement edge: this organization ranges that style. |
| [Org vendor](/reference/org-vendor/) | 7 | A supplier account is the account an organization holds with one shared supplier — the commercial terms it buys under: currency, payment terms, delivery terms, lead time, order minimums, and the defau |
| [Org vendor item](/reference/org-vendor-item/) | 7 | A supplier item is what one of your organizations buys from one of its supplier accounts: this variant, under the supplier’s own part number, at their list cost, with the minimum order quantity, the l |
| [Organization requests](/reference/organization-requests/) | 5 | Filing and following requests to park or reopen your organizations. |
| [Organization structure](/reference/organization-structure/) | 5 | Opening and closing organizations and facilities — the legal and physical structure of your group. |
| [Payment](/reference/payment/) | 6 | A payment is a card charge against an order as the processor sees it — authorized (the hold), captured, settled or failed. |
| [Physical facility](/reference/physical-facility/) | 7 | A physical facility is a building or site at a location — the bricks. |
| [Physical facility location](/reference/physical-facility-location/) | 5 | A location is a street address with coordinates — the geographic anchor a building stands on. |
| [Plugin](/reference/plugin/) | 7 | A plugin declaration registers a third-party extension with your group — who made it, where it lives, and which permissions it says it needs. |
| [Policy value record](/reference/policy-value-record/) | 5 | A policy value is one dated window in your policy schedule — a setting from the platform’s fixed list (the appointment lead time, the maximum days ahead a booking may be made, the no-show window, the  |
| [Price list](/reference/price-list/) | 7 | A price list is a book of pricing rules — its entries set or adjust prices for the organizations it covers. |
| [Price list entry](/reference/price-list-entry/) | 5 | A price list entry is one dated rule inside a price list: it targets a single merchandise axis (a variant, a category subtree, a brand, or a division) and prices it as a fixed amount, a percentage off |
| [Pricing](/reference/pricing/) | 6 | Prices, price schedules, promotions, coupons and the money rules of selling. |
| [Privacy and compliance](/reference/privacy-and-compliance/) | 3 | Tax and fiscal configuration, certificates and privacy requests. |
| [Privacy request](/reference/privacy-request/) | 6 | A privacy request records a data-subject demand — erasure, access, portability, rectification, or opt-out — under GDPR or CCPA, with who asked and how it arrived. |
| [Product](/reference/product/) | 7 | A product is one sellable line under a style: it fixes the product-tier options, carries the recommended price, and its segment bounds which variant cells may exist beneath it. |
| [Product relation](/reference/product-relation/) | 7 | A product relation is a typed link between two products — goes-with, replaces, and the like. |
| [Promotion](/reference/promotion/) | 7 | A promotion is an automatic discount rule — percent off, an amount off, a fixed unit price, buy some and get some, or a bundle deal — with where it applies (channels, locations, organizations, custome |
| [Purchase order](/reference/purchase-order/) | 3 | A purchase order is a commitment to buy from one supplier account — lines of variants, quantities and receiving locations, priced in the supplier currency snapshot taken at creation. |
| [Purchase pack](/reference/purchase-pack/) | 7 | A purchase pack is how a supplier ships a variant — a case of 24, a pallet of 480 — with a code, the units per pack, an optional pack barcode (GTIN), a nominal weight and outer dimensions. |
| [Purchasing](/reference/purchasing/) | 16 | Purchase orders, returns to vendors, vendor invoices and supplier records. |
| [Reading your records](/reference/reading-your-records/) | 96 | Looking up and listing the records of your organization. |
| [Receipt](/reference/receipt/) | 3 | A receipt records goods arriving against one issued purchase order at one receiving location — lines address PO lines by number, each with a disposition: accept into stock, hold for review with a cann |
| [Refund](/reference/refund/) | 2 | A refund is money returned to the original card against a payment. |
| [Refunds and payment corrections](/reference/refunds-and-payment-corrections/) | 10 | Refunds, corrective notes and voiding invoices. |
| [Register](/reference/register/) | 7 | A register is one checkout lane at a logical facility — the till definition devices pair against. |
| [Register approvals](/reference/register-approvals/) | 1 | Approving or denying the requests raised at a register. |
| [Replenishment config](/reference/replenishment-config/) | 7 | A replenishment rule is one cell of your stock-planning settings, scoped by any mix of organization or location, category or style, season and brand — group-wide when none is set — carrying the parame |
| [Report](/reference/report/) | 7 | A saved report is a named, editable report definition — the plan that says which records, and either the columns to show for each record or the fields to group by and the measures to total — that anyo |
| [Return](/reference/return/) | 8 | A return is a customer bringing goods back against a sale — the goods-back document, distinct from a return to supplier and from a credit note, which corrects a bill rather than taking goods back. |
| [Review](/reference/review/) | 3 | A product review is one shopper’s written verdict on one product — a rating from 1 to 5, a title and a body — with a verified-purchase mark the system stamps itself when the shopper points at an order |
| [Role](/reference/role/) | 7 | A role is a named bundle of permissions granted per organization. |
| [Saga](/reference/saga/) | 2 | A saga is the record of one multi-step process the platform runs for you — a checkout, a stock transfer, a purchase-order receipt, the sourcing of a special order, or the clearance of a fiscal receipt |
| [Sale price](/reference/sale-price/) | 5 | A sale price is one dated window in the price schedule of an inventory item (a variant at one facility) — the price that holds between its start and end instants. |
| [Schedulable resource](/reference/schedulable-resource/) | 7 | A schedulable resource is a bookable thing at one of your locations — a staff member, a station like a fitting room, or a piece of equipment. |
| [Scratchpad](/reference/scratchpad/) | 5 | A scratchpad collects intent until it holds a plan — ordered steps in the API’s own vocabulary — and, once a person approves it, realizes the plan into records through the ordinary operations under th |
| [Search job](/reference/search-job/) | 2 | A background search is a saved search plan the platform runs for you — as you, with your own permissions — for up to five minutes, across related records: it starts from one kind of record, follows up |
| [Season](/reference/season/) | 7 | A season is a selling window — a collection period your styles and enablements can belong to. |
| [Segment](/reference/segment/) | 7 | A segment is a saved audience — a named group of shoppers for marketing and outreach. |
| [Selling](/reference/selling/) | 25 | Ringing sales, serving customers and issuing invoices. |
| [Size run](/reference/size-run/) | 7 | A size run is a ratio over one option dimension — S-M-L-XL as 1-2-2-1 — that a buyer fills a purchase matrix with: kept once and reused by every style that names it, or as the dimension’s own default. |
| [Stored value instrument](/reference/stored-value-instrument/) | 5 | A stored value instrument is spendable value your group has issued — a gift card, a gift certificate, or customer-bound store credit. |
| [Storefront](/reference/storefront/) | 8 | A storefront is your web shop’s publish configuration — the selling location it sells from, a canned theme, the merchandised collections, and optionally a custom domain. |
| [Style](/reference/style/) | 7 | A style is the product family — the top of the spine. |
| [Suggestion](/reference/suggestion/) | 3 | A suggestion is an offer the platform minted from bounded live reads: why, in plain words; the evidence it looked at; a drafted plan; and an expiry. |
| [Suggestion schema](/reference/suggestion-schema/) | 3 | A suggestion schema is one suggestion detector registered for an organization, active or parked. |
| [Supplier return](/reference/rtv/) | 3 | A supplier return (RTV) sends stock back to the supplier — lines of variants with quantities, a canned reason, and the source bucket they leave from. |
| [Support trail](/reference/support-trail/) | 2 | Opening a user’s sealed activity trail and the ledger of every opening. |
| [System and integration setup](/reference/system-and-integration-setup/) | 11 | Registers, connections and the settings your systems run on. |
| [Tag](/reference/tag/) | 5 | A tag is a free label you attach to styles and products to group and find them your own way. |
| [Task](/reference/task/) | 5 | A task is a tracked piece of work for your team — assign people or teams, label it, set a due instant, and point it at the records it concerns. |
| [Task label](/reference/task-label/) | 7 | A task label is a colored word you put on tasks to sort and spot them — pure organization for your work queue. |
| [Tax jurisdiction](/reference/tax-jurisdiction/) | 2 | Tax jurisdictions are the places whose tax rules can apply to a sale — countries, states, counties, cities and special districts. |
| [Tax rate](/reference/tax-rate/) | 2 | Tax rates are the percentages a jurisdiction charges, together with the dates they take effect. |
| [Tax registration](/reference/tax-registration/) | 7 | A tax registration records that one of your organizations is registered with a tax authority for a jurisdiction — the fact your tax paperwork hangs from. |
| [Team](/reference/team/) | 7 | A team is a working group of users. |
| [Till and cash management](/reference/till-and-cash-management/) | 2 | Manual drawer entries and force-closing a till. |
| [Till session](/reference/till-session/) | 6 | A till session is one register shift — the drawer story from opening float through the closing count. |
| [Till sessions](/reference/till-sessions/) | 2 | Opening, suspending, resuming and closing your own till session. |
| [Token account](/reference/token-account/) | 7 | The kernel wallet holds the prepaid kernels your group runs on — one wallet per group, opened once. |
| [Token purchase](/reference/token-purchase/) | 3 | A kernel purchase buys prepaid kernels for the wallet — you choose the USD amount and the server prices it at the volume tier (dollars per million kernels, cheaper in bulk). |
| [Training](/reference/training/) | 3 | Courses, tests, certificates and the training rules of your team. |
| [Training attempt](/reference/training-attempt/) | 2 | A training attempt is one sitting of a course’s test by one person — always the person who started it. |
| [Training certificate](/reference/training-certificate/) | 2 | A training certificate is the platform’s own record that a person passed a course — the holder, the course, the sitting, the score and the pass mark, the moment it was issued, and the version of the c |
| [Training question](/reference/training-question/) | 7 | A training question is one multiple-choice question in a course’s bank — the prompt, two to six options, which option is right, and the explanation shown after a sitting. |
| [Training requirement](/reference/training-requirement/) | 7 | A training requirement is the owner’s rule that people holding a certain kind of role must pass a course — one of the Playbook’s plays — and hold a valid certificate for it. |
| [Transfer](/reference/transfer/) | 3 | A transfer moves stock between two locations of your group in one shipment — lines of source items and quantities, fixed at birth. |
| [Transfer lane](/reference/transfer-lane/) | 7 | A transfer lane is your standing word on moving stock from one location to another, in that one direction — never (a prohibition), always (a preferred source), or ranked (an explicit order, with its r |
| [Transfer request](/reference/transfer-request/) | 3 | A transfer request is the pull side of moving stock — a location asks for what it needs, line by line, and supplying locations answer. |
| [User](/reference/user/) | 7 | A user is a person on your team — their sign-in identity plus the roles they hold at each organization. |
| [Variant](/reference/variant/) | 7 | A variant is the sellable cell under a product — the exact combination customers buy. |
| [Variant component](/reference/variant-component/) | 5 | A variant component is a build edge: this variant is assembled from that component variant in a given quantity. |
| [Vendor](/reference/vendor/) | 7 | A supplier is one company your group buys from — the shared record every organization points at, kept deliberately thin: a name and an optional reference code, nothing more. |
| [Vendor invoice](/reference/vendor-invoice/) | 3 | A supplier invoice captures the bill for one purchase order — merchandise match lines priced per PO line, actual landed-cost components, or both (at least one side). |
| [Warranty](/reference/warranty/) | 3 | One sold item’s warranty — born by the engine when a sale completes for any line whose product or maker carries active warranty terms; it says who honors it, how many units, when coverage started and  |
| [Warranty terms](/reference/warranty-terms/) | 7 | Warranty terms are a warranty policy template — who honors it (the manufacturer or the vendor), how many days it runs, and what it covers in your own words — attached to exactly one product or one man |
| [Webhook subscription](/reference/webhook-subscription/) | 6 | A webhook subscription pushes your events to an outside system as they happen — pick the event names, give an https endpoint, and every delivery arrives signed with the subscription’s secret. |
| [Work and notes](/reference/work-and-notes/) | 17 | Tasks, notes, messages, dashboards and the everyday tools every staff member keeps. |
| [Your own session](/reference/your-own-session/) | 41 | What every signed-in person may do for themselves — their session, their profile and their own work. |
| [Zone](/reference/zone/) | 7 | A zone is a named area inside a logical facility — receiving, backroom, the floor. |