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 gift cards and their activity history: issues, loads and redemptions. Connect with https://mcp.ipaas.com/mcp/giftcard 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_gift_cards | Searches gift cards by number, status, connected system or type. | No |
get_gift_card | One card, with its balance, status and activity history. | No |
get_gift_card_activity | One entry from a card's activity history. | No |
get_gift_card_record | Reads a gift card record 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_gift_card_external_id | Finds a card's ID in a connected system, starting from the iPaaS.com ID. | No |
lookup_gift_card_ipaas_id | Finds the iPaaS.com gift card for an ID from a connected system. | No |
find_unmapped_gift_cards | Lists gift cards that don't yet have an external ID in a given system. | No |
set_gift_card_external_id | Creates or updates the link between a gift card and an external ID. | Yes (preview first) |
delete_gift_card_external_id | Removes that link. | Yes (preview first) |
Create, change and remove
Tool | What it does | Changes data? |
add_gift_card_activity | Adds an entry to a card's activity history, such as an issue or a redemption. You also state the balance the card should have afterwards. | Yes (preview first) |
create_gift_card_record, update_gift_card_record, delete_gift_card_record, reactivate_gift_card_record | Create, change, remove or restore a gift card. Deleting is a soft delete, and reactivate brings the card back. | Yes (preview first) |
Good to know
An activity records why a balance changed. It doesn't change the balance itself. When you add an activity, you also state the balance the card should have afterwards. Redeeming 10 from a 50 card means stating a balance of 40. Without it, the activity would be recorded and the balance left at 50.
The stored balance and the activity history can disagree. The gift card liability report compares them. See Business Reports.
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.
Updates replace the whole record, so the preview lists any value that would be cleared.
External IDs are never created without your confirmation.
Permissions
Give your key View on Gift Card and External Id to read. Add Create, Edit or Delete only for the changes you want to make, plus Gift Card 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.