- Category: ecommerce
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 44
- Triggers: 0
- Slug:
GIFT_UP - Version: 20261101_00
Tools
Add Note to Order
Add Note to Order
GIFT_UP_ADD_ORDER_NOTEAdd a note of up to 500 characters to an existing order for internal tracking. The action then retrieves the order and returns its last note; the note may be added even if that follow-up retrieval fails.Input Parameters
Output
Create Item
Create Item
GIFT_UP_CREATE_ITEMTool to create a new item for sale in the Gift Up checkout. An item represents a product that can be purchased (gift cards, vouchers, passes, etc.). Use when you need to add new products to the Gift Up store, set up gift card offerings with specific prices and values, or configure items with custom pricing, expiry rules, and availability windows.Input Parameters
Output
Create Item Group
Create Item Group
Create Order
Create Order
GIFT_UP_CREATE_ORDERTool to create a new order which generates one or more gift cards. Use when you need to programmatically create gift card orders through the Gift Up API. Orders encapsulate transaction data and contain gift card details including codes, balances, and fulfillment information.Input Parameters
Output
Delete Item
Delete Item
Delete Item Group
Delete Item Group
Delete Webhook
Delete Webhook
Get Checkout Settings
Get Checkout Settings
Get Company Details
Get Company Details
Get Email Settings
Get Email Settings
Get Gift Card by Code
Get Gift Card by Code
Get Gift Card Settings
Get Gift Card Settings
Get Item by ID
Get Item by ID
Get Order by ID
Get Order by ID
API Health Check
API Health Check
Get Report Transaction
Get Report Transaction
Get Shipping Settings
Get Shipping Settings
Get Stripe Connection
Get Stripe Connection
Get Webhook
Get Webhook
List Gift Card Artwork
List Gift Card Artwork
List Gift Cards
List Gift Cards
List Item Groups
List Item Groups
List Items
List Items
GIFT_UP_LIST_ITEMSLists all items (gift cards, passes, etc.) available for sale in the Gift Up account. Items can be optionally filtered by groupId to retrieve only items within a specific group. Use this to discover available items, check item details, pricing, stock levels, and group associations.Input Parameters
Output
List Locations
List Locations
GIFT_UP_LIST_LOCATIONSRetrieves all physical locations where gift cards are sold and/or redeemed. Locations are used exclusively for reporting purposes in Gift Up! to track where gift cards are being distributed and used. This endpoint returns all configured locations for your account, or an empty array if none have been set up. Use this action when you need to: - Get a list of all store/venue locations in your Gift Up! account - Retrieve location IDs for reporting or analytics purposes - Check which physical locations are configured for gift card operationsOutput
List Promotions
List Promotions
List Report Transactions
List Report Transactions
GIFT_UP_LIST_REPORT_TRANSACTIONSTool to list report transactions with optional filters. Use after setting desired filters to retrieve transactions report.Input Parameters
Output
List GiftUp Users
List GiftUp Users
List Webhooks
List Webhooks
Health Check (POST)
Health Check (POST)
Reactivate Gift Card
Reactivate Gift Card
Redeem Gift Card
Redeem Gift Card
GIFT_UP_REDEEM_GIFT_CARDRedeem a specified currency amount or units from a gift card. Voided cards or cards with insufficient balance cannot be redeemed; the response may contain redemption error flags instead of a successful transaction.Input Parameters
Output
Redeem Gift Card In Full
Redeem Gift Card In Full
Subscribe to Webhook
Subscribe to Webhook
GIFT_UP_SUBSCRIBE_WEBHOOKSubscribe to Gift Up! webhook events to receive real-time notifications about orders and gift cards. This tool registers a callback URL that Gift Up! will POST to when specified events occur. Before creating the subscription, Gift Up! validates the target URL by sending a test POST request with body {“test”: true} and expects a 200 OK response. Use cases: - Receive notifications when orders are created - Track gift card lifecycle events (creation, updates, redemption) - Integrate Gift Up! events with external systems - Build custom automation workflows Note: The target URL must be publicly accessible and capable of responding with 200 OK to the validation request, or the subscription will fail with a 400 error.Input Parameters
Output
Top Up Gift Card
Top Up Gift Card
Undo Gift Card Redemption
Undo Gift Card Redemption
GIFT_UP_UNDO_REDEMPTIONTool to undo a previous redemption on a gift card, restoring the redeemed amount to the gift card balance. Use when you need to reverse a redemption transaction and restore the gift card balance.Input Parameters
Output
Update Email Settings
Update Email Settings
GIFT_UP_UPDATE_EMAIL_SETTINGSTool to update email settings using JSON Patch operations. Use when you need to modify receipt email content, footer text, sender details, logo settings, or gift card email preferences. This tool allows granular updates to specific email settings properties without replacing the entire configuration. Common use cases include updating footer text, changing sender information, modifying button colors, and adjusting email content.Input Parameters
Output
Update Gift Card
Update Gift Card
GIFT_UP_UPDATE_GIFT_CARDUpdate a Gift Up gift card by code using JSON Patch operations, for example to change recipient details, expiry dates or terms. After a successful update, the tool retrieves and returns the card.Input Parameters
Output
Update Gift Card Settings
Update Gift Card Settings
GIFT_UP_UPDATE_GIFT_CARD_SETTINGSTool to update gift card settings using JSON Patch operations. Use when you need to modify code format, expiration rules, or display options for gift cards.Input Parameters
Output
Update Item
Update Item
GIFT_UP_UPDATE_ITEMUpdate an item’s properties using JSON Patch operations. Use this to modify item name, price, description, stock levels, availability, and other properties. Supports replace, add, and remove operations for granular field updates.Input Parameters
Output
Update Item Group
Update Item Group
GIFT_UP_UPDATE_ITEM_GROUPTool to update an item group’s properties using JSON Patch operations. Use when you need to modify name, description, autoExpand, or sortOrder fields of an existing item group.Input Parameters
Output
Update Order
Update Order
Update Stripe Connection
Update Stripe Connection
GIFT_UP_UPDATE_STRIPE_CONNECTIONUpdate Gift Up Stripe connection settings, including API keys, Connect settings and payment methods. Live public and secret keys are required; the response includes connection test results.Input Parameters
Output
Upload Gift Card Artwork
Upload Gift Card Artwork