> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Gift Up!

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.

**Authentication:** Bearer Token
**Categories:** Accounting & Finance, Marketing
**Tools:** 48: 23 read, 19 write, 6 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=GIFTUP)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Gift Up! connection

   In **AgentKit > Connections**, create a Gift Up! connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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.actions

   const connector = 'giftup'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { 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 call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'giftup_checkout_settings_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_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.actions

   connection_name = "giftup"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_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 call
   result = actions.execute_tool(
       tool_input={},
       tool_name="giftup_checkout_settings_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Gift Up! credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'giftup_checkout_settings_get',
  toolInput: {},
  connector: 'giftup',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="giftup_checkout_settings_get",
    tool_input={},
    connection_name="giftup",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `giftup_checkout_settings_get`

Get Checkout Settings · Read-only

Get the checkout's appearance and behaviour settings: logo, intro text, fonts, colors, links and service fees. Returns the settings.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_company_get`

Get Company · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_email_settings_get`

Get Email Settings · Read-only

Get the default settings of gift card and receipt emails: logo, sender, subject lines and texts. Returns the settings.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_gift_card_artwork_list`

List Gift Card Artwork · Read-only

List the uploaded gift card artwork images. Returns artwork IDs, URLs and sort order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_gift_card_get`

Get Gift Card · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Gift card code. Example: GIFT-4XK2-9QPL.

Example input: `{"code":"<code>"}`

### `giftup_gift_card_settings_get`

Get Gift Card Settings · Read-only

Get default gift card settings: description, barcode format, expiry, display options, general terms and code format. Returns the settings.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_gift_cards_list`

List Gift Cards · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `created_on_or_after` (`string`, optional): Only gift cards created on or after this UTC date or time, for example 2026-01-01. Example: 2026-01-01.
- `limit` (`integer`, optional): Number of results to return, 1 to 100. Example: 25.
- `offset` (`integer`, optional): Number of results to skip. Example: 0.
- `order_id` (`string`, optional): Only gift cards from this order ID. Example: 8b0e2f4a-1c3d-4e5f-9a7b-6c5d4e3f2a1b.
- `payment_transaction_id` (`string`, optional): Only gift cards whose payment provider transaction ID matches. Example: pi_3PqRsT2eZvKYlo2C1abcdEF.
- `purchaser_email` (`string`, optional): Only gift cards bought by this email. Example: jane.doe@example.com.
- `recipient_email` (`string`, optional): Only gift cards sent to this recipient email. Example: sam.lee@example.com.
- `sku` (`string`, optional): Only gift cards with this private SKU. Example: GC-50.
- `status` (`string`, optional): Only gift cards in this state. Example: active. One of: `active`, `expired`, `redeemed`, `voided`.
- `updated_on_or_after` (`string`, optional): Only gift cards updated on or after this UTC date or time. Example: 2026-01-15T00:00:00Z.

Example input: `{}`

### `giftup_item_get`

Get Item · Read-only

Get one item by ID. Returns the item object.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): ID of the item, from giftup_items_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"item_id":"<item_id>"}`

### `giftup_item_group_get`

Get Item Group · Read-only

Get one item group by ID. Returns the group object.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_group_id` (`string`, required): ID of the item group, from giftup_item_groups_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"item_group_id":"<item_group_id>"}`

### `giftup_item_groups_list`

List Item Groups · Read-only

List the item groups that organize items on your checkout. Returns groups with name, description and sort order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_items_list`

List Items · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, optional): Only items in this item group, from giftup_item_groups_list. Example: 7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d.

Example input: `{}`

### `giftup_locations_list`

List Locations · Read-only

List the account's locations (shops or venues). Returns location IDs and names. Pass an ID as location_id when redeeming or topping up.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_order_get`

Get Order · Read-only

Get one order by ID with its gift cards, purchaser, totals and notes. Returns the order object.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`string`, required): ID of the order, from giftup_orders_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"order_id":"<order_id>"}`

### `giftup_orders_list`

List Orders · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `created_on_or_after` (`string`, optional): Only orders created on or after this UTC date or time. Example: 2026-01-01.
- `limit` (`integer`, optional): Number of results to return, 1 to 100. Example: 25.
- `offset` (`integer`, optional): Number of results to skip. Example: 0.
- `purchaser_email` (`string`, optional): Only orders by this purchaser email. Example: jane.doe@example.com.
- `source` (`string`, optional): Only orders from this source. Example: API. One of: `API`, `Checkout`, `Dashboard`, `Import`, `Square`, `Vend`, `External`.

Example input: `{}`

### `giftup_ping`

Ping · Read-only

Check that the API is reachable and the key is accepted. Returns pong.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_promotions_list`

List Promotions · Read-only

List checkout promotions with their benefits, usage, limits and triggers. Returns promotion objects.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_shipping_settings_get`

Get Shipping Settings · Read-only

Get fulfilment settings: email and postal delivery and the postal shipping options with prices and countries. Returns the settings.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_transaction_get`

Get Transaction · Read-only

Get one report transaction by ID. Returns the transaction with event, amounts, gift card and metadata.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `transaction_id` (`string`, required): ID of the transaction, from giftup_transactions_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"transaction_id":"<transaction_id>"}`

### `giftup_transactions_list`

List Transactions · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, optional): Only events for this gift card code. Example: GIFT-4XK2-9QPL.
- `event_occurred_on_or_after` (`string`, optional): Only events on or after this UTC date or time. Example: 2026-01-01.
- `event_occurred_on_or_before` (`string`, optional): Only events on or before this UTC date or time. Example: 2026-01-31.
- `events` (`string`, optional): Only this event type, for example OrderPlaced, GiftCardCreated or GiftCardRedeemed. Example: GiftCardRedeemed.
- `limit` (`integer`, optional): Number of results to return, 1 to 100. Example: 25.
- `locations` (`string`, optional): Only events at this location ID. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
- `offset` (`integer`, optional): Number of results to skip. Example: 0.
- `users` (`string`, optional): Only events by this user's email. Example: alex@example.com.

Example input: `{}`

### `giftup_user_get`

Get User · Read-only

Get one user by ID. Returns the user object.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`string`, required): ID of the user, from giftup_users_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"user_id":"<user_id>"}`

### `giftup_users_list`

List Users · Read-only

List the people who can access the Gift Up account. Returns users with name, email, admin flag and redeem-app settings.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_webhook_get`

Get Webhook · Read-only

Get one webhook subscription by ID. Returns the webhook object.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `webhook_id` (`string`, required): ID of the webhook, from giftup_webhooks_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"webhook_id":"<webhook_id>"}`

### `giftup_webhooks_list`

List Webhooks · Read-only

List webhook subscriptions on the account. Returns webhook IDs, URLs, event types and test-mode flags.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `giftup_gift_card_balances_transfer`

Transfer Gift Card Balances · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `destination_gift_card` (`string`, required): Code of the gift card to move the balance to. Example: GIFT-4XK2-9QPL.
- `source_gift_cards` (`array`, required): Codes of the gift cards to move balance from. Example: ["GIFT-AAAA-1111", "GIFT-BBBB-2222"]
- `location_id` (`string`, optional): ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
- `metadata` (`object`, optional): Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
- `reason` (`string`, optional): Reason for the transfer; shown in the gift card history log. Example: Customer service adjustment.

Example input: `{"destination_gift_card":"<destination_gift_card>","source_gift_cards":["GIFT-AAAA-1111","GIFT-BBBB-2222"]}`

### `giftup_gift_card_reactivate`

Reactivate Gift Card · Write

Reactivate a voided gift card so its remaining balance can be redeemed again. Returns the result.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Gift card code. Example: GIFT-4XK2-9QPL.
- `location_id` (`string`, optional): ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
- `metadata` (`object`, optional): Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
- `reason` (`string`, optional): Reason for the reactivation; shown in the gift card history log. Example: Customer service adjustment.

Example input: `{"code":"<code>"}`

### `giftup_gift_card_redeem`

Redeem Gift Card · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `code` (`string`, required): Gift card code. Example: GIFT-4XK2-9QPL.
- `amount` (`number`, optional): Currency amount to redeem, no more than the remaining balance; required for currency-backed cards. Example: 25.5.
- `location_id` (`string`, optional): ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
- `metadata` (`object`, optional): Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
- `reason` (`string`, optional): Reason for the redemption; shown in the gift card history log. Example: Customer service adjustment.
- `redeemed_on` (`string`, optional): When the redemption happened, UTC, now or in the past. Defaults to now. Example: 2026-01-15T10:30:00Z.
- `units` (`integer`, optional): Units to redeem; required for unit-backed cards. Example: 1.

Example input: `{"code":"<code>"}`

### `giftup_gift_card_redeem_in_full`

Redeem Gift Card in Full · Write

Deduct the whole remaining balance of a gift card. Returns the transaction ID, the amount or units redeemed and the remaining balance (zero).

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `code` (`string`, required): Gift card code. Example: GIFT-4XK2-9QPL.
- `location_id` (`string`, optional): ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
- `metadata` (`object`, optional): Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
- `reason` (`string`, optional): Reason for the redemption; shown in the gift card history log. Example: Customer service adjustment.
- `redeemed_on` (`string`, optional): When the redemption happened, UTC, now or in the past. Defaults to now. Example: 2026-01-15T10:30:00Z.

Example input: `{"code":"<code>"}`

### `giftup_gift_card_redemption_undo`

Undo Gift Card Redemption · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `code` (`string`, required): Gift card code. Example: GIFT-4XK2-9QPL.
- `transaction_id` (`string`, required): Transaction ID of the redemption to reverse. Example: 6e5d4c3b-2a19-4f8e-b7d6-c5b4a3928170.
- `metadata` (`object`, optional): Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
- `reason` (`string`, optional): Reason for the undo; shown in the gift card history log. Example: Customer service adjustment.

Example input: `{"code":"<code>","transaction_id":"<transaction_id>"}`

### `giftup_gift_card_settings_update`

Update Gift Card Settings · Write

Change default gift card settings such as description, barcode format, expiry, display options, terms and code format. Returns the result.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `barcode_format` (`string`, optional): Barcode format. Example: QR. One of: `PDF417`, `Code128`, `Code39`, `DataMatrix`, `QR`.
- `code_format` (`string`, optional): Code pattern, 5 to 50 characters with at least 3 placeholders: @ random letter, # random number, * random letter or number. Example: GIFT-****-****.
- `default_description` (`string`, optional): Default description on gift cards. Example: Thank you for your purchase!.
- `expiry_in_days` (`number`, optional): Days after purchase that gift cards expire, at least 1. Example: 365.
- `expiry_in_months` (`integer`, optional): Months after purchase that gift cards expire, at least 1. Example: 12.
- `general_terms` (`string`, optional): General terms and conditions on all gift cards. Example: Not exchangeable for cash.
- `show_balance` (`boolean`, optional): Set to true to show the balance on gift cards. Example: true.
- `show_barcode` (`boolean`, optional): Set to true to show the barcode on gift cards. Example: true.
- `show_issued_on_date` (`boolean`, optional): Set to true to show the issue date on gift cards. Example: true.
- `valid_from_in_days` (`number`, optional): Days after purchase that gift cards become valid. Example: 0.

Example input: `{}`

### `giftup_gift_card_top_up`

Top Up Gift Card · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `code` (`string`, required): Gift card code. Example: GIFT-4XK2-9QPL.
- `amount` (`number`, optional): Currency amount to add, greater than 0; required for currency-backed cards. Example: 20.
- `location_id` (`string`, optional): ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
- `metadata` (`object`, optional): Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
- `reason` (`string`, optional): Reason for the top-up; shown in the gift card history log. Example: Customer service adjustment.
- `units` (`integer`, optional): Units to add, greater than 0; required for unit-backed cards. Example: 2.

Example input: `{"code":"<code>"}`

### `giftup_gift_card_update`

Update Gift Card · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Gift card code. Example: GIFT-4XK2-9QPL.
- `expires_on` (`string`, optional): New expiry date, UTC. Example: 2027-06-30.
- `recipient_email` (`string`, optional): Recipient email address. Example: sam.lee@example.com.
- `recipient_name` (`string`, optional): Recipient name. Example: Sam Lee.
- `sku` (`string`, optional): Private SKU for the gift card. Example: GC-50.
- `terms` (`string`, optional): Terms and conditions on the gift card. Example: Valid for one year. Not exchangeable for cash.
- `title` (`string`, optional): Main title on the gift card. Example: Spa Day Voucher.
- `valid_from` (`string`, optional): New valid-from date, UTC. Example: 2026-02-01.

Example input: `{"code":"<code>"}`

### `giftup_item_create`

Create Item · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Item name, shown as the gift card title. Example: 60-minute massage.
- `available_from` (`string`, optional): When the item goes on sale, UTC. Example: 2026-02-01T00:00:00Z.
- `available_until` (`string`, optional): When the item stops being on sale, UTC. Example: 2026-12-31T23:59:59Z.
- `backing_type` (`string`, optional): Balance type: Currency (default) or Units. Example: Currency. One of: `Currency`, `Units`.
- `description` (`string`, optional): Description shown on the gift card under the name. Example: A relaxing 60-minute massage.
- `equivalent_value_per_unit` (`number`, optional): Reporting value per unit; required for unit items. Example: 50.
- `expires_on_in_months` (`integer`, optional): Months after purchase that gift cards expire; needs override_expiry. Example: 12.
- `group` (`string`, optional): Name of the item group to put the item in. Example: Spa vouchers.
- `maximum_price` (`number`, optional): Highest price a buyer can enter for a custom-price item. Example: 500.
- `minimum_price` (`number`, optional): Lowest price a buyer can enter for a custom-price item. Example: 10.
- `override_expiry` (`boolean`, optional): Set to true to use this item's expiry instead of the account default. Example: true.
- `price` (`number`, optional): Price charged to the buyer; required for fixed-price currency items and unit items. Example: 50.
- `price_type` (`string`, optional): Specified (fixed price, default) or Custom (buyer chooses); currency items only. Example: Specified. One of: `Specified`, `Custom`.
- `units` (`integer`, optional): Unit balance issued; required for unit items. Example: 1.
- `value` (`number`, optional): Currency balance issued on the gift card; required for currency items. Example: 50.

Example input: `{"name":"<name>"}`

### `giftup_item_group_create`

Create Item Group · Write

Create an item group for your checkout. Returns the new group.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the group. Example: Spa vouchers.
- `auto_expand` (`boolean`, optional): Set to true to show the group's items expanded on the checkout. Example: true.
- `description` (`string`, optional): Description of the group. Example: Treatments and day passes.
- `sort_order` (`integer`, optional): Position on the checkout, ascending. Example: 1.

Example input: `{"name":"<name>"}`

### `giftup_item_group_update`

Update Item Group · Write

Rename an item group or change its description or auto-expand setting. Returns the result.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_group_id` (`string`, required): ID of the item group, from giftup_item_groups_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
- `auto_expand` (`boolean`, optional): Set to true to show items expanded on the checkout. Example: false.
- `description` (`string`, optional): New description. Example: Treatments, day passes and classes.
- `name` (`string`, optional): New group name. Example: Spa and wellness.

Example input: `{"item_group_id":"<item_group_id>"}`

### `giftup_item_update`

Update Item · Write

Update an item's name, description, terms, price, value, details URL, SKU, stock level or per-order limit. Returns the result.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): ID of the item, from giftup_items_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
- `additional_terms` (`string`, optional): Extra terms for gift cards from this item. Example: Weekdays only.
- `description` (`string`, optional): New description. Example: A relaxing 90-minute massage.
- `details_url` (`string`, optional): URL with more information about the item. Example: https://example.com/spa/massage.
- `name` (`string`, optional): New item name. Example: 90-minute massage.
- `per_order_limit` (`integer`, optional): Maximum quantity per order. Example: 5.
- `price` (`number`, optional): New price. Example: 75.
- `sku` (`string`, optional): Private SKU added to gift cards sold from this item. Example: SPA-90.
- `stock_level` (`integer`, optional): Number of units available to buy. Example: 100.
- `value` (`number`, optional): New currency balance issued. Example: 75.

Example input: `{"item_id":"<item_id>"}`

### `giftup_order_create`

Create Order · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `item_details` (`array`, required): 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_emails` (`boolean`, optional): Set to true so Gift Up sends no emails for this order. Example: true.
- `discount` (`number`, optional): Total discount on the order. Example: 5.
- `metadata` (`object`, optional): Key/value data to store on the order, up to 20 keys. Example: {"crm_id": "48213"}
- `order_date` (`string`, optional): When the order was placed, UTC. Defaults to now. Example: 2026-01-15T10:30:00Z.
- `purchaser_email` (`string`, optional): Purchaser email address. Example: jane.doe@example.com.
- `purchaser_name` (`string`, optional): Purchaser name. Example: Jane Doe.
- `recipient_details` (`object`, optional): 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"}
- `revenue` (`number`, optional): Revenue taken for the order. Example: 50.
- `sales_taxes` (`array`, optional): Sales taxes for the order, each an object. Example: [{"name": "VAT", "amount": 8.33}]
- `service_fee` (`number`, optional): Service fee added to the order. Example: 1.5.
- `tip` (`number`, optional): Tip taken for the order. Example: 2.

Example input: `{"item_details":[{"id":"2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d","quantity":1}]}`

### `giftup_order_mark_posted`

Mark Order as Posted · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `codes` (`array`, required): 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_id` (`string`, required): ID of the order, from giftup_orders_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"codes":[{"oldCode":"GIFT-4XK2-9QPL","newCode":"GIFT-4XK2-9QPL"}],"order_id":"<order_id>"}`

### `giftup_order_note_add`

Add Order Note · Write

Add an internal note to an order. Returns the result.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `content` (`string`, required): Text of the note, up to 500 characters; line breaks allowed. Example: Customer called to change the delivery date.
- `order_id` (`string`, required): ID of the order, from giftup_orders_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"content":"<content>","order_id":"<order_id>"}`

### `giftup_order_update`

Update Order · Write

Change an order's purchaser name or email. Returns the result.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`string`, required): Order ID or order number, from giftup_orders_list. Example: 8b0e2f4a-1c3d-4e5f-9a7b-6c5d4e3f2a1b.
- `purchaser_email` (`string`, optional): New purchaser email. Example: jane.smith@example.com.
- `purchaser_name` (`string`, optional): New purchaser name. Example: Jane Smith.

Example input: `{"order_id":"<order_id>"}`

### `giftup_user_invite`

Invite User · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): Email address to invite. Example: alex@example.com.
- `name` (`string`, required): Full name of the user. Example: Alex Morgan.
- `is_administrator` (`boolean`, optional): Set to true to make the user a dashboard administrator. Example: false.
- `pin` (`string`, optional): PIN for the Gift Up redeem app. Example: 4821.

Example input: `{"email":"<email>","name":"<name>"}`

### `giftup_user_update`

Update User · Write

Change a user's name, email, redeem-app PIN or role. Returns the result.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`string`, required): ID of the user, from giftup_users_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.
- `email` (`string`, optional): New email address. Example: alex.ml@example.com.
- `name` (`string`, optional): New name. Example: Alex Morgan-Lee.
- `pin` (`string`, optional): New redeem-app PIN. Example: 7314.
- `role` (`string`, optional): administrator to make the user an admin; empty for a standard user. Example: administrator.

Example input: `{"user_id":"<user_id>"}`

### `giftup_webhook_create`

Create Webhook · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `event` (`string`, required): Event to subscribe to. Example: order-created. One of: `order-created`, `gift-card-created`, `gift-card-updated`, `gift-card-redeemed`.
- `target_url` (`string`, required): URL Gift Up posts events to. Example: https://example.com/hooks/giftup.
- `is_test_mode` (`boolean`, optional): Set to true to fire only on test-mode data. Example: false.
- `secret` (`string`, optional): Secret Gift Up uses to sign each delivery. Example: whsec_4f8c2a.

Example input: `{"event":"order-created","target_url":"<target_url>"}`

### `giftup_gift_card_artwork_delete`

Delete Gift Card Artwork · Destructive

Delete one uploaded gift card artwork image. Returns the result.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `artwork_id` (`string`, required): ID of the artwork, from giftup_gift_card_artwork_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"artwork_id":"<artwork_id>"}`

### `giftup_gift_card_void`

Void Gift Card · Destructive

Void a gift card so it can no longer be redeemed. Returns the result. Reverse it with giftup_gift_card_reactivate.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, required): Gift card code. Example: GIFT-4XK2-9QPL.
- `location_id` (`string`, optional): ID of the location where this happened, from giftup_locations_list. Example: 412f6381-02cc-4866-91f5-428a6b7db3b0.
- `metadata` (`object`, optional): Key/value data to store with the transaction, up to 20 keys. Example: {"pos_terminal": "till-2"}
- `reason` (`string`, optional): Reason for the voiding; shown in the gift card history log. Example: Customer service adjustment.

Example input: `{"code":"<code>"}`

### `giftup_item_delete`

Delete Item · Destructive

Delete an item so it is no longer sold. Existing gift cards are not affected. Returns the result.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `item_id` (`string`, required): ID of the item, from giftup_items_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"item_id":"<item_id>"}`

### `giftup_item_group_delete`

Delete Item Group · Destructive

Delete an empty item group. Returns the result; a group that still has items returns 400.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `item_group_id` (`string`, required): ID of the item group, from giftup_item_groups_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"item_group_id":"<item_group_id>"}`

### `giftup_user_delete`

Remove User · Destructive

Remove a user's access to the Gift Up account. Returns the result.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`string`, required): ID of the user, from giftup_users_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"user_id":"<user_id>"}`

### `giftup_webhook_delete`

Delete Webhook · Destructive

Delete a webhook subscription. Returns the result.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `webhook_id` (`string`, required): ID of the webhook, from giftup_webhooks_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.

Example input: `{"webhook_id":"<webhook_id>"}`

## Related

Other Accounting & Finance connectors ([all 82](/agentkit/connectors/?category=accounting-finance)):

- [QuickBooks](/agentkit/connectors/quickbooks/): Scalekit connector, OAuth, 117 tools
- [Xero](/agentkit/connectors/xero/): Scalekit connector, OAuth, 94 tools
- [Stripe](/agentkit/connectors/stripe/): Scalekit connector, Access token, 178 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
