Tool catalogue
The full list of tools the AI can use; this page is generated from Treyza's own tool registry and is never written by hand.
Where to find: The Tool packs list in the Choose permissions step when creating a key Who it's for: Anyone who wants to see exactly what a key can do In short: The full list of tools the AI can use; this page is generated from Treyza's own tool registry and is never written by hand.
What is a tool?
The AI does not look at your store directly; it calls the tools Treyza gives it. Each tool does one job and asks for one permission. When you create a key you pick packs; a pack is a box of related tools.
The AI only sees the tools within your key's scope. The tools of a closed pack do not appear in the list at all — the AI does not even know they exist.
There are 59 tools released today; 27 of them can change data (write tools).
Packs
| Pack | Permission needed | Includes writing | Status |
|---|---|---|---|
Basic meta | — (none) | No | Released — 4 tools |
Catalog (read) catalog.read | PRODUCTS_READ | No | Released — 11 tools |
Orders (read) orders.read | ORDERS_READ | No | Released — 4 tools |
Reports analytics | FINANCE_READ, ORDERS_READ, PRODUCTS_READ | No | Released — 4 tools |
Catalog (write) catalog.write | PRODUCTS_READ, PRODUCTS_WRITE | Yes | Released — 13 tools |
Orders (write) orders.write | ORDERS_READ, ORDERS_WRITE | Yes | Released — 5 tools |
Customers (read) customers | CUSTOMERS_READ | No | Released — 5 tools |
Customers (write) customers.write | CUSTOMERS_READ, CUSTOMERS_WRITE | Yes | Released — 2 tools |
Store settings store.settings | SETTINGS_READ, SETTINGS_WRITE | Yes | Released — 2 tools |
Gallery (read) media | PRODUCTS_READ | No | Released — 3 tools |
Gallery (write) media.write | PRODUCTS_READ, PRODUCTS_WRITE | Yes | Released — 6 tools |
Marketing marketing | MARKETING_WRITE | Yes | Not released yet |
Content content | CONTENT_WRITE | Yes | Not released yet |
Theme editor theme | THEME_WRITE | Yes | Not released yet |
What the permission codes mean: Security and permissions
To be able to pick a pack, you must hold that permission. Packs that include writing can only be picked on keys in Read and write mode.
The tools
Basic meta
Store identity, capability list and help-centre search. Open on every key and cannot be turned off.
| Tool | What it does | Permission needed | Read only |
|---|---|---|---|
whoami | Returns the store this key is bound to, its plan, the key's mode, its scopes and the tool packs that are open. | — (none) | Yes |
capabilities | The list of tool packs: which of them are open to this key, why the others are closed, and how many tools each pack holds. | — (none) | Yes |
store_get | The store's name, slug, domains, currency, language, time zone and status. | — (none) | Yes |
help_search | Searches the Treyza help centre and returns titles, links and short excerpts. | — (none) | Yes |
Catalog (read) catalog.read
Reading products, variants, stock, categories, brands, tags and price lists.
| Tool | What it does | Permission needed | Read only |
|---|---|---|---|
products_list | Lists the store's products, filtered and paged: stock, price, status, category, brand, tag and text search. | PRODUCTS_READ | Yes |
products_get | Returns a single product's summary: name, status, type, price, total stock, category count and variant count. | PRODUCTS_READ | Yes |
products_search | Searches products by name, SKU or barcode and returns at most 5 best matches; it is the cheapest way to find an id. | PRODUCTS_READ | Yes |
variants_list | Lists a product's variants (option combinations such as size and colour) with their prices and stock. | PRODUCTS_READ | Yes |
stock_get | Returns a product's stock broken down by warehouse and variant; the low-stock threshold is in the answer too. | PRODUCTS_READ | Yes |
stock_movements_list | Returns the stock movements in a date range: by default it aggregates them per product and gives the net change, total in and total out; on request it lists the movements one by one. | PRODUCTS_READ | Yes |
products_seo_get | Returns a product's search-engine fields: search title and description, share title and description, canonical address, keywords and whether the page is open to indexing. | PRODUCTS_READ | Yes |
categories_list | Lists the store's category tree with paging; every row shows its parent category as parentId. | PRODUCTS_READ | Yes |
brands_list | Lists the store's brands with paging. | PRODUCTS_READ | Yes |
tags_list | Lists product tags with paging. | PRODUCTS_READ | Yes |
price_lists_get | Returns the store's price lists: currency, status, priority, validity range and how many items each one holds. | PRODUCTS_READ | Yes |
Orders (read) orders.read
Reading orders, shipments and return requests.
| Tool | What it does | Permission needed | Read only |
|---|---|---|---|
orders_list | Lists the store's orders, filtered and paged: status, payment status, date range, amount range, sales channel, source and customer search. | ORDERS_READ | Yes |
orders_get | Returns a single order's summary: status, amount, item count, delivery city and, on request, items, address, payment and status history. | ORDERS_READ | Yes |
shipments_list | Lists the store's shipments, filtered and paged: carrier, tracking number, shipment status, parcel count, volumetric weight and movement history. | ORDERS_READ | Yes |
returns_list | Lists the return and exchange requests raised against the store, filtered and paged: status, type, customer, date range. | ORDERS_READ | Yes |
Reports analytics
Sales summary, best sellers, traffic breakdown and the list of scheduled reports.
| Tool | What it does | Permission needed | Read only |
|---|---|---|---|
sales_summary | Returns the sales and traffic summary for the chosen period: revenue, order count, average basket, conversion rate, visitors and sessions. | FINANCE_READ | Yes |
top_products | Ranks the products that sold most, earned most or were viewed most in the chosen period. | FINANCE_READ, PRODUCTS_READ | Yes |
traffic_summary | Returns where traffic came from in the chosen period and how many sessions, how many orders and how much revenue each source brought. | FINANCE_READ | Yes |
reports_list | Lists the scheduled reports defined in the store: name, which dataset it extracts, how often it runs, whether it is on and when it last ran. | FINANCE_READ | Yes |
Catalog (write) catalog.write
Creating products (not published), updating product details, stock and prices; creating and updating categories, brands and tags; bulk-assigning categories and tags to products. Creations and bulk operations run with a preview first. Deleting and publishing never enter this pack.
| Tool | What it does | Permission needed | Read only |
|---|---|---|---|
products_create | Creates a new simple (non-variant) product in the store: name, categories, descriptions, stock code, price, brand and tags. | PRODUCTS_READ, PRODUCTS_WRITE | No |
products_update | Changes a single product's name, short and long description, stock code, brand and tags; fields you leave out are untouched. | PRODUCTS_READ, PRODUCTS_WRITE | No |
products_seo_update | Changes a single product's search-engine fields: search title, search description, share title and description, canonical address and keywords. | PRODUCTS_READ, PRODUCTS_WRITE | No |
stock_update | SETS the stock of one product or variant in one warehouse to the given value; it does not add to it, it replaces the current value. | PRODUCTS_READ, PRODUCTS_WRITE | No |
price_update | Changes the sale, list and cost price of a single product or variant. | PRODUCTS_READ, PRODUCTS_WRITE | No |
products_bulk_update | Changes the sale price of the products picked by a filter in one go: a percentage rise/discount or a fixed price. | PRODUCTS_READ, PRODUCTS_WRITE | No |
products_bulk_assign | Attaches categories or product tags to the products you pick in one go; it also works for a single product (a single id in productIds). | PRODUCTS_READ, PRODUCTS_WRITE | No |
categories_create | Adds a new category to the store. | PRODUCTS_READ, PRODUCTS_WRITE | No |
categories_update | Changes a category's name, parent, descriptions and storefront visibility; fields you leave out are untouched. | PRODUCTS_READ, PRODUCTS_WRITE | No |
brands_create | Adds a new brand to the store. | PRODUCTS_READ, PRODUCTS_WRITE | No |
brands_update | Changes a brand's name, description and storefront visibility; fields you leave out are untouched. | PRODUCTS_READ, PRODUCTS_WRITE | No |
tags_create | Adds a new product tag to the store. | PRODUCTS_READ, PRODUCTS_WRITE | No |
tags_update | Changes a product tag's name and storefront visibility; fields you leave out are untouched. | PRODUCTS_READ, PRODUCTS_WRITE | No |
products_create, products_bulk_update, products_bulk_assign, categories_create, brands_create, tags_create runs a preview first: it returns how many records would be affected and the before/after of sample rows, changing nothing. To apply, the AI must hand back the single-use token it received from the preview; the token lives 5 minutes and is void if any argument changes.
Orders (write) orders.write
Moving an order's status forward, order notes and entering shipment details. Cancelling an order, refunds and payment operations never enter this pack.
| Tool | What it does | Permission needed | Read only |
|---|---|---|---|
orders_status_update | Moves a single order's status forward: CONFIRMED → PREPARING → SHIPPED → DELIVERED. | ORDERS_READ, ORDERS_WRITE | No |
orders_note_update | Replaces an order's note. | ORDERS_READ, ORDERS_WRITE | No |
orders_note_add | Adds an INTERNAL NOTE to an order that the store team will see. | ORDERS_READ, ORDERS_WRITE | No |
orders_shipment_create | Adds a shipment to an order: carrier, tracking number and optional parcel/weight details. | ORDERS_READ, ORDERS_WRITE | No |
orders_shipment_status_update | Moves an existing shipment's tracking status forward: LABEL_CREATED, IN_TRANSIT, UNDELIVERED, DELIVERED. | ORDERS_READ, ORDERS_WRITE | No |
orders_note_update runs a preview first: it returns how many records would be affected and the before/after of sample rows, changing nothing. To apply, the AI must hand back the single-use token it received from the preview; the token lives 5 minutes and is void if any argument changes.
Customers (read) customers
Reading customer, tag and group records. E-mail, phone and address never appear in list answers; contact details come back only when a single customer is asked about and explicitly requested, and are masked by default.
| Tool | What it does | Permission needed | Read only |
|---|---|---|---|
customers_list | Lists the store's registered customers with paging: name, sign-up date and tags. | CUSTOMERS_READ | Yes |
customers_get | Returns a single customer's summary: name, sign-up date, tags, marketing-consent state and login method. | CUSTOMERS_READ | Yes |
customers_tags_list | Lists the customer tags defined in the store: each tag's id, name and how many customers carry it. | CUSTOMERS_READ | Yes |
customers_groups_list | Lists the store's customer groups (segments): name, kind, member count and whether the group is active. | CUSTOMERS_READ | Yes |
customers_group_members | Lists the members of one customer group with paging and returns each member's order count and total spend. | CUSTOMERS_READ | Yes |
Customers (write) customers.write
Attaching and detaching customer tags, adding members to and removing them from a hand-managed customer group. Creating or deleting a customer, changing contact details or marketing consent, writing customer notes, creating a group and bulk export never enter this pack.
| Tool | What it does | Permission needed | Read only |
|---|---|---|---|
customers_tag_update | Attaches tags to, or detaches tags from, a single customer. | CUSTOMERS_READ, CUSTOMERS_WRITE | No |
customers_group_members_update | Adds customers to, and removes customers from, a MANUAL customer group. | CUSTOMERS_READ, CUSTOMERS_WRITE | No |
customers_group_members_update runs a preview first: it returns how many records would be affected and the before/after of sample rows, changing nothing. To apply, the AI must hand back the single-use token it received from the preview; the token lives 5 minutes and is void if any argument changes.
Store settings store.settings
General, tax, checkout, notification, SEO, regional, product-display and site-structure settings. Carrier credentials and provider secrets never enter this pack.
| Tool | What it does | Permission needed | Read only |
|---|---|---|---|
settings_read | Reads the store's settings section by section; without a section it only lists the section names and what each one covers, it does not dump every setting at once. | SETTINGS_READ | Yes |
settings_update | Changes the fields you name inside one settings section; fields you leave out are untouched. | SETTINGS_READ, SETTINGS_WRITE | No |
settings_update runs a preview first: it returns how many records would be affected and the before/after of sample rows, changing nothing. To apply, the AI must hand back the single-use token it received from the preview; the token lives 5 minutes and is void if any argument changes.
Gallery (read) media
Reading the media library: files, the folder tree, storage usage and which product, category, brand or theme component a given image is used by.
| Tool | What it does | Permission needed | Read only |
|---|---|---|---|
media_list | Lists the files in the store's media library: images, videos and other files. | PRODUCTS_READ | Yes |
media_get | Returns everything about a single gallery file and WHERE IT IS USED. | PRODUCTS_READ | Yes |
media_folders_list | Returns the media library's folder tree and the store's storage usage. | PRODUCTS_READ | Yes |
Gallery (write) media.write
Adding an image from a URL, renaming and moving files, creating, renaming and moving folders, deleting files and folders. Deletion and folder deletion cannot be applied without a preview and CANNOT BE UNDONE. Uploading files, image processing and taking store backups never enter this pack.
| Tool | What it does | Permission needed | Read only |
|---|---|---|---|
media_import_url | The server downloads the image at the given address, optimizes it, puts it in the store's storage and adds it to the gallery as a new file. | PRODUCTS_READ, PRODUCTS_WRITE | No |
media_update | Renames a gallery file and/or moves it into another folder. | PRODUCTS_READ, PRODUCTS_WRITE | No |
media_delete | Deletes one or more files from the media library. | PRODUCTS_READ, PRODUCTS_WRITE | No |
media_folder_create | Creates a new folder in the media library. | PRODUCTS_READ, PRODUCTS_WRITE | No |
media_folder_update | Renames a folder and/or moves it under another folder. | PRODUCTS_READ, PRODUCTS_WRITE | No |
media_folder_delete | Deletes a folder record. | PRODUCTS_READ, PRODUCTS_WRITE | No |
media_delete, media_folder_delete CANNOT BE UNDONE. No endpoint on the platform restores a gallery: a gallery backup only produces a downloadable ZIP archive, it does not put files back, and the download link expires. A product, category, brand or theme component that used a deleted file is left without an image; the files inside a deleted folder fall back to the root folder and its subfolders are lifted to the root level.
media_delete, media_folder_delete runs a preview first: it returns how many records would be affected and the before/after of sample rows, changing nothing. To apply, the AI must hand back the single-use token it received from the preview; the token lives 5 minutes and is void if any argument changes.
Marketing marketing
Discount codes, campaigns and e-mail flows.
This pack is not released yet and cannot be selected when you create a key. Its tools will be listed here once it is ready.
Content content
Blog, legal pages, FAQs, redirects and SEO.
This pack is not released yet and cannot be selected when you create a key. Its tools will be listed here once it is ready.
Theme editor theme
The theme and template surface.
This pack is not released yet and cannot be selected when you create a key. Its tools will be listed here once it is ready.
Where do the numbers come from?
The report tools are not all fed from the same place, and that is the most common reason two tools answer the same question with different numbers. The list below is generated from the tool registry, so it is always current.
| Tool | Where the number is read from | What that means |
|---|---|---|
sales_summary | Order records | Order count, revenue and average basket are read from the order table — the same authoritative source as the order list. Reliable for accounting and reconciliation. The same tool's visitor and session counts come from events. |
top_products | Visit events | The breakdown is built from events collected on store visits; an order whose event was not collected does not appear here, and the breakdown totals may not add up to the sales summary total. |
traffic_summary | Visit events | The breakdown is built from events collected on store visits; an order whose event was not collected does not appear here, and the breakdown totals may not add up to the sales summary total. |
Revenue is not money collected. The revenue in the sales summary is the order amount: it enters the total the moment the order is placed, even if payment has not been taken yet. The Net Revenue card on the panel's dashboard is collection-based and can therefore come out lower. Both are correct; the gap is created by the definition, not by a fault.
If you need a product's exact units sold or an exact revenue figure, use the order list: "List the last 30 days' orders and work out the total amount."
Worth knowing
- Tools answer briefly. Every tool keeps its answer small and splits the result when it has to; the AI asks for "the rest" to get the remainder. A short first answer on a long list is normal.
- Personal data is masked. In the order tools, name, phone, e-mail and street address come back starred out. Lifting the mask requires the
CUSTOMERS_READpermission and is written to the audit log. - Which number comes from where is written above. Some report tools are fed from order records and some from visit events; that is why two tools can answer the same question differently. With examples: Example scenarios
- This page updates itself. Whenever a tool is added or renamed the page is regenerated, so the list you see here is always the list that is live.
Was this page helpful?