Catalogue. 88 operations.

ChoiceField is a question a product asks the buyer for each cart line: a free text, or one value of a list. Its Key never changes after an order uses it.

Combo is a combo variant as the operations show it: whether it sells at the sum of its parts' prices, and its parts in order. From version 6.

ComboPartRequest is a part of a combo: the SKU of a variant of the store that is no combo itself, once in a combo, and how many of it one combo holds, from 1 to 99.

Dimensions are a variant's size in whole millimetres: all three 0 for none, or each from 1 to 10 000.

FieldValue is the value of a field in a request: a text, a number, a bool or a list of them, as JSON writes them, read as the list of texts the field judges: a number as it is written, true and false as yes and no; null, none.

array of string or string or number or boolean or null

FieldValuesRequest sets the values of fields for the product or the variant its path names: each by the field's key, null to unset it.

LinksRequest is one of a product's lists of other products, its kind (related, upsells or cross_sells) and the products' slugs, in order.

MadeToOrderRequest makes the variants of a product made to order, or not. SKU names one variant; "" sets every variant of the product. ProductionDays is 1 to 365 and is needed when MadeToOrder is true; Supplier is a supplier's key, or "" when the store makes it itself. A variant that tracks stock, a digital variant, a gift card, a combo or a part of one is Refused, and so is a supplier that is none or archived.

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

OptionPictures is the list of pictures of one value of one option of a product (ASI-3.5, C14): the names of the product's own pictures, in order. A variant with none of its own shows the list of the first of its option values that has one, else its product's pictures. Additive, from version 6.

OptionPicturesRequest sets the list of pictures of one value of one option of a product; no names take the list away.

OptionsRequest is a product's options and its variants' values of them: its option names, in order, none for a product with one live variant; and every variant of the product, archived ones included, each once, with its value of each option, by the option's name.

PictureNoteRequest is the free text the owner keeps on a picture, for any purpose.

PictureVersion is a picture, or an edited version of one, with its review state (ASI-3.1 to ASI-3.6). A version has Of, the name of the original it is a version of; an original has Of "" and Shown, the name of the version it shows, "" when it shows itself. Additive, from version 6.

PriceRequest is a variant's new price, as the owner enters it.

Product is a product of the catalogue, with every variant.

ProductChange is a product as an operation left it, and whether the operation changed it.

ProductClassesRequest sets the review classes a product is of, by key (none for none); a key the store has not is Invalid.

ProductRetirement is how a product left the shop (PR-4): At, when it was retired; ReplacedBy, the slug of the product that replaces it, "" for none; KeepPage, whether its address keeps a page that says it is no longer sold.

ReviewActResult is the product after an act: its state and look-again flag, whether it is published, and, after an approval, the next product of the list ("" for none).

ReviewClass is a review class of the store's (ASI-2.3): its key, and the label and the badge's words the store writes.

ReviewClasses are the store's review classes, in its order.

ReviewClassesRequest replaces the store's review classes whole. A key is 1 to 40 of a-z, 0-9 and "-"; Label and Badge are the store's own words. A class a product still holds cannot be left out (Invalid, naming it).

ReviewSetting is the store's catalogue.review and what turning it on would move (ASI-2.1, 46h).

Sale is a variant's sale price and its window: the price it sells at from Start, inclusive, to End, exclusive.

SaleRequest is a variant's sale as the owner enters it: its price, text with exactly two decimals, and its start and end, each a date such as 2026-10-01 or a date and time such as 2026-10-01T08:00 in store.timezone, the end after the start.

SetRetiredRequest changes the retirement of a retired product (PR-4): ReplacedBy, the slug of the product that replaces it, "" for none (a product retired too is followed to the first on sale, at most 5 steps; the product itself is refused); KeepPage, whether its page is kept.

SetReviewRequest turns the review on or off. Turning it on needs Existing (Invalid without it); turning it off keeps every record.

SlugRequest is the slug a product moves to.

StockAlertCount is the demand for back-in-stock alerts of one variant: it holds no address.

StockRequest is a variant's new stock count, and the count the caller saw, which the store must still hold for the set to be made. The body must carry both: the API door refuses one without either. Location names the stock location whose level is set; none (or main) is the location main. Expected and Count are then that location's.

Variant is a variant of a product.

VariantChange is a variant as an operation left it, and whether the operation changed it.

VariantDetailsRequest is the details of a variant the owner sets: each one given is set, and each left out stays as it is.

VariantFile is a digital variant's file: its name as a download is saved, its size in bytes, its SHA-256 in lower-case hex, and when and by whom it was uploaded. From contract version 6.

VariantImagesRequest is the images a variant shows: names of images of its own product, each once, in order; none clears them, and the variant then shows its product's.

VariantOptions are one variant's values of its product's options, by the option's name.

VariantStock is a variant that runs low: its SKU, its product's slug and title, its option values, its stock level (low_stock, out_of_stock or backorder) and its available stock.