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
POST/api/v1/catalogue/images/{name}/request-versioncatalogue.request-versioncatalogue.write
GET/api/v1/catalogue/review-classescatalogue.review-classescatalogue.read
GET/api/v1/catalogue/reviewcatalogue.review-listcatalogue.read
Parameters
statequery | stringto_review (when left out), needs_information, approved, retired or all (every state but retired). Refused (invalid) while catalogue.review is off. |
qquery | stringA product's title or a variant's code, in part. |
propertyquery | stringships, does_not_ship, made_of_items or no_own_price. |
categoryquery | stringA category's slug: the products in it or in a category under it. |
checkquery | stringA part not done (pictures, description, values, questions) or look_again. |
afterquery | stringThe cursor of the page: the next of the page before; the first page when left out. The products follow it. |
limitquery | integerThe most products in the page: 1 to 100; 50 when left out. |
Answer
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
POST/api/v1/catalogue/images/{name}/reviewcatalogue.review-versioncatalogue.write
GET/api/v1/catalogue/review/{slug}catalogue.review-workspacecatalogue.read
Parameters
slugpath | string |
slugpath | string |
statequery | stringThe list the product was opened from: to_review (when left out), needs_information, approved, retired or all; for its place. |
qquery | stringThe list's words: a title or a code. |
propertyquery | stringThe list's property: ships, does_not_ship, made_of_items or no_own_price. |
categoryquery | stringThe list's category slug. |
checkquery | stringThe list's check: a part not done, look_again, retire or a review class. |
Answer
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
POST/api/v1/catalogue/collectionscatalogue.save-collectioncatalogue.write
POST/api/v1/catalogue/fieldscatalogue.save-fieldcatalogue.write
GET/api/v1/catalogue/searchcatalogue.searchcatalogue.read
POST/api/v1/catalogue/review/{slug}/send-backcatalogue.send-backcatalogue.write
POST/api/v1/catalogue/products/{slug}/categoriescatalogue.set-categoriescatalogue.write
POST/api/v1/catalogue/products/{slug}/choicescatalogue.set-choicescatalogue.write
POST/api/v1/catalogue/collections/{slug}/productscatalogue.set-collection-productscatalogue.write
POST/api/v1/catalogue/collections/{slug}/rulescatalogue.set-collection-rulescatalogue.write
POST/api/v1/catalogue/variants/{sku}/compare-atcatalogue.set-compare-atcatalogue.write
POST/api/v1/catalogue/products/{slug}/detailscatalogue.set-detailscatalogue.write
POST/api/v1/catalogue/products/{slug}/enquirycatalogue.set-enquirycatalogue.write
POST/api/v1/catalogue/images/{name}/altcatalogue.set-image-altcatalogue.write
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.
categoriesrequired | array 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.
descriptionrequired | string |
enquiry_mail_torequired | string |
enquiry_onlyrequired | boolean |
namerequired | string |
parentrequired | string |
positionrequired | integer |
slugrequired | string |
trailrequired | string |
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.
description | string |
enquiry_mail_to | string |
enquiry_only | boolean |
namerequired | string |
old | string |
parent | string |
position | integer |
slug | string |
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 |
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.
choicesrequired | array 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.
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 |
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 |
CollectionProductsRequest
CollectionProductsRequest is the products of a collection, by slug, in the owner's order.
productsrequired | array 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.
description | string |
old | string |
products | array of string |
slug | string |
titlerequired | 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 |
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.
revisionrequired | integer |
rulesrequired | CollectionRules |
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 |
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_atrequired | string |
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.
deletedrequired | string |
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_title | string |
category | string |
country_of_origin | string |
description | string |
featured_position | integer |
hs_code | string |
meta_description | string |
meta_title | string |
ships_free | boolean |
short_description | string |
title | 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 |
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.
moderequired | string |
show_pricerequired | boolean |
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.
choices | array of string |
countrequired | integer |
filterablerequired | boolean |
keyrequired | string |
labelrequired | string |
multiple | boolean |
positionrequired | integer |
saved_at | string (date-time) |
saved_byrequired | string |
scoperequired | string |
shownrequired | string |
typerequired | string |
unit | string |
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.
choices | array of string |
drop_from_collections | boolean |
drops | array of string |
filterablerequired | boolean |
keyrequired | string |
labelrequired | string |
multiple | boolean |
new | boolean |
position | integer |
renames | map of string |
revisionrequired | integer |
scoperequired | string |
shownrequired | string |
typerequired | string |
unit | string |
HeldChange
HeldChange is a change after approval, held for a person (ASI-2.8).
approvedrequired | string |
atrequired | string (date-time) |
byrequired | string |
digestrequired | string |
fieldrequired | string |
idrequired | integer |
newrequired | string |
variantrequired | string |
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.
altrequired | string |
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 |
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 |
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.
checksrequired | array of string |
digestrequired | string |
noterequired | string |
staterequired | string |
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 |
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).
fieldsrequired | array of FieldDefinition |
revisionrequired | integer |
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 |
ProductSearch
ProductSearch is a page of the products a search finds, how many it finds in all, and whether a later page holds more.
morerequired | boolean |
ofrequired | integer |
productsrequired | array of Product |
RetireProposal
RetireProposal is a retire proposed and not decided (ASI-2.12).
atrequired | string (date-time) |
byrequired | string |
digestrequired | string |
noterequired | string |
targetrequired | string |
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_againrequired | boolean |
nextrequired | string |
publishedrequired | boolean |
slugrequired | string |
staterequired | string |
ReviewBy
ReviewBy is who did an act and when.
atrequired | string (date-time) |
byrequired | string |
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.
approvers | array of string |
badgerequired | string |
block_claims | array of string |
keyrequired | string |
labelrequired | string |
ReviewClasses
ReviewClasses are the store's review classes, in its order.
classesrequired | array of ReviewClass |
ReviewCounts
ReviewCounts are the products of each review state (ASI-7.3).
allrequired | integer |
approvedrequired | integer |
needs_informationrequired | integer |
to_reviewrequired | integer |
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.
ReviewEvent
ReviewEvent is a line of the product's review history (ASI-2.11).
atrequired | string (date-time) |
byrequired | string |
kindrequired | string |
wordsrequired | string |
ReviewItem
ReviewItem is an item of a combo.
pricerequired | string |
quantityrequired | integer |
skurequired | string |
titlerequired | string |
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).
classesrequired | array of ReviewClass |
countsrequired | ReviewCounts |
firstrequired | integer |
nextrequired | string |
prevrequired | string |
rowsrequired | array of ReviewRow |
totalrequired | integer |
ReviewNote
ReviewNote is words a person wrote, with who and when.
atrequired | string (date-time) |
byrequired | string |
wordsrequired | string |
ReviewPart
ReviewPart is one part of a product's review (ASI-2.2) and what it lacks. The page writes the words.
donerequired | boolean |
missingrequired | array of string |
partrequired | string |
staterequired | string |
ReviewPicture
ReviewPicture is a picture of the product (ASI-3's states).
digestrequired | string |
mainrequired | boolean |
namerequired | string |
option_valuerequired | string |
sourcerequired | string |
source_refrequired | string |
staterequired | string |
urlrequired | string |
variantrequired | string |
ReviewPlace
ReviewPlace is the product's place in the list it was opened from (ASI-7.4).
inrequired | boolean |
indexrequired | integer |
nextrequired | string |
ofrequired | integer |
prevrequired | string |
ReviewQuestion
ReviewQuestion is an open or resolved question (ASI-2.4).
answerrequired | string |
answeredrequired | ReviewBy |
choicesrequired | array of string |
digestrequired | string |
idrequired | integer |
rightrequired | string |
right_rolesrequired | array of string |
textrequired | string |
ReviewRow
ReviewRow is one product of the review list (ASI-7.2).
categoryrequired | string |
category_namerequired | string |
changed_atrequired | string (date-time) |
classesrequired | array of ReviewClass |
codesrequired | integer |
look_againrequired | boolean |
open_questionsrequired | integer |
optionsrequired | boolean |
partsrequired | array of ReviewPart |
picturerequired | string |
propertiesrequired | array of string |
retire_proposedrequired | boolean |
slugrequired | string |
staterequired | string |
titlerequired | string |
ReviewSetting
ReviewSetting is the store's catalogue.review and what turning it on would move (ASI-2.1, 46h).
onrequired | boolean |
productsrequired | integer |
publishedrequired | integer |
turn_on_secondsrequired | integer |
ReviewStock
ReviewStock says how the stock is managed (ASI-2.11).
externalrequired | boolean |
labelrequired | string |
ReviewVariant
ReviewVariant is a variant the shop sells, with its values (ASI-2.2.3).
height_mmrequired | integer |
itemsrequired | array of ReviewItem |
length_mmrequired | integer |
missingrequired | array of string |
option_valuesrequired | array of string |
pricerequired | string |
sellsrequired | boolean |
skurequired | string |
stockrequired | integer |
weight_gramsrequired | integer |
width_mmrequired | integer |
ReviewWorkspace
ReviewWorkspace is one read of what the review page shows (ASI-2.11).
approvedrequired | ReviewBy |
categoryrequired | string |
category_namerequired | string |
classesrequired | array of ReviewClass |
deliveryrequired | string |
descriptionrequired | ReviewDescription |
digestrequired | string |
heldrequired | array of HeldChange |
historyrequired | array of ReviewEvent |
look_againrequired | boolean |
optionsrequired | boolean |
partsrequired | array of ReviewPart |
photo_askedrequired | ReviewNote |
picturesrequired | array of ReviewPicture |
placerequired | ReviewPlace |
price_fromrequired | string |
price_torequired | string |
propertiesrequired | array of string |
publishedrequired | boolean |
questionsrequired | array of ReviewQuestion |
retirerequired | RetireProposal |
rightsrequired | array of string |
sent_backrequired | ReviewNote |
slugrequired | string |
sourcesrequired | array of string |
staterequired | string |
stockrequired | ReviewStock |
titlerequired | string |
variantsrequired | array of ReviewVariant |
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) |
SendBackRequest
SendBackRequest sends the product back with a note (ASI-2.7).
noterequired | 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 |
VariantChange
VariantChange is a variant as an operation left it, and whether the operation changed it.
changedrequired | boolean |
variantrequired | Variant |
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 |
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).
noterequired | string |
toolrequired | 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.