Before you start to use our MCP, please review the following items:
Ensure you have completed the iPaaS.com platform training before using this to best understand what is going on. If you need to gain access to it reach out to partnerships@ipaas.com.
With great power comes great responsibility - the MCP can do things like trigger a sync for your entire catalog and modify (or remove) data from your account. Ensure you understand what you want it to do before you work with it. iPaaS.com is not responsible for restoring any data or configuration changes made using the MCP.
Measure twice, cut once: When working with this, planning ahead of time (or asking the MCP to plan for you) will greatly benefit your work.
Remember that this is in beta so some features may be added, removed or altered as we continue our development. The latest change log notes can be found here.
If you have any issues or need to report a bug please reach out to us at mcp@ipaas.com.
These are the tools for transactions: orders, invoices and the other transaction types, with their lines, payments, taxes, shipping, tracking, addresses and notes. Connect with https://mcp.ipaas.com/mcp/transaction to get just these (see Choosing Your Tools). You don't normally type tool names. Ask in plain language and the assistant picks the tool.
The tools
Look things up
Tool | What it does | Changes data? |
list_transactions | Searches transactions by number, customer, type, status, connected system and more. You can combine filters, such as a customer and a type. | No |
get_transaction | One transaction, with its lines, payments, taxes, shipping, tracking, addresses and notes. | No |
list_payment_methods and get_payment_method | The catalog of payment methods. | No |
list_shipping_methods and get_shipping_method | The catalog of shipping methods. | No |
get_transaction_record | Reads a transaction or any of its parts by ID. | No |
External IDs
An external ID links an iPaaS.com record to its counterpart in a connected system.
Tool | What it does | Changes data? |
lookup_transaction_external_id | Finds a transaction's ID in a connected system, starting from the iPaaS.com ID. | No |
lookup_transaction_ipaas_id | Finds the iPaaS.com transaction for an ID from a connected system. | No |
find_unmapped_transactions | Lists transactions and methods that don't yet have an external ID in a given system. | No |
set_transaction_external_id | Creates or updates the link between a transaction and an external ID. | Yes (preview first) |
delete_transaction_external_id | Removes that link. | Yes (preview first) |
Create, change and remove
Tool | What it does | Changes data? |
create_transaction_record, update_transaction_record, delete_transaction_record, reactivate_transaction_record | Create, change, remove or restore a transaction or one of its parts: a line, payment, tax, tracking entry, address, note, or a payment or shipping method. You say which. Deleting is a soft delete, and reactivate brings the record back. | Yes (preview first) |
Good to know
Changes are previewed first. A tool that changes data shows exactly what it would send and changes nothing until you confirm. See Safety, Permissions and Limits.
Some parts can't be written yet. At the time of writing, the platform's API doesn't support creating or changing a transaction's lines, addresses, notes, payments or taxes on their own, or deleting and restoring a tracking entry. The tool tells you immediately, and suggests an alternative, rather than failing in a confusing way.
Types and statuses come from the platform's own tables. There are ten transaction types, including Fulfillment. The tool looks the type or status up when you filter by it.
Filters can be combined, with one exception. Customer, type, status and similar filters can be used together. A modified-since date can't be combined with another filter, because the platform would apply the date comparison to the other field too and return the wrong transactions. The tool refuses that combination and says why.
Updates replace the whole record. The tool fetches the current record and merges your change in, and the preview lists any value that would be cleared.
Deleted transactions are left out of searches unless you ask for them.
External IDs are never created without your confirmation.
Permissions
Give your key View on Transaction, Payment Method, Shipping Method, Transaction Tracking and External Id to read. Add Create, Edit or Delete only for the changes you want to make, plus Transaction Custom Field if you work with custom fields. See Getting Started. Ask the assistant to check your permissions if a tool returns a 401.
Questions or bugs: mcp@ipaas.com.