# Gift Up!

Gift Up! is a digital platform that allows businesses to sell, manage, and redeem gift cards online, integrating seamlessly with websites and apps to streamline gift card transactions and promotions.

- **Category:** ecommerce
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 44
- **Triggers:** 0
- **Slug:** `GIFT_UP`
- **Version:** 20260227_00

## Tools

### Add Note to Order

**Slug:** `GIFT_UP_ADD_ORDER_NOTE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique GUID identifier of the order to add a note to. |
| `content` | string | Yes | The note content to add to the order. Must be no more than 500 characters in length. Use notes to track additional information about an order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item

**Slug:** `GIFT_UP_CREATE_ITEM`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku` | string | No | Private SKU or item code for integration with external inventory/POS systems. Not visible to customers |
| `name` | string | Yes | The name of the item to be displayed to customers |
| `codes` | array | No | Pre-generated codes to be issued when this item is sold. Useful for integrating with third-party redemption systems |
| `price` | string | No | Amount charged to the purchaser. Required for Specified pricing type. For Currency-backed items with Specified pricing, this is the price customers pay |
| `units` | integer | No | Unit balance issued on the gift card. Required for Units-backed items. Represents quantity (e.g., 5 classes, 10 visits) |
| `value` | string | No | Currency balance issued on the gift card. Required for Currency-backed items with Specified pricing. Can differ from price for discounts/premiums |
| `groupId` | string | No | UUID of the item group to associate this item with. Groups help organize related items for management and reporting |
| `priceType` | string ("Specified" | "Custom") | Yes | Price model. 'Specified' for fixed-price items, 'Custom' to allow customers to enter their own price |
| `detailsURL` | string | No | Fully qualified absolute URL linking to more information about the item. Must start with http:// or https:// |
| `stockLevel` | integer | No | Available inventory quantity. When stock reaches zero, item cannot be purchased. Leave unset for unlimited inventory |
| `backingType` | string ("Currency" | "Units") | Yes | Balance backing type. 'Currency' for monetary value (e.g., $50 gift card), 'Units' for quantity-based items (e.g., 5 class passes) |
| `description` | string | No | Detailed description of the item shown to customers during purchase |
| `maximumPrice` | string | No | Maximum price customers can enter for Custom pricing type. Only applicable when priceType is Custom |
| `minimumPrice` | string | No | Minimum price customers can enter for Custom pricing type. Only applicable when priceType is Custom |
| `availableFrom` | string | No | ISO 8601 datetime string when customers can start purchasing this item. If not specified, item is immediately available |
| `perOrderLimit` | integer | No | Maximum quantity customers can purchase in a single order. Leave unset for no per-order limit |
| `availableUntil` | string | No | ISO 8601 datetime string when purchase availability ends. If not specified, item remains available indefinitely |
| `overrideExpiry` | boolean | No | Set to true to use custom expiry settings for this item instead of account defaults. Use with expiresInMonths to specify item-specific expiration |
| `additionalTerms` | string | No | Additional terms and conditions specific to this item, displayed to customers beyond account-level defaults |
| `expiresInMonths` | integer | No | Number of months after purchase before gift cards from this item expire. If not specified, uses account default expiry settings |
| `validFromInDays` | string | No | Number of days after purchase before gift cards become valid/redeemable. Useful for delayed activation (e.g., holiday gifts) |
| `overrideValidFrom` | boolean | No | Set to true to use custom valid-from settings for this item instead of account defaults. Use with validFromInDays to specify when cards become active |
| `equivalentValuePerUnit` | string | No | Value per unit for reporting purposes. Required for Units-backed items. Used to calculate total value for analytics (e.g., $20 per class pass) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item Group

**Slug:** `GIFT_UP_CREATE_ITEM_GROUP`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the item group |
| `sortOrder` | integer | No | The sort order for how the groups appear in the checkout (ascending), default is 0 |
| `autoExpand` | boolean | No | Whether to expand the items by default in this group on the checkout, default is false |
| `description` | string | No | The description of the item group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order

**Slug:** `GIFT_UP_CREATE_ORDER`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tip` | string | No | Optional tip amount (must be positive if provided) |
| `revenue` | string | Yes | Total revenue amount for the order (must be positive) |
| `discount` | string | No | Total discount amount applied to the order |
| `metadata` | object | No | Key-value pairs for storing additional data (maximum 20 keys) |
| `referrer` | string | No | Origin reference for the order (e.g., sales representative name or source) |
| `orderDate` | string | No | When the order was created (UTC, ISO 8601); defaults to current time if not provided |
| `salesTaxes` | array | No | Sales tax information for the order |
| `serviceFee` | string | No | Optional service fee amount (must be positive if provided) |
| `itemDetails` | array | Yes | List of gift card items to create (at least one required) |
| `customFields` | array | No | Custom field data to collect with the order |
| `purchaserName` | string | Yes | Full name of the purchaser |
| `purchaserEmail` | string | Yes | Email address of the purchaser |
| `disableAllEmails` | boolean | No | Set to true to prevent Gift Up from sending any emails for this order; defaults to false |
| `recipientDetails` | object | No | Recipient and fulfillment information. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Item

**Slug:** `GIFT_UP_DELETE_ITEM`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique GUID identifier of the item to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Item Group

**Slug:** `GIFT_UP_DELETE_ITEM_GROUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The GUID of the item group to delete. Will fail if items exist in the group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `GIFT_UP_DELETE_WEBHOOK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique GUID identifier of the webhook subscription to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Checkout Settings

**Slug:** `GIFT_UP_GET_CHECKOUT_SETTINGS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company Details

**Slug:** `GIFT_UP_GET_COMPANY`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Settings

**Slug:** `GIFT_UP_GET_EMAIL_SETTINGS`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Gift Card by Code

**Slug:** `GIFT_UP_GET_GIFT_CARD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The gift card code to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Gift Card Settings

**Slug:** `GIFT_UP_GET_GIFT_CARD_SETTINGS`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Item by ID

**Slug:** `GIFT_UP_GET_ITEM`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier (GUID) of the item to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order by ID

**Slug:** `GIFT_UP_GET_ORDER`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the order to retrieve (GUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### API Health Check

**Slug:** `GIFT_UP_GET_PING`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report Transaction

**Slug:** `GIFT_UP_GET_REPORT_TRANSACTION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id (GUID) of the transaction to retrieve |
| `test_mode` | boolean | No | If true, include header x-giftup-testmode: true to use test mode. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shipping Settings

**Slug:** `GIFT_UP_GET_SHIPPING_SETTINGS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stripe Connection

**Slug:** `GIFT_UP_GET_STRIPE_CONNECTION`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook

**Slug:** `GIFT_UP_GET_WEBHOOK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique GUID identifier of the webhook to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Gift Card Artwork

**Slug:** `GIFT_UP_LIST_GIFT_CARD_ARTWORK`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Gift Cards

**Slug:** `GIFT_UP_LIST_GIFT_CARDS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku` | string | No | Include only gift cards with this private SKU value |
| `limit` | integer | No | Number of gift cards to return; default is 10 |
| `offset` | integer | No | Number of gift cards to skip; default is 0 |
| `status` | string ("active" | "expired" | "redeemed" | "voided") | No | Include only gift cards in this state |
| `orderId` | string | No | Include only gift cards for this order ID (GUID) |
| `purchaserEmail` | string | No | Include only gift cards with this purchaser email address |
| `recipientEmail` | string | No | Include only gift cards with this recipient email address |
| `createdOnOrAfter` | string | No | Include only gift cards created on or after this UTC datetime (ISO 8601) |
| `updatedOnOrAfter` | string | No | Include only gift cards updated on or after this UTC datetime (ISO 8601) |
| `paymentTransactionId` | string | No | Include only gift cards where the payment provider transaction ID matches |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Item Groups

**Slug:** `GIFT_UP_LIST_ITEM_GROUPS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Items

**Slug:** `GIFT_UP_LIST_ITEMS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `groupId` | string | No | Filter to include only items in this group (UUID format). If omitted or invalid, returns all items. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Locations

**Slug:** `GIFT_UP_LIST_LOCATIONS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Promotions

**Slug:** `GIFT_UP_LIST_PROMOTIONS`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Report Transactions

**Slug:** `GIFT_UP_LIST_REPORT_TRANSACTIONS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Filter by gift card code. |
| `limit` | integer | No | Number of transactions to return (default 10, max 100). |
| `users` | array | No | Filter by user email address; can be specified multiple times. |
| `events` | array | No | Filter by event type; can be specified multiple times. One of: OrderPlaced, GiftCardCreated, CreditAdded, Redeemed, Expired, Unexpired, Voided, Reactivated. |
| `offset` | integer | No | Number of transactions to skip (default 0). |
| `locations` | array | No | Filter by location id (GUID); can be specified multiple times. |
| `test_mode` | boolean | No | If true, include header x-giftup-testmode: true to use test mode. |
| `eventOccurredOnOrAfter` | string | No | Include only transactions occurring on or after this UTC datetime. |
| `eventOccurredOnOrBefore` | string | No | Include only transactions occurring on or before this UTC datetime. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List GiftUp Users

**Slug:** `GIFT_UP_LIST_USERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x_giftup_testmode` | boolean | No | If true, call runs against test data where supported |
| `x_giftup_displayname` | string | No | Overrides display name used in API calls |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `GIFT_UP_LIST_WEBHOOKS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Health Check (POST)

**Slug:** `GIFT_UP_POST_PING`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | No | Optional JSON body to send with the ping request. The endpoint echoes it back. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reactivate Gift Card

**Slug:** `GIFT_UP_REACTIVATE_GIFT_CARD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The gift card code to reactivate |
| `reason` | string | No | The reason for reactivating. Will appear in the gift card history log. |
| `metadata` | object | No | A key-value data store of metadata provided to us by you |
| `locationId` | string | No | The location id where this event occurred at (UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Redeem Gift Card

**Slug:** `GIFT_UP_REDEEM_GIFT_CARD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The gift card code to redeem |
| `units` | integer | No | The number of units to redeem from the gift card (for unit-backed cards). Either amount or units must be provided. |
| `amount` | string | No | The currency amount to redeem from the gift card (for currency-backed cards). Either amount or units must be provided. |
| `reason` | string | No | Optional reason for the redemption (e.g., 'Used with Order 7597') |
| `metadata` | object | No | Optional custom metadata object for tracking purposes (e.g., external order IDs) |
| `locationId` | string | No | Optional location identifier (GUID) where the redemption occurred |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Redeem Gift Card In Full

**Slug:** `GIFT_UP_REDEEM_GIFT_CARD_IN_FULL`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The gift card code to redeem |
| `reason` | string | No | The reason for redemption; appears in gift card history |
| `metadata` | object | No | Key-value pairs for custom data storage |
| `locationId` | string | No | Location where the event occurred (GUID) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Subscribe to Webhook

**Slug:** `GIFT_UP_SUBSCRIBE_WEBHOOK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event` | string ("order-created" | "gift-card-created" | "gift-card-updated" | "gift-card-redeemed") | Yes | Type of webhook event to subscribe to. Available events: 'order-created' (triggered when an order is placed), 'gift-card-created' (when a new gift card is created), 'gift-card-updated' (when a gift card is modified), 'gift-card-redeemed' (when a gift card is redeemed). |
| `secret` | string | No | Optional secret key for webhook request signing. When provided, Gift Up! will include an X-Request-Signature-Sha-256 header with each webhook POST, containing a timestamp and HMAC-SHA256 signature for verifying request authenticity. |
| `targetUrl` | string | Yes | The HTTPS URL where Gift Up! will POST webhook event data. Important: Gift Up! validates this URL by sending a test POST request with body {"test": true} and expects a 200 OK response. The URL must be publicly accessible and respond to this validation request before the subscription succeeds. |
| `isTestMode` | boolean | No | Set to true to receive only test webhook events. Use this for development and testing without triggering production webhooks. Defaults to false for production events. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Top Up Gift Card

**Slug:** `GIFT_UP_TOP_UP_GIFT_CARD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The gift card code to top up |
| `units` | integer | No | For unit-based gift cards, the number of units to add. Not applicable for currency-backed cards. |
| `amount` | number | Yes | The monetary amount to add to the gift card balance. Must be greater than 0. |
| `reason` | string | No | Optional reason for topping up this gift card |
| `metadata` | object | No | Optional key-value pairs for custom data associated with this top-up |
| `locationId` | string | No | Optional location identifier where the top-up occurred |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Undo Gift Card Redemption

**Slug:** `GIFT_UP_UNDO_REDEMPTION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The gift card code |
| `reason` | string | No | A text field for providing an optional reason for undoing the redemption. |
| `metadata` | object | No | A key-value object for storing additional custom data. |
| `transactionId` | string | Yes | The transactionId that you'd like to undo the redemption of. This is returned when redeeming, also available in the ledger property for a Gift Card. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Settings

**Slug:** `GIFT_UP_UPDATE_EMAIL_SETTINGS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operations` | array | Yes | Array of JSON Patch operations to apply to email settings. Each operation modifies a specific property of the email configuration. Operations are applied sequentially in the order provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Gift Card

**Slug:** `GIFT_UP_UPDATE_GIFT_CARD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The gift card code to update. This is the unique identifier for the gift card. |
| `operations` | array | Yes | Array of JSON Patch operations to apply to the gift card. Each operation modifies a specific property of the gift card. Operations are applied in order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Gift Card Settings

**Slug:** `GIFT_UP_UPDATE_GIFT_CARD_SETTINGS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operations` | array | Yes | Array of JSON Patch operations to apply to gift card settings. Each operation modifies one property. Multiple operations can be applied in one request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Item

**Slug:** `GIFT_UP_UPDATE_ITEM`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique GUID identifier of the item to update. |
| `operations` | array | Yes | List of JSON Patch operations to apply to the item. Each operation modifies a specific field. Common use cases: replace /name to rename, replace /price to change pricing, replace /stocklevel to update inventory, add /codes/- to append redemption codes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Item Group

**Slug:** `GIFT_UP_UPDATE_ITEM_GROUP`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The GUID identifier of the item group to update |
| `operations` | array | Yes | Array of JSON Patch operations to apply. Each operation modifies a specific property of the item group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order

**Slug:** `GIFT_UP_UPDATE_ORDER`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the order to update (GUID format or order number) |
| `operations` | array | Yes | List of JSON Patch operations to apply to the order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Stripe Connection

**Slug:** `GIFT_UP_UPDATE_STRIPE_CONNECTION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enableEps` | boolean | No | Enable EPS payment method (popular in Austria). |
| `enableFpx` | boolean | No | Enable FPX payment method (popular in Malaysia). |
| `enablePix` | boolean | No | Enable Pix payment method (popular in Brazil). |
| `enableZip` | boolean | No | Enable Zip buy-now-pay-later payment method. |
| `enableBlik` | boolean | No | Enable Blik payment method (popular in Poland). |
| `enableIdeal` | boolean | No | Enable iDEAL payment method (popular in the Netherlands). |
| `enableAffirm` | boolean | No | Enable Affirm buy-now-pay-later payment method (US only). |
| `enableAlipay` | boolean | No | Enable Alipay payment method (popular in China). |
| `enableKlarna` | boolean | No | Enable Klarna buy-now-pay-later payment method. |
| `enablePayNow` | boolean | No | Enable PayNow payment method (popular in Singapore). |
| `enablePayPal` | boolean | No | Enable PayPal payment method. |
| `enableWeChat` | boolean | No | Enable WeChat Pay payment method (popular in China). |
| `reviewAction` | string ("Continue" | "WaitForApproval") | No | Action to take when Stripe flags a payment for review. 'Continue' auto-captures flagged payments; 'WaitForApproval' requires manual review. |
| `enableCashApp` | boolean | No | Enable Cash App Pay payment method (US only). |
| `enableGiropay` | boolean | No | Enable Giropay payment method (popular in Germany). |
| `enableGrabPay` | boolean | No | Enable GrabPay payment method (popular in Southeast Asia). |
| `livePublicKey` | string | Yes | Your Stripe live publishable API key (must start with pk_live_) |
| `liveSecretKey` | string | Yes | Your Stripe live secret API key (must start with sk_live_ or rk_live_) |
| `testPublicKey` | string | No | Your Stripe test publishable API key |
| `testSecretKey` | string | No | Your Stripe test secret API key |
| `enableMobilePay` | boolean | No | Enable MobilePay payment method (popular in Denmark and Finland). |
| `enablePromptPay` | boolean | No | Enable PromptPay payment method (popular in Thailand). |
| `connectAccountId` | string | No | Stripe Connect account ID for receiving payments. Use this for marketplace/platform integrations. |
| `enableBancontact` | boolean | No | Enable Bancontact payment method (popular in Belgium). |
| `enableMultibanco` | boolean | No | Enable Multibanco payment method (popular in Portugal). |
| `enablePrzelewy24` | boolean | No | Enable Przelewy24 payment method (popular in Poland). |
| `askForFullAddress` | boolean | No | When true, collects complete billing address from customers at checkout. |
| `useStripeCheckout` | boolean | No | Enable Stripe's hosted checkout experience instead of inline payment forms. |
| `applicationFeeFixed` | number | No | Platform flat fee amount in account currency. Only applicable with Stripe Connect. |
| `statementDescriptor` | string | No | Text that appears on customer bank statements (max 22 characters) |
| `threeDSecureRequired` | boolean | No | When true, enforces 3D Secure (3DS) authentication for liability shift protection. Recommended for reducing fraud risk on card payments. |
| `createCustomerAccounts` | boolean | No | When true, creates Stripe Customer objects for buyers to improve fraud detection and enable features like saved payment methods. |
| `enableAfterpayClearpay` | boolean | No | Enable Afterpay/Clearpay buy-now-pay-later payment method. |
| `applicationFeePercentage` | number | No | Platform fee as a percentage (e.g., 5 for 5%). Only applicable with Stripe Connect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Gift Card Artwork

**Slug:** `GIFT_UP_UPLOAD_ARTWORK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Url` | string | Yes | URL of the artwork image to upload. The image must be at least 576x384 pixels (recommended 1152x768 or higher for high-resolution displays). Supported formats: PNG, GIF, JPG. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Void Gift Card

**Slug:** `GIFT_UP_VOID_GIFT_CARD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The gift card code to void |
| `reason` | string | No | The reason for voiding. Will appear in the gift card history log. |
| `metadata` | object | No | Key-value data store for your custom metadata |
| `locationId` | string | No | Location where the void event occurred (UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |