gradeNot graded
page: Every page
search_productsAnswer
Search this shop's products by keyword, category and the shop's own filters (price, brand, sizes, colors...). Answers the products with their price as the visitor sees it, stock, image and page address, and the address of the listing showing the same result.
View tool JSON
{
"name": "search_products",
"kind": "answer",
"impl": "imperative",
"description": "Search this shop's products by keyword, category and the shop's own filters (price, brand, sizes, colors...). Answers the products with their price as the visitor sees it, stock, image and page address, and the address of the listing showing the same result.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Words to look for in the product names, descriptions and codes."
},
"category_id": {
"type": "integer",
"description": "Search this category and its sub-categories. Default: the whole catalog."
},
"filters": {
"type": "object",
"description": "Filter values by filter namekey, as list_filters gives them: a value, a list of values, or {\"min\": n, \"max\": n} for a range.",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
},
{
"type": "object",
"properties": {
"min": {
"type": "number"
},
"max": {
"type": "number"
}
}
}
]
}
},
"sort": {
"type": "string",
"enum": [
"relevance",
"name",
"price_asc",
"price_desc",
"newest",
"bestsellers",
"popular"
],
"description": "Order of the results. Default: the shop's own order, by relevance with a query."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page of results, from 1."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"description": "Products per page, 20 by default."
}
},
"additionalProperties": false
},
"page": "/"
}list_categoriesAnswer
List the sub-categories of a category of this shop, with their product count and address. Without parent_id, the top categories.
View tool JSON
{
"name": "list_categories",
"kind": "answer",
"impl": "imperative",
"description": "List the sub-categories of a category of this shop, with their product count and address. Without parent_id, the top categories.",
"inputSchema": {
"type": "object",
"properties": {
"parent_id": {
"type": "integer",
"description": "The category whose sub-categories to list."
}
},
"additionalProperties": false
},
"page": "/"
}list_filtersAnswer
List the filters the shop offers on a category listing (price ranges, brands, characteristics, custom fields, sort orders), with the values each accepts, to use in search_products.
View tool JSON
{
"name": "list_filters",
"kind": "answer",
"impl": "imperative",
"description": "List the filters the shop offers on a category listing (price ranges, brands, characteristics, custom fields, sort orders), with the values each accepts, to use in search_products.",
"inputSchema": {
"type": "object",
"properties": {
"category_id": {
"type": "integer",
"description": "The category of the listing. Default: the whole catalog."
}
},
"additionalProperties": false
},
"page": "/"
}get_productAnswer
Read a product of this shop: description, price, stock, characteristics and the variant of each combination with its own price and stock, options, the fields to fill in when adding it to the cart (dates, travellers, texts) with their format, and the quantities allowed per order.
View tool JSON
{
"name": "get_product",
"kind": "answer",
"impl": "imperative",
"description": "Read a product of this shop: description, price, stock, characteristics and the variant of each combination with its own price and stock, options, the fields to fill in when adding it to the cart (dates, travellers, texts) with their format, and the quantities allowed per order.",
"inputSchema": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"description": "The product id, as search_products gives it."
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"page": "/"
}show_productsAction
Open, in the visitor's browser, the listing of a category with filter values, so the visitor sees the products. A keyword is only shown through a text filter of the shop.
View tool JSON
{
"name": "show_products",
"kind": "act",
"impl": "imperative",
"description": "Open, in the visitor's browser, the listing of a category with filter values, so the visitor sees the products. A keyword is only shown through a text filter of the shop.",
"inputSchema": {
"type": "object",
"properties": {
"category_id": {
"type": "integer",
"description": "Search this category and its sub-categories. Default: the whole catalog."
},
"filters": {
"type": "object",
"description": "Filter values by filter namekey, as list_filters gives them: a value, a list of values, or {\"min\": n, \"max\": n} for a range.",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
},
{
"type": "object",
"properties": {
"min": {
"type": "number"
},
"max": {
"type": "number"
}
}
}
]
}
}
},
"additionalProperties": false
},
"page": "/"
}add_to_cartAction
Add a product to the visitor's cart in this shop, the one its cart module shows, as its add to cart button does: stock, quantity limits and prices apply. A product with variants needs the id of the variant, from get_product. Answers the cart. Registration, login and the checkout are done by the visitor: hand over at checkout_url.
View tool JSON
{
"name": "add_to_cart",
"kind": "act",
"impl": "imperative",
"description": "Add a product to the visitor's cart in this shop, the one its cart module shows, as its add to cart button does: stock, quantity limits and prices apply. A product with variants needs the id of the variant, from get_product. Answers the cart. Registration, login and the checkout are done by the visitor: hand over at checkout_url.",
"inputSchema": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"description": "The product, or for a product with variants the variant, to add."
},
"quantity": {
"type": "integer",
"minimum": 1,
"description": "How many, 1 by default."
},
"fields": {
"type": "object",
"description": "Values of the fields the product asks for (dates of a booking, travellers, a text...), by namekey, as get_product lists them with their format.",
"additionalProperties": true
},
"options": {
"type": "array",
"description": "Options of the product to add with it, from get_product.",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "integer"
},
"quantity": {
"type": "integer",
"minimum": 1
}
},
"required": [
"product_id"
]
}
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"page": "/"
}get_cartAnswer
Read the visitor's cart in this shop: its lines with their line_id, the coupon, the total, and the addresses of the cart page and of the checkout. Registration, login and the checkout are done by the visitor: hand over at checkout_url.
View tool JSON
{
"name": "get_cart",
"kind": "answer",
"impl": "imperative",
"description": "Read the visitor's cart in this shop: its lines with their line_id, the coupon, the total, and the addresses of the cart page and of the checkout. Registration, login and the checkout are done by the visitor: hand over at checkout_url.",
"inputSchema": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"page": "/"
}update_cart_itemAction
Change the quantity of a line of the visitor's cart, by its line_id from get_cart; 0 removes the line. Answers the cart.
View tool JSON
{
"name": "update_cart_item",
"kind": "act",
"impl": "imperative",
"description": "Change the quantity of a line of the visitor's cart, by its line_id from get_cart; 0 removes the line. Answers the cart.",
"inputSchema": {
"type": "object",
"properties": {
"line_id": {
"type": "integer",
"description": "The line, as get_cart gives it."
},
"quantity": {
"type": "integer",
"minimum": 0,
"description": "The new quantity, 0 to remove the line."
}
},
"required": [
"line_id",
"quantity"
],
"additionalProperties": false
},
"page": "/"
}page: Shop
filter_productsAction
Filtrer les produits de cette liste de la boutique selon les filtres de la boutique (prix, marque, caractéristiques...) et afficher le résultat au visiteur.
View tool JSON
{
"name": "filter_products",
"kind": "act",
"impl": "declarative",
"description": "Filtrer les produits de cette liste de la boutique selon les filtres de la boutique (prix, marque, caractéristiques...) et afficher le résultat au visiteur.",
"inputSchema": {
"type": "object",
"properties": {
"filter_Poids_2": {
"type": "string"
},
"filter_Poids_2_values": {
"type": "string"
},
"filter_Prix_3": {
"type": "string"
},
"filter_Prix_3_values": {
"type": "string"
},
"filter_Selectionviande_4": {
"type": "boolean"
},
"filter_Typedeviande_1": {
"type": "string"
},
"filter_Typedeviande_1[]": {
"type": "boolean"
},
"filter_Recherche_8": {
"type": "string"
},
"return_url": {
"type": "string"
},
"filtered": {
"type": "string"
},
"reseted": {
"type": "string"
}
}
},
"page": "/index.php/shop"
}