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
POST/api/v1/catalogue/products/{slug}/unretirecatalogue.unretirecatalogue.write
POST/api/v1/catalogue/products/{slug}/imagescatalogue.upload-imagecatalogue.write
POST/api/v1/catalogue/mediacatalogue.upload-mediacatalogue.write
POST/api/v1/catalogue/variants/{sku}/filecatalogue.upload-variant-filecatalogue.write
Parameters
skupath | string |
skupath | string |
namequery | stringThe name the file is saved under when a buyer downloads it. |
Idempotency-Keyheader | stringSee common parameters |
Answer
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
namepath | string |
namepath | string |
source_refquery | stringWhere the version came from, in its maker's words. |
Idempotency-Keyheader | stringSee common parameters |
Answer
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
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.
helprequired | string |
keyrequired | string |
kindrequired | string |
labelrequired | string |
linesrequired | integer |
max_lengthrequired | integer |
optionalrequired | boolean |
valuesrequired | array 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.
descriptionrequired | string |
dynamicrequired | boolean |
product_countrequired | integer |
productsrequired | array of string |
publishedrequired | boolean |
revisionrequired | integer |
rules | CollectionRules |
rules_saved_at | string (date-time) |
rules_saved_by | string |
rules_text | string |
slugrequired | string |
titlerequired | string |
CollectionChange
CollectionChange is a collection as an operation left it, and whether the operation changed it.
changedrequired | boolean |
collectionrequired | Collection |
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.
category | string |
days | integer |
field | string |
hi | string |
kindrequired | string |
lo | string |
max | string |
min | string |
option | string |
value | string |
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.
conditionsrequired | array of CollectionCondition |
matchrequired | string |
sortrequired | string |
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.
partsrequired | array of ComboPartRequest |
sumrequired | boolean |
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.
quantityrequired | integer |
skurequired | string |
Dimensions
Dimensions are a variant's size in whole millimetres: all three 0 for none, or each from 1 to 10 000.
height_mmrequired | integer |
length_mmrequired | integer |
width_mmrequired | integer |
ImageUpload
ImageUpload is a product's image: as its upload left it, and as catalogue.images reads it.
altrequired | string |
copy_failure | string |
heightrequired | integer |
namerequired | string |
positionrequired | integer |
processingrequired | boolean |
productrequired | string |
thumbnailrequired | string |
widthrequired | integer |
MediaImage
MediaImage is an image of the media library. From version 6.
altrequired | string |
bytesrequired | integer |
file_namerequired | string |
heightrequired | integer |
namerequired | string |
productsrequired | array of MediaProduct |
srcrequired | string |
uploaded_atrequired | string (date-time) |
widthrequired | integer |
MediaProduct
MediaProduct is a product that shows an image of the library.
slugrequired | string |
titlerequired | string |
Money
Money is an amount: in minor units of its ISO 4217 currency, and as the store displays it.
currencyrequired | string |
displayrequired | string |
minorrequired | integer |
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.
altrequired | string |
digestrequired | string |
heightrequired | integer |
heldrequired | boolean |
hold_reasonrequired | string |
largerequired | string |
made_byrequired | string |
namerequired | string |
noterequired | string |
ofrequired | string |
shownrequired | string |
sourcerequired | string |
source_refrequired | string |
staterequired | string |
thumbnailrequired | string |
uploaded_atrequired | string (date-time) |
widthrequired | integer |
Product
Product is a product of the catalogue, with every variant.
card_titlerequired | string |
categoriesrequired | array of string |
categoryrequired | string |
choicesrequired | array of ChoiceField |
choices_allowedrequired | boolean |
choices_refused | string |
country_of_originrequired | string |
cross_sellsrequired | array of string |
descriptionrequired | string |
enquiry_moderequired | string |
enquiry_onlyrequired | boolean |
enquiry_show_pricerequired | boolean |
featured_positionrequired | integer |
fieldsrequired | map of array of string |
hs_coderequired | string |
meta_descriptionrequired | string |
meta_titlerequired | string |
optionsrequired | array of string |
relatedrequired | array of string |
retired | ProductRetirement |
ships_freerequired | boolean |
short_descriptionrequired | string |
slugrequired | string |
titlerequired | string |
unpublished_at | string (date-time) |
updated | string (date-time) |
upsellsrequired | array of string |
variantsrequired | array of Variant |
ProductChange
ProductChange is a product as an operation left it, and whether the operation changed it.
changedrequired | boolean |
productrequired | Product |
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.
atrequired | string (date-time) |
keep_pagerequired | boolean |
replaced_byrequired | string |
Sale
Sale is a variant's sale price and its window: the price it sells at from Start, inclusive, to End, exclusive.
endrequired | string (date-time) |
pricerequired | Money |
startrequired | string (date-time) |
UseVersionRequest
UseVersionRequest names the approved version an original is to show (ASI-3.4a); the original's own name for itself.
versionrequired | string |
Variant
Variant is a variant of a product.
allow_backorderrequired | boolean |
archived_at | string (date-time) |
combo | Combo |
compare_at | Money |
digitalrequired | boolean |
dimensions | Dimensions |
dispatch_byrequired | string |
fieldsrequired | map of array of string |
filerequired | VariantFile |
imagesrequired | array of string |
low_stock_threshold | integer |
made_to_orderrequired | boolean |
option_valuesrequired | array of string |
pricerequired | Money |
production_daysrequired | integer |
sale | Sale |
ships_alonerequired | boolean |
skurequired | string |
stockrequired | integer |
supplierrequired | string |
tax_classrequired | string |
track_stockrequired | boolean |
weight_gramsrequired | integer |
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.
digestrequired | string |
namerequired | string |
sizerequired | integer |
uploaded_atrequired | string (date-time) |
uploaded_byrequired | string |
Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.