Tillwire Read the guide
API reference

Catalogue. 88 operations.

88 of them work. Page 3 of 5. Each needs a bearer token with its scope. All operations.

Operations

POST/api/v1/catalogue/variants/{sku}/file/removecatalogue.remove-variant-filecatalogue.write

Parameters

skupathstring
skupathstring
Idempotency-KeyheaderstringSee common parameters

Answer

Deletion

Errors: 401, 403, 404, 405, 409, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/variants/{sku}/file/remove

POST/api/v1/catalogue/images/{name}/request-versioncatalogue.request-versioncatalogue.write

Parameters

namepathstring
namepathstring
Idempotency-KeyheaderstringSee common parameters

Request body

VersionRequest

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/images/{name}/request-version

GET/api/v1/catalogue/review-classescatalogue.review-classescatalogue.read

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/review-classes

GET/api/v1/catalogue/reviewcatalogue.review-listcatalogue.read

Parameters

statequerystringto_review (when left out), needs_information, approved, retired or all (every state but retired). Refused (invalid) while catalogue.review is off.
qquerystringA product's title or a variant's code, in part.
propertyquerystringships, does_not_ship, made_of_items or no_own_price.
categoryquerystringA category's slug: the products in it or in a category under it.
checkquerystringA part not done (pictures, description, values, questions) or look_again.
afterquerystringThe cursor of the page: the next of the page before; the first page when left out. The products follow it.
limitqueryintegerThe most products in the page: 1 to 100; 50 when left out.

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/review

GET/api/v1/catalogue/review-settingcatalogue.review-settingcatalogue.read

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/review-setting

POST/api/v1/catalogue/images/{name}/reviewcatalogue.review-versioncatalogue.write

Parameters

namepathstring
namepathstring
Idempotency-KeyheaderstringSee common parameters

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/images/{name}/review

GET/api/v1/catalogue/review/{slug}catalogue.review-workspacecatalogue.read

Parameters

slugpathstring
slugpathstring
statequerystringThe list the product was opened from: to_review (when left out), needs_information, approved, retired or all; for its place.
qquerystringThe list's words: a title or a code.
propertyquerystringThe list's property: ships, does_not_ship, made_of_items or no_own_price.
categoryquerystringThe list's category slug.
checkquerystringThe list's check: a part not done, look_again, retire or a review class.

Errors: 401, 403, 404, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/review/{slug}

POST/api/v1/catalogue/categoriescatalogue.save-categorycatalogue.write

Parameters

Idempotency-KeyheaderstringSee common parameters

Request body

CategoryRequest

Answer

Category

Errors: 401, 403, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/categories

POST/api/v1/catalogue/collectionscatalogue.save-collectioncatalogue.write

Parameters

Idempotency-KeyheaderstringSee common parameters

Request body

CollectionRequest

Errors: 401, 403, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/collections

POST/api/v1/catalogue/fieldscatalogue.save-fieldcatalogue.write

Parameters

Idempotency-KeyheaderstringSee common parameters

Request body

FieldRequest

Errors: 401, 403, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/fields

GET/api/v1/catalogue/searchcatalogue.searchcatalogue.read

Parameters

qquerystringThe words to search the catalogue for.
pagequeryintegerSee common parameters

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/search

POST/api/v1/catalogue/review/{slug}/send-backcatalogue.send-backcatalogue.write

Parameters

slugpathstring
slugpathstring
Idempotency-KeyheaderstringSee common parameters

Request body

SendBackRequest

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/review/{slug}/send-back

POST/api/v1/catalogue/products/{slug}/categoriescatalogue.set-categoriescatalogue.write

Parameters

slugpathstring
slugpathstring
Idempotency-KeyheaderstringSee common parameters

Request body

CategoriesRequest

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/products/{slug}/categories

POST/api/v1/catalogue/products/{slug}/choicescatalogue.set-choicescatalogue.write

Parameters

slugpathstring
slugpathstring
Idempotency-KeyheaderstringSee common parameters

Request body

ChoicesRequest

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/products/{slug}/choices

POST/api/v1/catalogue/collections/{slug}/productscatalogue.set-collection-productscatalogue.write

Parameters

slugpathstring
slugpathstring
Idempotency-KeyheaderstringSee common parameters

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/collections/{slug}/products

POST/api/v1/catalogue/collections/{slug}/rulescatalogue.set-collection-rulescatalogue.write

Parameters

slugpathstring
slugpathstring
Idempotency-KeyheaderstringSee common parameters

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/collections/{slug}/rules

POST/api/v1/catalogue/variants/{sku}/compare-atcatalogue.set-compare-atcatalogue.write

Parameters

skupathstring
skupathstring
Idempotency-KeyheaderstringSee common parameters

Request body

CompareAtRequest

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/variants/{sku}/compare-at

POST/api/v1/catalogue/products/{slug}/detailscatalogue.set-detailscatalogue.write

Parameters

slugpathstring
slugpathstring
Idempotency-KeyheaderstringSee common parameters

Request body

DetailsRequest

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/products/{slug}/details

POST/api/v1/catalogue/products/{slug}/enquirycatalogue.set-enquirycatalogue.write

Parameters

slugpathstring
slugpathstring
Idempotency-KeyheaderstringSee common parameters

Request body

EnquiryRequest

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/products/{slug}/enquiry

POST/api/v1/catalogue/images/{name}/altcatalogue.set-image-altcatalogue.write

Parameters

namepathstring
namepathstring
Idempotency-KeyheaderstringSee common parameters

Request body

ImageAltRequest

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/catalogue/images/{name}/alt

Schemas 57

CategoriesRequest

CategoriesRequest is the categories a product is in, each by its slug or its name, in order, the first its primary; none takes it out of every category.

categoriesrequiredarray of string
Category

Category is a category of the store's tree as the owner sees it: its name, its slug, its parent's slug ("" for a root), its description in the safe Markdown subset, its position among its siblings (0 for none), and its trail, the names from the root down to it, such as "Braais / Accessories", which tells two categories of one name apart.

descriptionrequiredstring
enquiry_mail_torequiredstring
enquiry_onlyrequiredboolean
namerequiredstring
parentrequiredstring
positionrequiredinteger
slugrequiredstring
trailrequiredstring
CategoryRequest

CategoryRequest is a category the owner saves: in place of the category at Old, or added when Old is "". Slug "" is the name's slug; Parent is the parent's slug, "" for a root.

descriptionstring
enquiry_mail_tostring
enquiry_onlyboolean
namerequiredstring
oldstring
parentstring
positioninteger
slugstring
ChoiceField

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.

helprequiredstring
keyrequiredstring
kindrequiredstring
labelrequiredstring
linesrequiredinteger
max_lengthrequiredinteger
optionalrequiredboolean
valuesrequiredarray of string
ChoicesRequest

ChoicesRequest sets the choice fields of a product, whole, in the order the buyer sees them: 0 to 10. A product that is a gift card, a combo, a part of a combo or a subscription plan is Refused; a key that an order used and that is left out or changed in kind is Refused. No fields takes them away.

choicesrequiredarray of ChoiceField
Collection

Collection is a collection as the owner sees it: its title, its slug, its description in the safe Markdown subset, whether buyers see it, and its products by slug, in the owner's order.

descriptionrequiredstring
dynamicrequiredboolean
product_countrequiredinteger
productsrequiredarray of string
publishedrequiredboolean
revisionrequiredinteger
rulesCollectionRules
rules_saved_atstring (date-time)
rules_saved_bystring
rules_textstring
slugrequiredstring
titlerequiredstring
CollectionCondition

CollectionCondition is one condition: its kind, and the arguments of that kind, the others left out. Kinds: category (a category's slug, and the categories below it), price (Min, Max, either one may be left out), on_sale, in_stock, new_within (Days, from 1 to 365) and option (Option, an option's name, and Value, one of its values, in any case) and field (Field, a custom product field's key, and either Value, a choice or yes/no value of it, or Lo and Hi, the lowest and the highest of a number or a date, as the field writes them, either one may be left out). A price is text with exactly two decimals, VAT-inclusive as the owner enters it.

categorystring
daysinteger
fieldstring
histring
kindrequiredstring
lostring
maxstring
minstring
optionstring
valuestring
CollectionProductsRequest

CollectionProductsRequest is the products of a collection, by slug, in the owner's order.

productsrequiredarray of string
CollectionRequest

CollectionRequest is a collection the owner saves: its title, slug and description in place of the collection at Old's, its products and publication as they are; or, when Old is "", a collection added, unpublished, with Products, slugs, in the owner's order. Slug "" is the title's slug.

descriptionstring
oldstring
productsarray of string
slugstring
titlerequiredstring
CollectionRules

CollectionRules are a dynamic collection's rules: how the conditions combine, all or any; the conditions; and the sort of its products, one of newest, price_asc, price_desc, title and featured. From contract version 6.

conditionsrequiredarray of CollectionCondition
matchrequiredstring
sortrequiredstring
CollectionRulesRequest

CollectionRulesRequest saves a collection's rules: the revision of the rules as the owner read them, which another save may have moved on; and the rules, or null to clear them, the collection being manual again with the list it had.

revisionrequiredinteger
rulesrequiredCollectionRules
Combo

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.

partsrequiredarray of ComboPartRequest
sumrequiredboolean
ComboPartRequest

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.

quantityrequiredinteger
skurequiredstring
CompareAtRequest

CompareAtRequest is a variant's compare-at price, as the owner enters it: text with exactly two decimals, above its price and its sale price; "" takes it away. The body must carry it: the API door refuses one without it.

compare_atrequiredstring
Deletion

Deletion is what a delete deleted: the slug of the category, the collection or the content page that is gone, or the name of the image.

deletedrequiredstring
DetailsRequest

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

card_titlestring
categorystring
country_of_originstring
descriptionstring
featured_positioninteger
hs_codestring
meta_descriptionstring
meta_titlestring
ships_freeboolean
short_descriptionstring
titlestring
Dimensions

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

height_mmrequiredinteger
length_mmrequiredinteger
width_mmrequiredinteger
EnquiryRequest

EnquiryRequest is a product's enquiry settings (ASI-6.1, ASI-6.3): its mode (inherit, enquiry or buyable) and whether the page shows its price beside the form.

moderequiredstring
show_pricerequiredboolean
FieldDefinition

FieldDefinition is one field: the key a theme and a filter name it by, which never changes; the label a buyer reads; its type (text, number, yes_no, choice or date); its scope (product or variant); where it is shown (page, listings, both or hidden); whether it is filterable; its position; a number's unit; a choice field's choices and whether it holds several; how many products or variants hold a value of it; and who saved it and when.

choicesarray of string
countrequiredinteger
filterablerequiredboolean
keyrequiredstring
labelrequiredstring
multipleboolean
positionrequiredinteger
saved_atstring (date-time)
saved_byrequiredstring
scoperequiredstring
shownrequiredstring
typerequiredstring
unitstring
FieldRequest

FieldRequest saves a definition, whole, by its key: a new one is added, one the definitions hold is replaced. Revision is the definitions' as the owner read them. A position of 0 puts a new field last. Renames moves the values of a choice that is renamed (old to new), so it need not be dropped.

choicesarray of string
drop_from_collectionsboolean
dropsarray of string
filterablerequiredboolean
keyrequiredstring
labelrequiredstring
multipleboolean
newboolean
positioninteger
renamesmap of string
revisionrequiredinteger
scoperequiredstring
shownrequiredstring
typerequiredstring
unitstring
HeldChange

HeldChange is a change after approval, held for a person (ASI-2.8).

approvedrequiredstring
atrequiredstring (date-time)
byrequiredstring
digestrequiredstring
fieldrequiredstring
idrequiredinteger
newrequiredstring
variantrequiredstring
ImageAltRequest

ImageAltRequest is an image's alt text, plain text on one line of at most MaxImageAlt characters; "" takes it away. The body must carry it: the API door refuses one without it.

altrequiredstring
ImageUpload

ImageUpload is a product's image: as its upload left it, and as catalogue.images reads it.

altrequiredstring
copy_failurestring
heightrequiredinteger
namerequiredstring
positionrequiredinteger
processingrequiredboolean
productrequiredstring
thumbnailrequiredstring
widthrequiredinteger
Money

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

currencyrequiredstring
displayrequiredstring
minorrequiredinteger
PictureReviewRequest

PictureReviewRequest is the review of a picture or a version: State is approved, rejected or reopened. Note is needed to reject or to reopen; Checks are the lines of the store's checklist ticked, all of them to approve; Digest is the PictureVersion.Digest the reviewer saw, "" to skip the check.

checksrequiredarray of string
digestrequiredstring
noterequiredstring
staterequiredstring
PictureVersion

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.

altrequiredstring
digestrequiredstring
heightrequiredinteger
heldrequiredboolean
hold_reasonrequiredstring
largerequiredstring
made_byrequiredstring
namerequiredstring
noterequiredstring
ofrequiredstring
shownrequiredstring
sourcerequiredstring
source_refrequiredstring
staterequiredstring
thumbnailrequiredstring
uploaded_atrequiredstring (date-time)
widthrequiredinteger
Product

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

card_titlerequiredstring
categoriesrequiredarray of string
categoryrequiredstring
choicesrequiredarray of ChoiceField
choices_allowedrequiredboolean
choices_refusedstring
country_of_originrequiredstring
cross_sellsrequiredarray of string
descriptionrequiredstring
enquiry_moderequiredstring
enquiry_onlyrequiredboolean
enquiry_show_pricerequiredboolean
featured_positionrequiredinteger
fieldsrequiredmap of array of string
hs_coderequiredstring
meta_descriptionrequiredstring
meta_titlerequiredstring
optionsrequiredarray of string
relatedrequiredarray of string
retiredProductRetirement
ships_freerequiredboolean
short_descriptionrequiredstring
slugrequiredstring
titlerequiredstring
unpublished_atstring (date-time)
updatedstring (date-time)
upsellsrequiredarray of string
variantsrequiredarray of Variant
ProductChange

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

changedrequiredboolean
productrequiredProduct
ProductFields

ProductFields are the definitions of the custom product fields, in the owner's order, at the revision each write must send back (0 while the owner never saved one).

fieldsrequiredarray of FieldDefinition
revisionrequiredinteger
ProductRetirement

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.

atrequiredstring (date-time)
keep_pagerequiredboolean
replaced_byrequiredstring
ProductSearch

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

morerequiredboolean
ofrequiredinteger
productsrequiredarray of Product
RetireProposal

RetireProposal is a retire proposed and not decided (ASI-2.12).

atrequiredstring (date-time)
byrequiredstring
digestrequiredstring
noterequiredstring
targetrequiredstring
ReviewActResult

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).

look_againrequiredboolean
nextrequiredstring
publishedrequiredboolean
slugrequiredstring
staterequiredstring
ReviewBy

ReviewBy is who did an act and when.

atrequiredstring (date-time)
byrequiredstring
ReviewClass

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.

approversarray of string
badgerequiredstring
block_claimsarray of string
keyrequiredstring
labelrequiredstring
ReviewClasses

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

classesrequiredarray of ReviewClass
ReviewCounts

ReviewCounts are the products of each review state (ASI-7.3).

allrequiredinteger
approvedrequiredinteger
needs_informationrequiredinteger
to_reviewrequiredinteger
ReviewDescription

ReviewDescription is the description and its state (ASI-2.3). The long and the short description each have their own state: the description part is done when the long one is accepted and the short one is accepted or empty. The fields without a prefix are the long description's.

acceptedrequiredReviewBy
digestrequiredstring
longrequiredstring
shortrequiredstring
short_acceptedrequiredReviewBy
short_digestrequiredstring
short_sourcesrequiredarray of string
short_staterequiredstring
sourcesrequiredarray of string
staterequiredstring
ReviewEvent

ReviewEvent is a line of the product's review history (ASI-2.11).

atrequiredstring (date-time)
byrequiredstring
kindrequiredstring
wordsrequiredstring
ReviewItem

ReviewItem is an item of a combo.

pricerequiredstring
quantityrequiredinteger
skurequiredstring
titlerequiredstring
ReviewList

ReviewList is a page of the review list (ASI-7.1 to 7.3), in its stable order: by the time each product entered its state, then by its id (ASI-7.4).

classesrequiredarray of ReviewClass
countsrequiredReviewCounts
firstrequiredinteger
nextrequiredstring
prevrequiredstring
rowsrequiredarray of ReviewRow
totalrequiredinteger
ReviewNote

ReviewNote is words a person wrote, with who and when.

atrequiredstring (date-time)
byrequiredstring
wordsrequiredstring
ReviewPart

ReviewPart is one part of a product's review (ASI-2.2) and what it lacks. The page writes the words.

donerequiredboolean
missingrequiredarray of string
partrequiredstring
staterequiredstring
ReviewPicture

ReviewPicture is a picture of the product (ASI-3's states).

digestrequiredstring
mainrequiredboolean
namerequiredstring
option_valuerequiredstring
sourcerequiredstring
source_refrequiredstring
staterequiredstring
urlrequiredstring
variantrequiredstring
ReviewPlace

ReviewPlace is the product's place in the list it was opened from (ASI-7.4).

inrequiredboolean
indexrequiredinteger
nextrequiredstring
ofrequiredinteger
prevrequiredstring
ReviewQuestion

ReviewQuestion is an open or resolved question (ASI-2.4).

answerrequiredstring
answeredrequiredReviewBy
choicesrequiredarray of string
digestrequiredstring
idrequiredinteger
rightrequiredstring
right_rolesrequiredarray of string
textrequiredstring
ReviewRow

ReviewRow is one product of the review list (ASI-7.2).

categoryrequiredstring
category_namerequiredstring
changed_atrequiredstring (date-time)
classesrequiredarray of ReviewClass
codesrequiredinteger
look_againrequiredboolean
open_questionsrequiredinteger
optionsrequiredboolean
partsrequiredarray of ReviewPart
picturerequiredstring
propertiesrequiredarray of string
retire_proposedrequiredboolean
slugrequiredstring
staterequiredstring
titlerequiredstring
ReviewSetting

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

onrequiredboolean
productsrequiredinteger
publishedrequiredinteger
turn_on_secondsrequiredinteger
ReviewStock

ReviewStock says how the stock is managed (ASI-2.11).

externalrequiredboolean
labelrequiredstring
ReviewVariant

ReviewVariant is a variant the shop sells, with its values (ASI-2.2.3).

height_mmrequiredinteger
itemsrequiredarray of ReviewItem
length_mmrequiredinteger
missingrequiredarray of string
option_valuesrequiredarray of string
pricerequiredstring
sellsrequiredboolean
skurequiredstring
stockrequiredinteger
weight_gramsrequiredinteger
width_mmrequiredinteger
ReviewWorkspace

ReviewWorkspace is one read of what the review page shows (ASI-2.11).

approvedrequiredReviewBy
categoryrequiredstring
category_namerequiredstring
classesrequiredarray of ReviewClass
deliveryrequiredstring
descriptionrequiredReviewDescription
digestrequiredstring
heldrequiredarray of HeldChange
historyrequiredarray of ReviewEvent
look_againrequiredboolean
optionsrequiredboolean
partsrequiredarray of ReviewPart
photo_askedrequiredReviewNote
picturesrequiredarray of ReviewPicture
placerequiredReviewPlace
price_fromrequiredstring
price_torequiredstring
propertiesrequiredarray of string
publishedrequiredboolean
questionsrequiredarray of ReviewQuestion
retirerequiredRetireProposal
rightsrequiredarray of string
sent_backrequiredReviewNote
slugrequiredstring
sourcesrequiredarray of string
staterequiredstring
stockrequiredReviewStock
titlerequiredstring
variantsrequiredarray of ReviewVariant
Sale

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

endrequiredstring (date-time)
pricerequiredMoney
startrequiredstring (date-time)
SendBackRequest

SendBackRequest sends the product back with a note (ASI-2.7).

noterequiredstring
Variant

Variant is a variant of a product.

allow_backorderrequiredboolean
archived_atstring (date-time)
comboCombo
compare_atMoney
digitalrequiredboolean
dimensionsDimensions
dispatch_byrequiredstring
fieldsrequiredmap of array of string
filerequiredVariantFile
imagesrequiredarray of string
low_stock_thresholdinteger
made_to_orderrequiredboolean
option_valuesrequiredarray of string
pricerequiredMoney
production_daysrequiredinteger
saleSale
ships_alonerequiredboolean
skurequiredstring
stockrequiredinteger
supplierrequiredstring
tax_classrequiredstring
track_stockrequiredboolean
weight_gramsrequiredinteger
VariantChange

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

changedrequiredboolean
variantrequiredVariant
VariantFile

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.

digestrequiredstring
namerequiredstring
sizerequiredinteger
uploaded_atrequiredstring (date-time)
uploaded_byrequiredstring
VersionRequest

VersionRequest asks a picture tool for a new version of a picture: Tool is its kind (60 characters at most), Note what to change (500 characters at most).

noterequiredstring
toolrequiredstring

Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.