Orders. 40 operations.

Address is a postal address in its fields and on one line: the domain's address, which the store's own address will take when the operations give store details.

AttentionChange is what a dismissal did: whether it changed the list, and the order's item as the list then holds it, absent once the order left it.

AttentionItem is an order on the attention list and why it is there, one or more codes of AttentionReasons.

Buyer is who placed an order, as the checkout took it.

CashCollected is the cash of an order paid on delivery as it was collected.

ChargeSettleRequest settles a renewal order's charge of unknown outcome by hand. A request with no body changes nothing: send {} at least, for this and every operation with a body.

CollectPlace is a place of the store the buyer collects an order at, as the order keeps it: the place's key and name, its address in one line (the street, the suburb, the city and the postal code, as far as each is known) and its opening hours as the owner wrote them (CR-4).

CollectionAsked is the window a booking asked the courier to collect in (collection,; version 6, additive): its day and hours in the store's time zone, an IANA name.

CourierEvent is one tracking event a courier gave of a shipment: the state it mapped to, when, and the courier's words of it: its text and its location, "" when it gave none (an erased order's are blank).

CourierShipment is one booking of a courier for an order: its id; the connector and environment that booked it; the service; the courier's reference and the carrier's waybill ("" until given); its state (booking, booked, collected, in_transit, out_for_delivery, ready_for_collection, delivered, problem, returned, cancelled or unknown; the two finer states of a parcel on its way from ) and the courier's own word for a state it does not map; what the buyer paid and what the courier charges (zero until it says); the estimated dates (YYYY-MM-DD, "" for none); the courier's tracking page; whether its label is kept; when it was made and booked (null until the courier answered); who booked it; and who resolved its unknown booking and when (null for none). From the step that added them: whether the courier did not give its label within a day; where its cancel at the courier stands ("" for none, requested or failed), the courier's or the engine's words when it failed, and who asked for it ("" for the order's cancel or refund). The state's text and the cancel's words are the engine's own, said in the catalogue's language, or the courier's text as it is, at most 300 runes: show both as text, never as markup.

DeliveryFacts are an order's delivery (from version 6): its kind, one of the Delivery kinds; its method in the engine's words (the zone's name, the flat rate, the courier's service and how it reaches the buyer, or no delivery); the shipping line's price; and how many units of products the order holds.

DownloadRecord is one download of a grant: when, and the SHA-256 of the file it served. From version 6.

Event is one change of an order's status.

Line is one line of an order, as copied at confirm.

LineChoice is a buyer's answer on a cart line or an order line: the label the field had at the confirm, and the value. An order never changes it, and a privacy erasure of the buyer replaces a text value with the catalogue's word "erased".

LineCombo is the combo a part line came from: its SKU and its title as they were at confirm, how many combos the order holds, and Index, which combo line of the cart it was, from 0 (two lines of one combo at two cadences stay apart). First is true on the first part line of the combo. Total, Discount and VAT are the sums of the combo's part lines: the discount, the total after it and the VAT in it.

LineDownload is a digital line's download grant as the owner sees it: the most downloads it allows, the downloads used, its expiry, when it was revoked (null while it stands), and its downloads, newest first, at most 50, each with the digest of the file it served; no IP address and no user agent are kept. From version 6.

LinePriceLog is the price log of an order line the owner priced: Reason, By (who set the price, such as user:owner), At, and Catalogue, the catalogue's price of one unit it stands against (zero for a custom line, which has none).

Money is an amount: in minor units of its ISO 4217 currency, and as the store displays it.

Order is an order as the owner sees it.

OrderCash is the cash of an order paid on delivery: what is to be collected, the order's frozen total, and, once it was, the cash collected (null before): when, how much and who said so (the owner, an integration, or the courier). The order's status is not changed by it. An order under account terms shows it too, as its payment on account: ToCollect is the invoice's total and Collected the payment once recorded, with how it was made and its reference (additive).

OrderChange is an order as an operation left it, and whether the operation changed it: an order already where the operation takes it is left as it is.

OrderLink is the other order of a pair of linked orders: its number and its role in the pair, deposit or balance (the opposite of the role of the order that carries the link).

OrderNote is one internal note of an order (from version 6): its text, who wrote it in words (owner, or an integration's name), and when. No buyer's page or mail shows it.

OrderPOS is the sale at the till an order is: the key and the name of the stock location it was sold at, the device and its sale number, when it was sold by the device's clock (the order's placed_at is when the store received it).

OrderSearch is a page of the orders a search finds, how many it finds in all, and whether a later page holds more.

OrderSeller is the team member who sold a sale at the till: the account's id, its name ("" for none) and its email.

OrderTerms are the payment terms an order was entered under: the term's id in the store's settings, its kind (pay_now, eft or account), the days after the invoice that it falls due (0: on receipt) and the moment of the tax invoice (accepted or dispatched; "" for a kind that has none).

PaymentFacts are an order's payment (from version 6): its method's id and its gateway's name ("" for none); what it paid, its frozen total once paid, else nothing; when it was paid, null while it never was; the gateway's reference of its last captured payment, "" for none; and what was refunded of it, declined refunds aside. State is where its payment stands, one of the Payment states, "" for none of them (such as an order cancelled before it was paid), by the rule orders.search's payment filter narrows by.

PickupPoint is a pickup point or a locker an order is delivered to, as the courier connector listed it at the confirm: the connector's id of it, its kind (pickup_point or locker), who runs it, its name, the courier's own words about it, its address, where it is (lat and lng, null when not known), its distance in metres from the buyer's address (null when not given), its hours, one line per day as given, and provider, the connector that listed it, which books it. From version 6.

PlaceBuyer is who the order is for, as the owner types them (until the customer records are built): the name and the email are required; the delivery address when something ships; the billing address when it differs.

PlaceLine is a line of the order: a catalogue variant (SKU, Quantity) or a custom line (Title, Quantity, Price). Price is a price with two decimals, such as 300.00: for a custom line always, for a variant line only to depart from the catalogue's. DiscountPercent (such as 12.5) or DiscountAmount (a price) takes something off a variant line, not both; a price or a discount other than the catalogue's needs a Reason (at most 300 characters), kept in the line's price log with who set it and when. NoVAT makes a custom line free of VAT.

PlaceOrderRequest is the order the owner enters at once (orders.place): the buyer, the lines, the shipping, the payment term, the purchase order number and one of the three ways to pay. It is one transaction: it makes the order and what the term and the way make with it, or nothing. The same Idempotency-Key gives the same order.

PlacePOS is a sale at the till (-): the key of an active stock location it was sold at; the device that sold it and its sale number there, each 1 to 64 visible characters; and when it was sold, by the device's clock (RFC 3339), at most 5 minutes ahead of the store's clock and at most pos.max_sale_age_days (30 when the store gives none) before it.

PlacePayment is the payment of a "paid" order: How is one of PaymentHows, Reference one line of at most 100 characters, ReceivedOn a date such as 2026-10-19 in the store's zone, not in the future (today when left out).

PlaceQuote is the kept quote an order is made from and the rate of it that is chosen, by its stable key: the connector and the courier's service code, as the quote desk and the booking use them.

PlaceShipping is the shipping the owner types: Kind is "price" (Price, a price with two decimals), "free", "collect" (the buyer collects it: no shipping line is booked) or "none"; Label names the shipping line of a price or free.

PlacedOrder is the order orders.place made, and the path of its page for the buyer, where a pay_now order is paid.

PostalAddress is an address in its fields, as the store's details take and give it. From contract version 6.

Quote is what a courier said of an order's shipping line, each part "" when it did not say: the service's name, the carrier, the courier's code of the service, how the parcel reaches the buyer (door, pickup_point or in_store), and the estimated delivery dates (YYYY-MM-DD).

ReadChange is what a read mark did: whether it changed the item from unread to read for its actor.

ReceiptResend is where an order's confirmation is sent again: To, an email address; "" for its buyer's.

ReceiptSent is the confirmation sent again: the order's number and the address it is sent to.

RecordPaymentRequest is the owner's record that the order under account terms was paid: How is one of PaymentHows (any case); Reference, optional, is the bank's or the client's own, one line of at most 100 characters; ReceivedOn, optional, is the day the money came, a date such as 2026-10-19 in the store's zone, not in the future nor before the order was placed (today when left out); Amount, optional, is a price with two decimals, which must be the invoice's total (left out, it is). No part is taken in version 1.

Refund is one refund of an order.

RefundLine is a quantity of an order's line a refund names. Kind is "product" (or left out) for a product line by its SKU, and "fee" for the order's fee of cash on delivery, which has no SKU and a quantity of 1 (additive); a fee line of an order that keeps its fee is refused.

RefundRequest is a refund the owner asks for: an amount of what the order paid, text with exactly two decimals in the store's currency, the lines it refunds, if any, and why.

Reply is a reply to an order's mail, as the store read it: who sent it, when, its subject, and its text, always plain text: a reply written in HTML alone is turned into text, never shown as HTML.

SalesPeriod is one period's sales. An order counts in the period it was paid in, by the time of its paid event, whatever it has moved to since, a full refund too; an order never paid, a cancelled one never paid with it, counts nothing. A refund counts in the period the store recorded it in, unless its gateway declined it.

SalesSummary is the store's sales in three periods, each in the store's time zone from a local midnight to now: today; the last 7 days, today and the 6 days before it; and the last 30 days, today and the 29 days before it. Every amount is in Currency, the store's. From contract version 6.

ShipRequest is the shipment the owner ships an order with (amended 2026-10-07, from version 6): the carrier, at most 40 characters on one line and no link, and the tracking number, at most 40 letters, digits and hyphens; each may be left out, and a ship with no body ships with neither. Any other is Invalid.

Shipment is one shipment of an order as last corrected (from version 6): the id a correction names, the carrier and tracking number, when it was shipped, and whether the owner corrected it since.

Tender is one payment of an order: a gift card, or the method of the rest (ASI-5 ). The code of a card is never in it.

TillHeld are the sales at the till staff must check: each an order and its open marks, AttentionTillPrice and AttentionTillBeforeStop.

TillHeldClose is the mark of a sale at the till staff checked: TillMarkPrice or TillMarkStop.

TimelineEntry is one thing that happened to an order (from version 6): when; its kind, one of the Timeline kinds; who did it, in words (owner, guest, payment, system, courier, or an integration's name, never its raw id); the engine's words for it; and, by kind, its status (a status entry's status, a refund's state, a payment's type such as captured or failed), its amount (a cash collected's, a payment's, a refund's), its reference (a payment's gateway reference, a shipment's tracking number), its SKU (a download grant's) and its template (a mail's type). Entries are oldest first; entries of the same time in the order of the kinds, then as they were recorded.

UnreadReply is a reply its reader has not marked read, with the number of its order (E3).