Gift Up!

Tool to add a note to an existing order. Use when you need to track additional information about an order. Notes are limited to 500 characters and can be used for internal tracking purposes.

Tool 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.

Tool to create a new item group for organizing items in the Gift Up checkout. Use when you need to create a container for grouping items together.

Tool 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.

Tool to delete an item from the Gift Up checkout. Removes the item from sale. Use when you need to permanently remove an item by its ID.

Tool to delete an item group by its ID. Use when you need to remove an item group that has no items in it.

Tool to delete a webhook subscription by its ID. Use when you need to remove an existing webhook subscription.

Tool to retrieve the current checkout settings. Use when you need to display or audit your checkout configuration.

Tool to retrieve company details. Use when you need to fetch the current company associated with the API key.

Tool to retrieve email settings for the Gift Up account. Use when you need to view the current email configuration including sender details, receipt settings, and notification preferences.

Tool to retrieve a gift card by its code. Use when you need detailed information about a specific gift card including balance, status, and transaction history.

Tool to retrieve gift card settings including code format, expiration rules, and display options. Use when you need to understand how gift cards are configured for the account.

Tool to retrieve detailed information about a specific item by its ID. Use when you need to fetch complete details about an item including price, availability, stock levels, and configuration settings.

Tool to retrieve a specific order by ID. Use when you need detailed information about an order including gift cards, payment details, and customer information.

Tool to perform a health check on the Gift Up! API. Use when you need to verify API connectivity and authentication without fetching account-specific data.

Tool to retrieve a specific transaction report by its ID. Use when you need detailed transaction information for accounting purposes.

Tool to retrieve shipping settings for physical gift cards. Use when you need to display or audit postal delivery configuration.

Tool to retrieve current Stripe integration connection settings. Use when you need to view or audit Stripe payment configuration for the Gift Up account.

Tool to retrieve a specific webhook by its ID. Use when you need to get detailed configuration information for a webhook subscription.

Tool to list all gift card artwork available for use on gift cards. Returns artwork information including URLs and sort order. Use when you need to retrieve available gift card designs.

Tool to list gift cards. Use when you need to retrieve gift cards with optional filters.

Tool to list item groups. Use when you need to retrieve all item groups for filtering items by group.

Lists 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.

Retrieves 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 operations

Tool to list all promotions that allow discounts to be applied on the Gift Up checkout. Use when you need to retrieve all available promotion codes and their details.

Tool to list report transactions with optional filters. Use after setting desired filters to retrieve transactions report.

Tool to list all users. Use when you need to retrieve all users who have access to your Gift Up! account.

Tool to list all webhooks configured for the account. Use when you need to view all webhook subscriptions and their configuration details.

Tool to perform a health check using POST /ping endpoint. Use when you need to test API connectivity and authentication by sending a test payload that will be echoed back.

Tool to reactivate a voided gift card. Use when you need to restore a gift card that has been voided. This operation is only valid for gift cards that have been voided - active or fully redeemed cards cannot be reactivated.

Tool to redeem a specified amount or units from a gift card. Use when processing a purchase or transaction against a gift card balance. The gift card cannot be redeemed if it has been voided or lacks sufficient balance.

Tool to redeem a gift card in full. Use when you need to deduct the entire remaining balance from a gift card in a single operation.

Subscribe 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.

Tool to add value to an existing gift card. Use when you need to increase the balance or units on a gift card. Cannot top up a voided gift card - attempting to do so will result in a 422 error.

Tool 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.

Tool 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.

Tool to update gift card properties using JSON Patch operations. Use when you need to modify gift card details like recipient information, expiry dates, or terms.

Tool 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.

Update 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.

Tool 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.

Tool to update an order's properties using JSON Patch operations. Use when you need to modify purchaser email, purchaser name, or other order details.

Tool to update Stripe integration connection settings for the Gift Up account. Use when configuring or changing Stripe API keys, Connect settings, or payment method availability.

Tool to upload new gift card artwork. Use when you need to add or update artwork images for gift cards.

Tool to void a gift card making it invalid for future redemptions. Use when you need to permanently invalidate a gift card. A voided gift card cannot be voided again.