Ask what you need to find or change. Your assistant chooses from these 104 tools. Available tools depend on your MAX version and permissions. Start with the connection guide.
API keys are read-only. For editing or the “Who changed what” tools, sign in with MAX and approve the relevant access.
Partners and products
| Tool | What it does |
|---|
list_partners | Find customers and suppliers. |
get_partner | Show basic details of a customer or supplier. |
list_items | Find products by name, code or barcode. |
get_item | Show details of a product. |
get_item_content | Read a product's name, descriptions and text in a chosen language. |
list_item_text_codes | List the kinds of extra text available for products. |
list_item_categories | Show product categories and their hierarchy. |
list_item_attributes | List product attributes, such as size or colour. |
get_item_attribute | Show an attribute and its possible values. |
list_item_history | Show which product details have changed. |
Reference lists and companies
| Tool | What it does |
|---|
list_units | List units of measure. |
list_countries | Find countries, optionally limited to EU members. |
list_vat_rates | Find VAT rates for a country and date. |
list_tags | Find your organisation's tags. |
list_legal_entities | Show companies recorded as legal entities. |
Orders and attachments
| Tool | What it does |
|---|
list_sales_orders | Find orders by status, date or search text. |
get_sales_order | Find an order by number and show its status. |
list_sales_order_items | List an order's products and quantities. |
list_sales_order_activity | Show an order's progress and changes. |
list_sales_order_documents | List details of documents attached to an order. |
get_document | Show an attached document's details, without the file. |
Warehouses and stock
Stock tools show quantities, without prices or costs.
| Tool | What it does |
|---|
list_warehouses | List your organisation's warehouses. |
list_stock | Check product quantities in stock. |
list_stock_quants | Show stock at specific warehouse locations. |
list_locations | Find warehouse locations. |
list_stock_changes | Track changes in stock quantities. |
get_available_to_promise | Check how much stock can still be promised to customers. |
list_stock_incoming | Show expected incoming stock for a product. |
list_stock_card_trend | Show stock quantities over time, by day. |
list_stock_turnover | Summarise receipts, issues and stock balances for a period. |
list_expiring_lots | Find batches nearing expiry. |
list_stock_lots | Find batches and serial numbers. |
Warehouse documents and notices
| Tool | What it does |
|---|
list_receipts | Find goods receipts. |
list_issues | Find goods issues. |
list_transfers | Find transfers between warehouses. |
get_stock_document | Show basic details of a receipt, issue or transfer. |
list_stock_document_items | List a warehouse document's products and quantities. |
list_receipt_advices | Find notices of expected incoming deliveries. |
get_receipt_advice | Show basic details of an incoming delivery notice. |
list_transfer_advices | Find notices of planned warehouse transfers. |
get_transfer_advice | Show basic details of a transfer notice. |
Picking, packing and shipments
| Tool | What it does |
|---|
list_fulfilments | Check the progress of orders being prepared for shipping. |
get_fulfilment | Show the products and packages in one fulfilment. |
get_shipment | Check the status of a shipment handed to a courier. |
list_pick_batches | List open picking batches and their progress. |
list_packing_queue | Show orders waiting to be packed. |
list_carrier_profiles | List the courier services in use. |
Invoices
| Tool | What it does |
|---|
list_invoices | Find invoices, advance invoices and credit notes. |
get_invoice | Show an invoice's status, dates and available amounts. |
Images and assets
| Tool | What it does |
|---|
list_assets | Find details of logos, stamps and other images for templates. |
get_asset | Show an image's details, without the file. |
Emails and email templates
Sent email records include status, without recipients, subject or message content.
| Tool | What it does |
|---|
list_email_templates | List available email templates. |
get_email_template | Read a template's content or design. |
get_email_template_fields | Show the data you can use in an email template. |
preview_email_template | Preview an email with sample data. |
list_email_messages | Check emails sent for an order, invoice or shipment. |
get_email_message | Show the status of a sent email. |
Print templates
| Tool | What it does |
|---|
list_print_templates | Find your organisation's print templates. |
get_print_template | Read a print template's content. |
get_builtin_print_template | Read a built-in MAX print template. |
get_print_template_data | Show available data, a sample document and fonts for a template. |
Editing email templates
Sign in with MAX and approve template management. Changes affect future emails, so check the preview before saving.
| Tool | What it does |
|---|
create_email_template | Create an email template. |
copy_email_template | Copy a built-in or custom email template. |
update_email_template | Change a template's name or the kind of document it is used for. |
set_email_template_variant | Add or update a language version of an email. |
remove_email_template_variant | Remove a version of an email; at least one must remain. |
set_email_template_texts | Replace an email template's text translations. |
save_email_template_design | Save an email's design and text translations together. |
convert_email_template_to_html | Create an editable HTML copy of a visual template. |
delete_email_template | Delete a custom email template. |
send_test_email | Send a test email with sample data to your own address. |
Editing print templates
Sign in with MAX and approve template management. Changes to the default template affect future document printing.
| Tool | What it does |
|---|
create_print_template | Create a print template. |
update_print_template | Change a template's content, name, language or default setting. |
set_print_template_archived | Archive or restore a print template. |
copy_print_template | Copy a custom or built-in print template. |
delete_print_template | Delete a print template; deleting the default restores the built-in template. |
Events, errors and connections
| Tool | What it does |
|---|
list_events | Show events and record changes in your organisation. |
list_error_reports | Summarise errors from connected systems for a warehouse document. |
list_external_sources | List registered external systems. |
list_external_refs | Show how a record is identified in connected systems. |
Editing products
Sign in with MAX and approve catalogue management. Stock planning settings do not change actual stock quantities.
| Tool | What it does |
|---|
set_item_content | Update a product's name, descriptions and extra text in one language. |
remove_item_content | Remove a product's language version, falling back to the default language. |
create_item_category | Create a product category. |
update_item_category | Rename a category or move it with its subcategories. |
set_item_category_translation | Add or update a category name's translation. |
create_item_attribute | Create a product attribute, such as size. |
update_item_attribute | Change an attribute's name or how it is displayed. |
add_item_attribute_value | Add an attribute value, such as size XL. |
create_item | Create a stock product with one variant. |
update_item | Update a product's name, category, brand, weight or dimensions. |
add_variant | Add a product variant based on attributes, such as colour and size. |
update_variant | Update a variant's weight and package dimensions. |
add_variant_code | Add a barcode or another identifying code to a variant. |
set_stock_planning_levels | Set minimum and maximum stock levels and replenishment rules. |
Tags, priorities and connections
Sign in with MAX and approve access to tags, priorities and connections. Changing a tag's name or colour affects everywhere it is used.
| Tool | What it does |
|---|
tag_sales_order | Add or remove an order's tags. |
tag_invoice | Add or remove an invoice's tags. |
create_tag | Create a tag. |
update_tag | Change a tag's name or colour. |
set_error_report_status | Mark an error as resolved, snooze it or reopen it. |
set_sales_order_priority | Set or clear an order's warehouse priority. |
link_external_ref | Link a product or variant to a record in another system. |
update_external_ref | Update the display number of a link to another system. |
Who changed what
Sign in with MAX and separately approve access to detailed change history.
| Tool | What it does |
|---|
list_audit_entries | Show who changed what and when. |
get_audit_history | Show the change history of one record. |