Tillwire Read the guide
API reference

Catalogue. 88 operations.

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

Operations

POST/api/v1/catalogue/collections/{slug}/unpublishcatalogue.unpublish-collectioncatalogue.write

Parameters

slugpathstring
slugpathstring
Idempotency-KeyheaderstringSee common parameters

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

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

POST/api/v1/catalogue/products/{slug}/unretirecatalogue.unretirecatalogue.write

Parameters

slugpathstring
slugpathstring
Idempotency-KeyheaderstringSee common parameters

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

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

POST/api/v1/catalogue/products/{slug}/imagescatalogue.upload-imagecatalogue.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/products/{slug}/images

POST/api/v1/catalogue/mediacatalogue.upload-mediacatalogue.write

Parameters

namequerystringThe name of the uploaded file; the library keeps it as the image name.
Idempotency-KeyheaderstringSee common parameters

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

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

POST/api/v1/catalogue/variants/{sku}/filecatalogue.upload-variant-filecatalogue.write

Parameters

skupathstring
skupathstring
namequerystringThe name the file is saved under when a buyer downloads it.
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/variants/{sku}/file

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

Parameters

namepathstring
namepathstring
source_refquerystringWhere the version came from, in its maker's words.
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}/versions

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

Parameters

namepathstring
namepathstring
Idempotency-KeyheaderstringSee common parameters

Request body

UseVersionRequest

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

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

GET/api/v1/catalogue/images/{name}/versionscatalogue.versionscatalogue.read

Parameters

namepathstring
namepathstring

Answer

array of PictureVersion

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

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

Schemas 20

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
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
CollectionChange

CollectionChange is a collection as an operation left it, and whether the operation changed it.

changedrequiredboolean
collectionrequiredCollection
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
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
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
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
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
MediaImage

MediaImage is an image of the media library. From version 6.

altrequiredstring
bytesrequiredinteger
file_namerequiredstring
heightrequiredinteger
namerequiredstring
productsrequiredarray of MediaProduct
srcrequiredstring
uploaded_atrequiredstring (date-time)
widthrequiredinteger
MediaProduct

MediaProduct is a product that shows an image of the library.

slugrequiredstring
titlerequiredstring
Money

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

currencyrequiredstring
displayrequiredstring
minorrequiredinteger
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
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
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)
UseVersionRequest

UseVersionRequest names the approved version an original is to show (ASI-3.4a); the original's own name for itself.

versionrequiredstring
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
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

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