The Gift Up! connector lets your AI agent act in each user's Gift Up! account. Each user connects their own Gift Up! access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 48 tools.
- Tools
- 48
- What they doRead · write · destructive
- 23 · 19 · 623 read19 write6 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Gift Up! connection
In AgentKit > Connections, create a Gift Up! connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'giftup'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Gift Up!:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'giftup_checkout_settings_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "giftup"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Gift Up!:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="giftup_checkout_settings_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Gift Up! credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolgiftup_checkout_settings_getGet the checkout's appearance and behaviour settings: logo, intro text, fonts, colors, links and service fees.Read-onlyGet Checkout Settings
Get the checkout's appearance and behaviour settings: logo, intro text, fonts, colors, links and service fees. Returns the settings.
Inputs
This tool takes no inputs.
giftup_company_getGet the Gift Up company (account) behind the API key: name, currency, time zone and settings.Read-onlyGet Company
Get the Gift Up company (account) behind the API key: name, currency, time zone and settings. Returns the company object. Use it as a connection check.
Inputs
This tool takes no inputs.
giftup_email_settings_getGet the default settings of gift card and receipt emails: logo, sender, subject lines and texts.Read-onlyGet Email Settings
Get the default settings of gift card and receipt emails: logo, sender, subject lines and texts. Returns the settings.
Inputs
This tool takes no inputs.
giftup_gift_card_artwork_listList the uploaded gift card artwork images.Read-onlyList Gift Card Artwork
List the uploaded gift card artwork images. Returns artwork IDs, URLs and sort order.
Inputs
This tool takes no inputs.
giftup_gift_card_getGet one gift card by code with its remaining balance, state flags (canBeRedeemed, hasExpired, isVoided), recipient, dates and ledger.Read-onlyGet Gift Card
Get one gift card by code with its remaining balance, state flags (canBeRedeemed, hasExpired, isVoided), recipient, dates and ledger. Returns the gift card object. Check canBeRedeemed and remainingValue before accepting it.
Inputs
codestringrequired- Gift card code. Example: GIFT-4XK2-9QPL.
giftup_gift_card_settings_getGet default gift card settings: description, barcode format, expiry, display options, general terms and code format.Read-onlyGet Gift Card Settings
Get default gift card settings: description, barcode format, expiry, display options, general terms and code format. Returns the settings.
Inputs
This tool takes no inputs.
giftup_gift_cards_listList gift cards, newest first, filtered by state, creation or update time, order, SKU, recipient or purchaser email, or payment transaction ID, up to 100 per page.Read-onlyList Gift Cards
List gift cards, newest first, filtered by state, creation or update time, order, SKU, recipient or purchaser email, or payment transaction ID, up to 100 per page. Returns gift cards with code, balance, state flags and a total count. Use giftup_gift_card_get to look up one code.
Inputs
created_on_or_afterstring- Only gift cards created on or after this UTC date or time, for example 2026-01-01. Example: 2026-01-01.
limitinteger- Number of results to return, 1 to 100. Example: 25.
offsetinteger- Number of results to skip. Example: 0.
order_idstring- Only gift cards from this order ID. Example: 8b0e2f4a-1c3d-4e5f-9a7b-6c5d4e3f2a1b.
payment_transaction_idstring- Only gift cards whose payment provider transaction ID matches. Example: pi_3PqRsT2eZvKYlo2C1abcdEF.
purchaser_emailstring- Only gift cards bought by this email. Example: jane.doe@example.com.
recipient_emailstring- Only gift cards sent to this recipient email. Example: sam.lee@example.com.
skustring- Only gift cards with this private SKU. Example: GC-50.
statusstring- Only gift cards in this state. Example: active.one of
activeexpiredredeemedvoided updated_on_or_afterstring- Only gift cards updated on or after this UTC date or time. Example: 2026-01-15T00:00:00Z.
giftup_item_getGet one item by ID.Read-onlyGet Item
Get one item by ID. Returns the item object.
Inputs
item_idstringrequired- ID of the item, from giftup_items_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_item_group_getGet one item group by ID.Read-onlyGet Item Group
Get one item group by ID. Returns the group object.
Inputs
item_group_idstringrequired- ID of the item group, from giftup_item_groups_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_item_groups_listList the item groups that organize items on your checkout.Read-onlyList Item Groups
List the item groups that organize items on your checkout. Returns groups with name, description and sort order.
Inputs
This tool takes no inputs.
giftup_items_listList the items (gift card products) for sale on your checkout, optionally only one group.Read-onlyList Items
List the items (gift card products) for sale on your checkout, optionally only one group. Returns items with price, value, backing type and availability. Use giftup_item_get for one item.
Inputs
group_idstring- Only items in this item group, from giftup_item_groups_list. Example: 7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d.
giftup_locations_listList the account's locations (shops or venues).Read-onlyList Locations
List the account's locations (shops or venues). Returns location IDs and names. Pass an ID as location_id when redeeming or topping up.
Inputs
This tool takes no inputs.
giftup_order_getGet one order by ID with its gift cards, purchaser, totals and notes.Read-onlyGet Order
Get one order by ID with its gift cards, purchaser, totals and notes. Returns the order object.
Inputs
order_idstringrequired- ID of the order, from giftup_orders_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_orders_listList orders, newest first, optionally created since a date, by purchaser email or by source, up to 100 per page.Read-onlyList Orders
List orders, newest first, optionally created since a date, by purchaser email or by source, up to 100 per page. Returns orders with gift cards, totals and a total count. Use giftup_order_get for one order.
Inputs
created_on_or_afterstring- Only orders created on or after this UTC date or time. Example: 2026-01-01.
limitinteger- Number of results to return, 1 to 100. Example: 25.
offsetinteger- Number of results to skip. Example: 0.
purchaser_emailstring- Only orders by this purchaser email. Example: jane.doe@example.com.
sourcestring- Only orders from this source. Example: API.one of
APICheckoutDashboardImportSquareVendExternal
giftup_pingCheck that the API is reachable and the key is accepted.Read-onlyPing
Check that the API is reachable and the key is accepted. Returns pong.
Inputs
This tool takes no inputs.
giftup_promotions_listList checkout promotions with their benefits, usage, limits and triggers.Read-onlyList Promotions
List checkout promotions with their benefits, usage, limits and triggers. Returns promotion objects.
Inputs
This tool takes no inputs.
giftup_shipping_settings_getGet fulfilment settings: email and postal delivery and the postal shipping options with prices and countries.Read-onlyGet Shipping Settings
Get fulfilment settings: email and postal delivery and the postal shipping options with prices and countries. Returns the settings.
Inputs
This tool takes no inputs.
giftup_transaction_getGet one report transaction by ID.Read-onlyGet Transaction
Get one report transaction by ID. Returns the transaction with event, amounts, gift card and metadata.
Inputs
transaction_idstringrequired- ID of the transaction, from giftup_transactions_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_transactions_listList report transactions (orders placed, gift cards created, redeemed, topped up, voided) in a time range, optionally by event, user, location or gift card code, up to 100 per page.Read-onlyList Transactions
List report transactions (orders placed, gift cards created, redeemed, topped up, voided) in a time range, optionally by event, user, location or gift card code, up to 100 per page. Returns transactions with event, amount and gift card.
Inputs
codestring- Only events for this gift card code. Example: GIFT-4XK2-9QPL.
event_occurred_on_or_afterstring- Only events on or after this UTC date or time. Example: 2026-01-01.
event_occurred_on_or_beforestring- Only events on or before this UTC date or time. Example: 2026-01-31.
eventsstring- Only this event type, for example OrderPlaced, GiftCardCreated or GiftCardRedeemed. Example: GiftCardRedeemed.
limitinteger- Number of results to return, 1 to 100. Example: 25.
locationsstring- Only events at this location ID. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
offsetinteger- Number of results to skip. Example: 0.
usersstring- Only events by this user's email. Example: alex@example.com.
giftup_user_getGet one user by ID.Read-onlyGet User
Get one user by ID. Returns the user object.
Inputs
user_idstringrequired- ID of the user, from giftup_users_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_users_listList the people who can access the Gift Up account.Read-onlyList Users
List the people who can access the Gift Up account. Returns users with name, email, admin flag and redeem-app settings.
Inputs
This tool takes no inputs.
giftup_webhook_getGet one webhook subscription by ID.Read-onlyGet Webhook
Get one webhook subscription by ID. Returns the webhook object.
Inputs
webhook_idstringrequired- ID of the webhook, from giftup_webhooks_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_webhooks_listList webhook subscriptions on the account.Read-onlyList Webhooks
List webhook subscriptions on the account. Returns webhook IDs, URLs, event types and test-mode flags.
Inputs
This tool takes no inputs.
giftup_gift_card_balances_transferMove the balances of one or more source gift cards onto one destination gift card.WriteTransfer Gift Card Balances
Move the balances of one or more source gift cards onto one destination gift card. Returns the credit or units transferred. The source cards end with a zero balance.
Inputs
destination_gift_cardstringrequired- Code of the gift card to move the balance to. Example: GIFT-4XK2-9QPL.
source_gift_cardsarrayrequired- Codes of the gift cards to move balance from. Example: ["GIFT-AAAA-1111", "GIFT-BBBB-2222"]
location_idstring- ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
metadataobject- Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
reasonstring- Reason for the transfer; shown in the gift card history log. Example: Customer service adjustment.
giftup_gift_card_reactivateReactivate a voided gift card so its remaining balance can be redeemed again.WriteReactivate Gift Card
Reactivate a voided gift card so its remaining balance can be redeemed again. Returns the result.
- Idempotent
Inputs
codestringrequired- Gift card code. Example: GIFT-4XK2-9QPL.
location_idstring- ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
metadataobject- Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
reasonstring- Reason for the reactivation; shown in the gift card history log. Example: Customer service adjustment.
giftup_gift_card_redeemDeduct an amount (currency cards) or units (unit cards) from a gift card's balance.WriteRedeem Gift Card
Deduct an amount (currency cards) or units (unit cards) from a gift card's balance. Returns the transaction ID, the amount redeemed and the remaining balance. Use giftup_gift_card_redeem_in_full to use the whole balance and giftup_gift_card_redemption_undo to reverse it.
Inputs
codestringrequired- Gift card code. Example: GIFT-4XK2-9QPL.
amountnumber- Currency amount to redeem, no more than the remaining balance; required for currency-backed cards. Example: 25.5.
location_idstring- ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
metadataobject- Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
reasonstring- Reason for the redemption; shown in the gift card history log. Example: Customer service adjustment.
redeemed_onstring- When the redemption happened, UTC, now or in the past. Defaults to now. Example: 2026-01-15T10:30:00Z.
unitsinteger- Units to redeem; required for unit-backed cards. Example: 1.
giftup_gift_card_redeem_in_fullDeduct the whole remaining balance of a gift card.WriteRedeem Gift Card in Full
Deduct the whole remaining balance of a gift card. Returns the transaction ID, the amount or units redeemed and the remaining balance (zero).
Inputs
codestringrequired- Gift card code. Example: GIFT-4XK2-9QPL.
location_idstring- ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
metadataobject- Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
reasonstring- Reason for the redemption; shown in the gift card history log. Example: Customer service adjustment.
redeemed_onstring- When the redemption happened, UTC, now or in the past. Defaults to now. Example: 2026-01-15T10:30:00Z.
giftup_gift_card_redemption_undoReverse an earlier redemption and add the amount back to the gift card.WriteUndo Gift Card Redemption
Reverse an earlier redemption and add the amount back to the gift card. Returns the reversed amount and the new balance. Get the transaction ID from the redeem tools or the gift card ledger.
Inputs
codestringrequired- Gift card code. Example: GIFT-4XK2-9QPL.
transaction_idstringrequired- Transaction ID of the redemption to reverse. Example: 6e5d4c3b-2a19-4f8e-b7d6-c5b4a3928170.
metadataobject- Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
reasonstring- Reason for the undo; shown in the gift card history log. Example: Customer service adjustment.
giftup_gift_card_settings_updateChange default gift card settings such as description, barcode format, expiry, display options, terms and code format.WriteUpdate Gift Card Settings
Change default gift card settings such as description, barcode format, expiry, display options, terms and code format. Returns the result.
- Idempotent
Inputs
barcode_formatstring- Barcode format. Example: QR.one of
PDF417Code128Code39DataMatrixQR code_formatstring- Code pattern, 5 to 50 characters with at least 3 placeholders: @ random letter, # random number, * random letter or number. Example: GIFT-****-****.
default_descriptionstring- Default description on gift cards. Example: Thank you for your purchase!.
expiry_in_daysnumber- Days after purchase that gift cards expire, at least 1. Example: 365.
expiry_in_monthsinteger- Months after purchase that gift cards expire, at least 1. Example: 12.
general_termsstring- General terms and conditions on all gift cards. Example: Not exchangeable for cash.
show_balanceboolean- Set to true to show the balance on gift cards. Example: true.
show_barcodeboolean- Set to true to show the barcode on gift cards. Example: true.
show_issued_on_dateboolean- Set to true to show the issue date on gift cards. Example: true.
valid_from_in_daysnumber- Days after purchase that gift cards become valid. Example: 0.
giftup_gift_card_top_upAdd balance to a gift card: an amount for currency cards or units for unit cards.WriteTop Up Gift Card
Add balance to a gift card: an amount for currency cards or units for unit cards. Returns the transaction ID and the new balance. Voided cards cannot be topped up.
Inputs
codestringrequired- Gift card code. Example: GIFT-4XK2-9QPL.
amountnumber- Currency amount to add, greater than 0; required for currency-backed cards. Example: 20.
location_idstring- ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
metadataobject- Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
reasonstring- Reason for the top-up; shown in the gift card history log. Example: Customer service adjustment.
unitsinteger- Units to add, greater than 0; required for unit-backed cards. Example: 2.
giftup_gift_card_updateUpdate a gift card's title, recipient, SKU, terms, expiry or valid-from date.WriteUpdate Gift Card
Update a gift card's title, recipient, SKU, terms, expiry or valid-from date. Returns the result. Use the redeem, top-up and void tools to change its balance or state.
- Idempotent
Inputs
codestringrequired- Gift card code. Example: GIFT-4XK2-9QPL.
expires_onstring- New expiry date, UTC. Example: 2027-06-30.
recipient_emailstring- Recipient email address. Example: sam.lee@example.com.
recipient_namestring- Recipient name. Example: Sam Lee.
skustring- Private SKU for the gift card. Example: GC-50.
termsstring- Terms and conditions on the gift card. Example: Valid for one year. Not exchangeable for cash.
titlestring- Main title on the gift card. Example: Spa Day Voucher.
valid_fromstring- New valid-from date, UTC. Example: 2026-02-01.
giftup_item_createCreate an item (a gift card product) for sale on your checkout: fixed or custom price, currency or units balance, availability window and expiry.WriteCreate Item
Create an item (a gift card product) for sale on your checkout: fixed or custom price, currency or units balance, availability window and expiry. Returns the new item.
Inputs
namestringrequired- Item name, shown as the gift card title. Example: 60-minute massage.
available_fromstring- When the item goes on sale, UTC. Example: 2026-02-01T00:00:00Z.
available_untilstring- When the item stops being on sale, UTC. Example: 2026-12-31T23:59:59Z.
backing_typestring- Balance type: Currency (default) or Units. Example: Currency.one of
CurrencyUnits descriptionstring- Description shown on the gift card under the name. Example: A relaxing 60-minute massage.
equivalent_value_per_unitnumber- Reporting value per unit; required for unit items. Example: 50.
expires_on_in_monthsinteger- Months after purchase that gift cards expire; needs override_expiry. Example: 12.
groupstring- Name of the item group to put the item in. Example: Spa vouchers.
maximum_pricenumber- Highest price a buyer can enter for a custom-price item. Example: 500.
minimum_pricenumber- Lowest price a buyer can enter for a custom-price item. Example: 10.
override_expiryboolean- Set to true to use this item's expiry instead of the account default. Example: true.
pricenumber- Price charged to the buyer; required for fixed-price currency items and unit items. Example: 50.
price_typestring- Specified (fixed price, default) or Custom (buyer chooses); currency items only. Example: Specified.one of
SpecifiedCustom unitsinteger- Unit balance issued; required for unit items. Example: 1.
valuenumber- Currency balance issued on the gift card; required for currency items. Example: 50.
giftup_item_group_createCreate an item group for your checkout.WriteCreate Item Group
Create an item group for your checkout. Returns the new group.
Inputs
namestringrequired- Name of the group. Example: Spa vouchers.
auto_expandboolean- Set to true to show the group's items expanded on the checkout. Example: true.
descriptionstring- Description of the group. Example: Treatments and day passes.
sort_orderinteger- Position on the checkout, ascending. Example: 1.
giftup_item_group_updateRename an item group or change its description or auto-expand setting.WriteUpdate Item Group
Rename an item group or change its description or auto-expand setting. Returns the result.
- Idempotent
Inputs
item_group_idstringrequired- ID of the item group, from giftup_item_groups_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
auto_expandboolean- Set to true to show items expanded on the checkout. Example: false.
descriptionstring- New description. Example: Treatments, day passes and classes.
namestring- New group name. Example: Spa and wellness.
giftup_item_updateUpdate an item's name, description, terms, price, value, details URL, SKU, stock level or per-order limit.WriteUpdate Item
Update an item's name, description, terms, price, value, details URL, SKU, stock level or per-order limit. Returns the result.
- Idempotent
Inputs
item_idstringrequired- ID of the item, from giftup_items_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
additional_termsstring- Extra terms for gift cards from this item. Example: Weekdays only.
descriptionstring- New description. Example: A relaxing 90-minute massage.
details_urlstring- URL with more information about the item. Example: https://example.com/spa/massage.
namestring- New item name. Example: 90-minute massage.
per_order_limitinteger- Maximum quantity per order. Example: 5.
pricenumber- New price. Example: 75.
skustring- Private SKU added to gift cards sold from this item. Example: SPA-90.
stock_levelinteger- Number of units available to buy. Example: 100.
valuenumber- New currency balance issued. Example: 75.
giftup_order_createCreate an order that issues one or more gift cards, from existing items or ad hoc, optionally emailing or posting them to a recipient.WriteCreate Order
Create an order that issues one or more gift cards, from existing items or ad hoc, optionally emailing or posting them to a recipient. Returns the order with its gift card codes. Live-mode orders incur Gift Up's fee.
Inputs
item_detailsarrayrequired- Gift cards to create; each needs quantity and either an item id or name, backingType, price and value (or units). Example: [{"id": "2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d", "quantity": 1}]
disable_all_emailsboolean- Set to true so Gift Up sends no emails for this order. Example: true.
discountnumber- Total discount on the order. Example: 5.
metadataobject- Key/value data to store on the order, up to 20 keys. Example: {"crm_id": "48213"}
order_datestring- When the order was placed, UTC. Defaults to now. Example: 2026-01-15T10:30:00Z.
purchaser_emailstring- Purchaser email address. Example: jane.doe@example.com.
purchaser_namestring- Purchaser name. Example: Jane Doe.
recipient_detailsobject- Recipient for an emailed or posted gift card: recipientName, recipientEmail, message, scheduledFor, fulfilmentMethod (Email, Post, None) and shippingAddress. Example: {"recipientName": "Sam Lee", "recipientEmail": "sam.lee@example.com", "message": "Happy birthday!", "fulfilmentMethod": "Email"}
revenuenumber- Revenue taken for the order. Example: 50.
sales_taxesarray- Sales taxes for the order, each an object. Example: [{"name": "VAT", "amount": 8.33}]
service_feenumber- Service fee added to the order. Example: 1.5.
tipnumber- Tip taken for the order. Example: 2.
giftup_order_mark_postedMark a postal order as posted, replacing provisional codes with the printed ones.WriteMark Order as Posted
Mark a postal order as posted, replacing provisional codes with the printed ones. Returns the result. The codes list must include every code in the order.
- Idempotent
Inputs
codesarrayrequired- Every code in the order, each as {oldCode, newCode}; set newCode equal to oldCode to keep it. Example: [{"oldCode": "GIFT-4XK2-9QPL", "newCode": "GIFT-4XK2-9QPL"}]
order_idstringrequired- ID of the order, from giftup_orders_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_order_note_addAdd an internal note to an order.WriteAdd Order Note
Add an internal note to an order. Returns the result.
Inputs
contentstringrequired- Text of the note, up to 500 characters; line breaks allowed. Example: Customer called to change the delivery date.
order_idstringrequired- ID of the order, from giftup_orders_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_order_updateChange an order's purchaser name or email.WriteUpdate Order
Change an order's purchaser name or email. Returns the result.
- Idempotent
Inputs
order_idstringrequired- Order ID or order number, from giftup_orders_list. Example: 8b0e2f4a-1c3d-4e5f-9a7b-6c5d4e3f2a1b.
purchaser_emailstring- New purchaser email. Example: jane.smith@example.com.
purchaser_namestring- New purchaser name. Example: Jane Smith.
giftup_user_inviteInvite a person by email to access the Gift Up account, optionally as an administrator.WriteInvite User
Invite a person by email to access the Gift Up account, optionally as an administrator. Returns the new user. Gift Up emails them an invitation.
Inputs
emailstringrequired- Email address to invite. Example: alex@example.com.
namestringrequired- Full name of the user. Example: Alex Morgan.
is_administratorboolean- Set to true to make the user a dashboard administrator. Example: false.
pinstring- PIN for the Gift Up redeem app. Example: 4821.
giftup_user_updateChange a user's name, email, redeem-app PIN or role.WriteUpdate User
Change a user's name, email, redeem-app PIN or role. Returns the result.
- Idempotent
Inputs
user_idstringrequired- ID of the user, from giftup_users_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
emailstring- New email address. Example: alex.ml@example.com.
namestring- New name. Example: Alex Morgan-Lee.
pinstring- New redeem-app PIN. Example: 7314.
rolestring- administrator to make the user an admin; empty for a standard user. Example: administrator.
giftup_webhook_createSubscribe a URL to an event (order created, gift card created, updated or redeemed).WriteCreate Webhook
Subscribe a URL to an event (order created, gift card created, updated or redeemed). Gift Up first POSTs {"test": true} to the URL, which must answer 200. Returns the webhook ID.
Inputs
eventstringrequired- Event to subscribe to. Example: order-created.one of
order-createdgift-card-createdgift-card-updatedgift-card-redeemed target_urlstringrequired- URL Gift Up posts events to. Example: https://example.com/hooks/giftup.
is_test_modeboolean- Set to true to fire only on test-mode data. Example: false.
secretstring- Secret Gift Up uses to sign each delivery. Example: whsec_4f8c2a.
giftup_gift_card_artwork_deleteDelete one uploaded gift card artwork image.DestructiveDelete Gift Card Artwork
Delete one uploaded gift card artwork image. Returns the result.
- Idempotent
Inputs
artwork_idstringrequired- ID of the artwork, from giftup_gift_card_artwork_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_gift_card_voidVoid a gift card so it can no longer be redeemed.DestructiveVoid Gift Card
Void a gift card so it can no longer be redeemed. Returns the result. Reverse it with giftup_gift_card_reactivate.
- Idempotent
Inputs
codestringrequired- Gift card code. Example: GIFT-4XK2-9QPL.
location_idstring- ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
metadataobject- Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
reasonstring- Reason for the voiding; shown in the gift card history log. Example: Customer service adjustment.
giftup_item_deleteDelete an item so it is no longer sold.DestructiveDelete Item
Delete an item so it is no longer sold. Existing gift cards are not affected. Returns the result.
- Idempotent
Inputs
item_idstringrequired- ID of the item, from giftup_items_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_item_group_deleteDelete an empty item group.DestructiveDelete Item Group
Delete an empty item group. Returns the result; a group that still has items returns 400.
- Idempotent
Inputs
item_group_idstringrequired- ID of the item group, from giftup_item_groups_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_user_deleteRemove a user's access to the Gift Up account.DestructiveRemove User
Remove a user's access to the Gift Up account. Returns the result.
- Idempotent
Inputs
user_idstringrequired- ID of the user, from giftup_users_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
giftup_webhook_deleteDelete a webhook subscription.DestructiveDelete Webhook
Delete a webhook subscription. Returns the result.
- Idempotent
Inputs
webhook_idstringrequired- ID of the webhook, from giftup_webhooks_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
No tools match.