list_item_groups
List Item Groups
List all item groups configured in the account. Item groups organize items in the checkout.
list_item_groups
List all item groups configured in the account. Item groups organize items in the checkout.
top_up_gift_card
Add credit or units to an existing gift card's balance.
reactivate_gift_card
Reactivate a previously voided gift card, restoring it to an active state so it can be redeemed again.
list_transactions
Retrieve financial transaction reports. Transactions cover orders, redemptions, credit additions, expirations, voids, and reactivations. Supports filtering by date, event type, gift card code, and location.
undo_redemption
Reverse a previous gift card redemption using its transaction ID. Restores the redeemed amount/units back to the gift card balance.
get_company
Retrieve basic company/account information including name, currency, and onboarding status.
get_gift_card
Retrieve a gift card by its code. Returns the full gift card details including balance, status, recipient info, and redemption eligibility.
create_order
Create a new order containing one or more gift cards. Supports recipient details with scheduled email delivery, custom fields, sales taxes, discounts, tips, and metadata.
list_items
List all items (products) available for sale in the Gift Up! checkout. Optionally filter by item group.
list_gift_cards
Search and list gift cards with flexible filtering by status, dates, email, SKU, or order. Supports pagination for large result sets.
update_gift_card
Update properties of a gift card such as title, expiry date, valid-from date, recipient details, SKU, and terms. Only provide the fields you want to change.
manage_item_group
Create a new item group or update an existing one. Item groups organize items in the checkout.
delete_item
Permanently delete an item (product) from the Gift Up! checkout. This action cannot be undone.
void_gift_card
Void a gift card, preventing it from being redeemed. The card can be reactivated later if needed.
delete_item_group
Permanently delete an item group. This action cannot be undone.
manage_item
Create a new item (product) for sale in the Gift Up! checkout, or update an existing item. Items define the gift card products available for purchase, including pricing, value, stock, and expiry settings.
update_order
Update order details, add notes, or mark a postal order as posted. Supports updating purchaser info, adding annotations, and marking physical gift cards as shipped.
redeem_gift_card
Redeem a gift card either partially (by specifying an amount or units) or in full. Returns the transaction ID and remaining balance. Use the **redeemInFull** flag to redeem the entire balance, or specify an **amount**/**units** for a partial redemption.
list_locations
List all physical locations configured in the account. Locations are used for tracking where gift cards are sold or redeemed.
get_order
Retrieve full order details by order ID, including gift cards, purchaser info, revenue, custom fields, notes, and download links.
transfer_balances
Transfer balances from one or more source gift cards to a single destination gift card. The source cards will be emptied and the destination card will receive the combined balance.
Create, manage, redeem, and track digital and physical gift cards. Create orders with gift cards, manage gift card products and item groups, process redemptions and balance transfers, and top up balances. Configure checkout settings, email templates, artwork, promotions, and shipping options. Retrieve financial transaction reports, manage user access and permissions, register webhooks for order and gift card events, and configure Stripe payment integration.
Common questions about connecting Gift up to AI agents with Metorial.