# Gift Up! — how to use (mcp.ai)

Connect your Gift Up! account and use 44 tools for ecommerce straight from your AI agent. Connect with your own API key. 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.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_gift_up?ms=1787293380000`
Add it as a custom/remote MCP connector in your client (Claude, Cursor, VS Code…), then authenticate when prompted. Once connected, ask the agent to use the server's tools (e.g. `gift_up_add_order_note`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/gift_up`
Auth: `Authorization: Bearer sk_live_…` — create a workspace API key at https://mcp.ai/settings/api-keys
Discover endpoints: `GET https://api.mcp.ai/api/gift_up/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/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.
  - body: { id: string, content: string }
- `POST https://api.mcp.ai/api/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 U
  - body: { sku?: string, name: string, codes?: string[], price?: number|string, units?: integer, value?: number|string, groupId?: string, priceType: string, detailsURL?: string, stockLevel?: integer, backingType: string, description?: string, maximumPrice?: number|string, minimumPrice?: number|string, availableFrom?: string, perOrderLimit?: integer, availableUntil?: string, overrideExpiry?: boolean, additionalTerms?: string, expiresInMonths?: integer, validFromInDays?: number|string, overrideValidFrom?: boolean, equivalentValuePerUnit?: number|string }
- `POST https://api.mcp.ai/api/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.
  - body: { name: string, sortOrder?: integer, autoExpand?: boolean, description?: string }
- `POST https://api.mcp.ai/api/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 contai
  - body: { tip?: number|string, revenue: number|string, discount?: number|string, metadata?: object, referrer?: string, orderDate?: string, salesTaxes?: object[], serviceFee?: number|string, itemDetails: object[], customFields?: object[], purchaserName: string, purchaserEmail: string, disableAllEmails?: boolean, recipientDetails?: object }
- `POST https://api.mcp.ai/api/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.
  - body: { id: string }
- `POST https://api.mcp.ai/api/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.
  - body: { id: string }
- `POST https://api.mcp.ai/api/gift_up/delete/webhook` — Tool to delete a webhook subscription by its ID. Use when you need to remove an existing webhook subscription.
  - body: { id: string }
- `POST https://api.mcp.ai/api/gift_up/get/checkout/settings` — Tool to retrieve the current checkout settings. Use when you need to display or audit your checkout configuration.
- `POST https://api.mcp.ai/api/gift_up/get/company` — Tool to retrieve company details. Use when you need to fetch the current company associated with the API key.
- `POST https://api.mcp.ai/api/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.
- `POST https://api.mcp.ai/api/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.
  - body: { code: string }
- `POST https://api.mcp.ai/api/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.
- `POST https://api.mcp.ai/api/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
  - body: { id: string }
- `POST https://api.mcp.ai/api/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.
  - body: { id: string }
- `POST https://api.mcp.ai/api/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.
- `POST https://api.mcp.ai/api/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.
  - body: { id: string, test_mode?: boolean }
- `POST https://api.mcp.ai/api/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.
- `POST https://api.mcp.ai/api/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.
- `POST https://api.mcp.ai/api/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.
  - body: { id: string }
- `POST https://api.mcp.ai/api/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.
- `POST https://api.mcp.ai/api/gift_up/list/gift/cards` — Tool to list gift cards. Use when you need to retrieve gift cards with optional filters.
  - body: { sku?: string, limit?: integer, offset?: integer, status?: string, orderId?: string, purchaserEmail?: string, recipientEmail?: string, createdOnOrAfter?: string, updatedOnOrAfter?: string, paymentTransactionId?: string }
- `POST https://api.mcp.ai/api/gift_up/list/item/groups` — Tool to list item groups. Use when you need to retrieve all item groups for filtering items by group.
- `POST https://api.mcp.ai/api/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 a
  - body: { groupId?: string }
- `POST https://api.mcp.ai/api/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. 
- `POST https://api.mcp.ai/api/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.
- `POST https://api.mcp.ai/api/gift_up/list/report/transactions` — Tool to list report transactions with optional filters. Use after setting desired filters to retrieve transactions report.
  - body: { code?: string, limit?: integer, users?: string[], events?: string[], offset?: integer, locations?: string[], test_mode?: boolean, eventOccurredOnOrAfter?: string, eventOccurredOnOrBefore?: string }
- `POST https://api.mcp.ai/api/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.
  - body: { x_giftup_testmode?: boolean, x_giftup_displayname?: string }
- `POST https://api.mcp.ai/api/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.
- `POST https://api.mcp.ai/api/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.
  - body: { body?: object }
- `POST https://api.mcp.ai/api/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
  - body: { code: string, reason?: string, metadata?: object, locationId?: string }
- `POST https://api.mcp.ai/api/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 
  - body: { code: string, units?: integer, amount?: number|string, reason?: string, metadata?: object, locationId?: string }
- `POST https://api.mcp.ai/api/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.
  - body: { code: string, reason?: string, metadata?: object, locationId?: string }
- `POST https://api.mcp.ai/api/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 c
  - body: { event: string, secret?: string, targetUrl: string, isTestMode?: boolean }
- `POST https://api.mcp.ai/api/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.
  - body: { code: string, units?: integer, amount: number, reason?: string, metadata?: object, locationId?: string }
- `POST https://api.mcp.ai/api/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.
  - body: { code: string, reason?: string, metadata?: object, transactionId: string }
- `POST https://api.mcp.ai/api/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 allo
  - body: { operations: object[] }
- `POST https://api.mcp.ai/api/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.
  - body: { code: string, operations: object[] }
- `POST https://api.mcp.ai/api/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.
  - body: { operations: object[] }
- `POST https://api.mcp.ai/api/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 operation
  - body: { id: string, operations: object[] }
- `POST https://api.mcp.ai/api/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.
  - body: { id: string, operations: object[] }
- `POST https://api.mcp.ai/api/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.
  - body: { id: string, operations: object[] }
- `POST https://api.mcp.ai/api/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.
  - body: { enableEps?: boolean, enableFpx?: boolean, enablePix?: boolean, enableZip?: boolean, enableBlik?: boolean, enableIdeal?: boolean, enableAffirm?: boolean, enableAlipay?: boolean, enableKlarna?: boolean, enablePayNow?: boolean, enablePayPal?: boolean, enableWeChat?: boolean, reviewAction?: string, enableCashApp?: boolean, enableGiropay?: boolean, enableGrabPay?: boolean, livePublicKey: string, liveSecretKey: string, testPublicKey?: string, testSecretKey?: string, enableMobilePay?: boolean, enablePromptPay?: boolean, connectAccountId?: string, enableBancontact?: boolean, enableMultibanco?: boolean, enablePrzelewy24?: boolean, askForFullAddress?: boolean, useStripeCheckout?: boolean, applicationFeeFixed?: number, statementDescriptor?: string, threeDSecureRequired?: boolean, createCustomerAccounts?: boolean, enableAfterpayClearpay?: boolean, applicationFeePercentage?: number }
- `POST https://api.mcp.ai/api/gift_up/upload/artwork` — Tool to upload new gift card artwork. Use when you need to add or update artwork images for gift cards.
  - body: { Url: string }
- `POST https://api.mcp.ai/api/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.
  - body: { code: string, reason?: string, metadata?: object, locationId?: string }

## Example prompts
- "What can I do in Gift Up!?"
- "Show me a summary of my Gift Up! account"

## More
- Page: https://mcp.ai/gift_up
- Agent spec (llms.txt): https://mcp.ai/gift_up/llms.txt
- Postman collection: https://mcp.ai/gift_up/postman.json