{ "service": "gift_up", "displayName": "Gift Up", "categories": [ "Finance", "Marketing" ], "authTypes": [ "api_key" ], "auth": [ { "type": "api_key", "label": "API Key", "placeholder": "GIFT_UP_API_KEY", "description": "Gift Up API key sent as a Bearer token in the Authorization header. Create or view API keys in the Gift Up dashboard: https://giftup.app/integrations/api-keys." } ], "homepageUrl": "https://www.giftup.com/", "actions": [ { "id": "gift_up.get_company", "service": "gift_up", "name": "get_company", "description": "Get the Gift Up company associated with the API key.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": {}, "additionalProperties": false, "description": "Input parameters for getting the Gift Up company." }, "outputSchema": { "type": "object", "properties": { "company": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "description": "The company ID." }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The company name." }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string", "description": "The company currency code." }, { "type": "null" } ] }, "onboardingCompleted": { "anyOf": [ { "type": "boolean", "description": "Whether all onboarding steps are complete." }, { "type": "null" } ] }, "canShowCheckout": { "anyOf": [ { "type": "boolean", "description": "Whether the checkout can render." }, { "type": "null" } ] }, "isCheckoutLive": { "anyOf": [ { "type": "boolean", "description": "Whether the checkout has been seen live." }, { "type": "null" } ] }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "A Gift Up company." } }, "additionalProperties": false, "description": "The Gift Up company response." } }, { "id": "gift_up.get_gift_card", "service": "gift_up", "name": "get_gift_card", "description": "Get one Gift Up gift card by code.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "description": "The Gift Up gift card code." } }, "additionalProperties": false, "description": "Input parameters for getting a Gift Up gift card." }, "outputSchema": { "type": "object", "properties": { "giftCard": { "type": "object", "properties": { "code": { "anyOf": [ { "type": "string", "description": "The gift card code." }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "description": "The gift card title." }, { "type": "null" } ] }, "subTitle": { "anyOf": [ { "type": "string", "description": "The gift card subtitle." }, { "type": "null" } ] }, "message": { "anyOf": [ { "type": "string", "description": "The message included with the gift card." }, { "type": "null" } ] }, "recipientName": { "anyOf": [ { "type": "string", "description": "The gift card recipient name." }, { "type": "null" } ] }, "recipientEmail": { "anyOf": [ { "type": "string", "description": "The gift card recipient email address." }, { "type": "null" } ] }, "backingType": { "anyOf": [ { "type": "string", "description": "The gift card balance backing type." }, { "type": "null" } ] }, "remainingValue": { "anyOf": [ { "type": "number", "description": "The remaining currency balance." }, { "type": "null" } ] }, "remainingUnits": { "anyOf": [ { "type": "integer", "description": "The remaining unit balance." }, { "type": "null" } ] }, "initialValue": { "anyOf": [ { "type": "number", "description": "The initial currency balance." }, { "type": "null" } ] }, "initialUnits": { "anyOf": [ { "type": "integer", "description": "The initial unit balance." }, { "type": "null" } ] }, "equivalentValuePerUnit": { "anyOf": [ { "type": "number", "description": "The equivalent value per unit." }, { "type": "null" } ] }, "canBeRedeemed": { "anyOf": [ { "type": "boolean", "description": "Whether the gift card can be redeemed." }, { "type": "null" } ] }, "hasExpired": { "anyOf": [ { "type": "boolean", "description": "Whether the gift card has expired." }, { "type": "null" } ] }, "notYetValid": { "anyOf": [ { "type": "boolean", "description": "Whether the gift card is not yet valid." }, { "type": "null" } ] }, "isVoided": { "anyOf": [ { "type": "boolean", "description": "Whether the gift card is voided." }, { "type": "null" } ] }, "fulfilledOn": { "anyOf": [ { "type": "string", "description": "The datetime when the gift card was fulfilled." }, { "type": "null" } ] }, "expiresOn": { "anyOf": [ { "type": "string", "description": "The datetime when the gift card expires." }, { "type": "null" } ] }, "validFrom": { "anyOf": [ { "type": "string", "description": "The datetime when the gift card becomes valid." }, { "type": "null" } ] }, "voidedOn": { "anyOf": [ { "type": "string", "description": "The datetime when the gift card was voided." }, { "type": "null" } ] }, "fulfilledBy": { "anyOf": [ { "type": "string", "description": "The fulfillment method." }, { "type": "null" } ] }, "terms": { "anyOf": [ { "type": "string", "description": "The terms captured when the gift card was created." }, { "type": "null" } ] }, "sku": { "anyOf": [ { "type": "string", "description": "The private SKU associated with the gift card item." }, { "type": "null" } ] }, "order": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "postalFulfilment": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "emailFulfilment": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "downloadLinks": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "ledger": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The ledger events for the gift card." }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "A Gift Up gift card." } }, "additionalProperties": false, "description": "The Gift Up gift card response." } }, { "id": "gift_up.get_item", "service": "gift_up", "name": "get_item", "description": "Get one Gift Up item by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "The Gift Up object ID.", "format": "uuid" } }, "additionalProperties": false, "description": "Input parameters for getting a Gift Up item." }, "outputSchema": { "type": "object", "properties": { "item": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "description": "The item ID." }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The item name." }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "description": "The item description." }, { "type": "null" } ] }, "backingType": { "anyOf": [ { "type": "string", "description": "The item balance backing type." }, { "type": "null" } ] }, "priceType": { "anyOf": [ { "type": "string", "description": "The item price type." }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number", "description": "The item purchaser price." }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number", "description": "The currency balance issued by this item." }, { "type": "null" } ] }, "units": { "anyOf": [ { "type": "integer", "description": "The unit balance issued by this item." }, { "type": "null" } ] }, "equivalentValuePerUnit": { "anyOf": [ { "type": "number", "description": "The equivalent value per unit." }, { "type": "null" } ] }, "minimumPrice": { "anyOf": [ { "type": "number", "description": "The minimum custom price." }, { "type": "null" } ] }, "maximumPrice": { "anyOf": [ { "type": "number", "description": "The maximum custom price." }, { "type": "null" } ] }, "availableFrom": { "anyOf": [ { "type": "string", "description": "The datetime when the item becomes available." }, { "type": "null" } ] }, "availableUntil": { "anyOf": [ { "type": "string", "description": "The datetime when the item stops being available." }, { "type": "null" } ] }, "group": { "anyOf": [ { "type": "string", "description": "The item group name." }, { "type": "null" } ] }, "groupId": { "anyOf": [ { "type": "string", "description": "The item group ID." }, { "type": "null" } ] }, "detailsURL": { "anyOf": [ { "type": "string", "description": "The item details URL." }, { "type": "null" } ] }, "artworkURL": { "anyOf": [ { "type": "string", "description": "The item artwork URL." }, { "type": "null" } ] }, "stockLevel": { "anyOf": [ { "type": "integer", "description": "The item stock level." }, { "type": "null" } ] }, "codes": { "type": "array", "items": { "type": "string", "description": "A pre-generated code." }, "description": "The pre-generated item codes." }, "perOrderLimit": { "anyOf": [ { "type": "integer", "description": "The per-order item limit." }, { "type": "null" } ] }, "additionalTerms": { "anyOf": [ { "type": "string", "description": "Additional terms for this item." }, { "type": "null" } ] }, "sku": { "anyOf": [ { "type": "string", "description": "The item SKU." }, { "type": "null" } ] }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "A Gift Up item." } }, "additionalProperties": false, "description": "The Gift Up item response." } }, { "id": "gift_up.get_order", "service": "gift_up", "name": "get_order", "description": "Get one Gift Up order by ID or order number.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Gift Up order ID or order number." } }, "additionalProperties": false, "description": "Input parameters for getting a Gift Up order." }, "outputSchema": { "type": "object", "properties": { "order": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "description": "The order ID." }, { "type": "null" } ] }, "orderNumber": { "anyOf": [ { "type": "string", "description": "The presentable order reference number." }, { "type": "null" } ] }, "createdOn": { "anyOf": [ { "type": "string", "description": "The datetime when the order was created." }, { "type": "null" } ] }, "selectedRecipient": { "anyOf": [ { "type": "string", "description": "The selected recipient mode." }, { "type": "null" } ] }, "purchaserEmail": { "anyOf": [ { "type": "string", "description": "The purchaser email address." }, { "type": "null" } ] }, "purchaserName": { "anyOf": [ { "type": "string", "description": "The purchaser name." }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string", "description": "The order currency code." }, { "type": "null" } ] }, "revenue": { "anyOf": [ { "type": "number", "description": "The order revenue." }, { "type": "null" } ] }, "tip": { "anyOf": [ { "type": "number", "description": "The order tip." }, { "type": "null" } ] }, "serviceFee": { "anyOf": [ { "type": "number", "description": "The order service fee." }, { "type": "null" } ] }, "discount": { "anyOf": [ { "type": "number", "description": "The order discount." }, { "type": "null" } ] }, "shippingFee": { "anyOf": [ { "type": "number", "description": "The order shipping fee." }, { "type": "null" } ] }, "referrer": { "anyOf": [ { "type": "string", "description": "The order referrer." }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "The order source." }, { "type": "null" } ] }, "promotions": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The promotions applied to the order." }, "customFields": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The custom fields collected for the order." }, "salesTaxes": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The sales taxes for the order." }, "notes": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The notes added to the order." }, "metadata": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "downloadLinks": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "payment": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "fulfilments": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The fulfillment results for created gift cards." }, "giftCards": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The gift cards created by the order." }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "A Gift Up order." } }, "additionalProperties": false, "description": "The Gift Up order response." } }, { "id": "gift_up.get_report_transaction", "service": "gift_up", "name": "get_report_transaction", "description": "Get one Gift Up report transaction by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "The Gift Up object ID.", "format": "uuid" } }, "additionalProperties": false, "description": "Input parameters for getting a Gift Up report transaction." }, "outputSchema": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "description": "The transaction ID." }, { "type": "null" } ] }, "eventOccurredOn": { "anyOf": [ { "type": "string", "description": "The datetime when the transaction event occurred." }, { "type": "null" } ] }, "eventOccurredAtLocationId": { "anyOf": [ { "type": "string", "description": "The location ID where the transaction event occurred." }, { "type": "null" } ] }, "eventType": { "anyOf": [ { "type": "string", "description": "The transaction event type." }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "description": "The reason recorded for the transaction." }, { "type": "null" } ] }, "referrer": { "anyOf": [ { "type": "string", "description": "The transaction referrer." }, { "type": "null" } ] }, "metadata": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "orderId": { "anyOf": [ { "type": "string", "description": "The order ID associated with the transaction." }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string", "description": "The transaction currency code." }, { "type": "null" } ] }, "giftUpFee": { "anyOf": [ { "type": "number", "description": "The Gift Up fee for the transaction." }, { "type": "null" } ] }, "whoName": { "anyOf": [ { "type": "string", "description": "The name of the user who triggered the event." }, { "type": "null" } ] }, "whoEmail": { "anyOf": [ { "type": "string", "description": "The email of the user who triggered the event." }, { "type": "null" } ] }, "orderDetails": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "giftCard": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "A Gift Up report transaction." } }, "additionalProperties": false, "description": "The Gift Up report transaction response." } }, { "id": "gift_up.list_gift_cards", "service": "gift_up", "name": "list_gift_cards", "description": "List Gift Up gift cards with optional filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "expired", "redeemed", "voided" ], "description": "Only include gift cards in this state." }, "createdOnOrAfter": { "type": "string", "minLength": 1, "description": "Only include gift cards created on or after this datetime. Gift Up accepts date or datetime strings." }, "updatedOnOrAfter": { "type": "string", "minLength": 1, "description": "Only include gift cards updated on or after this datetime. Gift Up accepts date or datetime strings." }, "orderId": { "type": "string", "description": "The Gift Up object ID.", "format": "uuid" }, "sku": { "type": "string", "minLength": 1, "description": "Only include gift cards with this SKU." }, "recipientEmail": { "type": "string", "description": "Only include gift cards for this recipient email address.", "format": "email" }, "purchaserEmail": { "type": "string", "description": "Only include gift cards for this purchaser email address.", "format": "email" }, "paymentTransactionId": { "type": "string", "minLength": 1, "description": "Only include gift cards with this payment provider transaction ID." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The maximum number of objects to return." }, "offset": { "type": "integer", "minimum": 0, "description": "The number of objects to skip." } }, "additionalProperties": false, "description": "Input parameters for listing Gift Up gift cards." }, "outputSchema": { "type": "object", "properties": { "page": { "type": "object", "properties": { "total": { "anyOf": [ { "type": "integer", "description": "The total number of matching objects." }, { "type": "null" } ] }, "hasMore": { "anyOf": [ { "type": "boolean", "description": "Whether Gift Up has more objects after this page." }, { "type": "null" } ] }, "offset": { "anyOf": [ { "type": "integer", "description": "The offset used for the request." }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "description": "The limit used for the request." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Gift Up offset pagination metadata." }, "giftCards": { "type": "array", "items": { "type": "object", "properties": { "code": { "anyOf": [ { "type": "string", "description": "The gift card code." }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "description": "The gift card title." }, { "type": "null" } ] }, "subTitle": { "anyOf": [ { "type": "string", "description": "The gift card subtitle." }, { "type": "null" } ] }, "message": { "anyOf": [ { "type": "string", "description": "The message included with the gift card." }, { "type": "null" } ] }, "recipientName": { "anyOf": [ { "type": "string", "description": "The gift card recipient name." }, { "type": "null" } ] }, "recipientEmail": { "anyOf": [ { "type": "string", "description": "The gift card recipient email address." }, { "type": "null" } ] }, "backingType": { "anyOf": [ { "type": "string", "description": "The gift card balance backing type." }, { "type": "null" } ] }, "remainingValue": { "anyOf": [ { "type": "number", "description": "The remaining currency balance." }, { "type": "null" } ] }, "remainingUnits": { "anyOf": [ { "type": "integer", "description": "The remaining unit balance." }, { "type": "null" } ] }, "initialValue": { "anyOf": [ { "type": "number", "description": "The initial currency balance." }, { "type": "null" } ] }, "initialUnits": { "anyOf": [ { "type": "integer", "description": "The initial unit balance." }, { "type": "null" } ] }, "equivalentValuePerUnit": { "anyOf": [ { "type": "number", "description": "The equivalent value per unit." }, { "type": "null" } ] }, "canBeRedeemed": { "anyOf": [ { "type": "boolean", "description": "Whether the gift card can be redeemed." }, { "type": "null" } ] }, "hasExpired": { "anyOf": [ { "type": "boolean", "description": "Whether the gift card has expired." }, { "type": "null" } ] }, "notYetValid": { "anyOf": [ { "type": "boolean", "description": "Whether the gift card is not yet valid." }, { "type": "null" } ] }, "isVoided": { "anyOf": [ { "type": "boolean", "description": "Whether the gift card is voided." }, { "type": "null" } ] }, "fulfilledOn": { "anyOf": [ { "type": "string", "description": "The datetime when the gift card was fulfilled." }, { "type": "null" } ] }, "expiresOn": { "anyOf": [ { "type": "string", "description": "The datetime when the gift card expires." }, { "type": "null" } ] }, "validFrom": { "anyOf": [ { "type": "string", "description": "The datetime when the gift card becomes valid." }, { "type": "null" } ] }, "voidedOn": { "anyOf": [ { "type": "string", "description": "The datetime when the gift card was voided." }, { "type": "null" } ] }, "fulfilledBy": { "anyOf": [ { "type": "string", "description": "The fulfillment method." }, { "type": "null" } ] }, "terms": { "anyOf": [ { "type": "string", "description": "The terms captured when the gift card was created." }, { "type": "null" } ] }, "sku": { "anyOf": [ { "type": "string", "description": "The private SKU associated with the gift card item." }, { "type": "null" } ] }, "order": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "postalFulfilment": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "emailFulfilment": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "downloadLinks": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "ledger": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The ledger events for the gift card." }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "A Gift Up gift card." }, "description": "The Gift Up gift cards in this page." }, "raw": { "description": "The raw Gift Up list response." } }, "additionalProperties": false, "description": "The Gift Up gift card list response." } }, { "id": "gift_up.list_items", "service": "gift_up", "name": "list_items", "description": "List Gift Up items, optionally filtered by item group.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "groupId": { "type": "string", "description": "The Gift Up object ID.", "format": "uuid" } }, "additionalProperties": false, "description": "Input parameters for listing Gift Up items." }, "outputSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "description": "The item ID." }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The item name." }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "description": "The item description." }, { "type": "null" } ] }, "backingType": { "anyOf": [ { "type": "string", "description": "The item balance backing type." }, { "type": "null" } ] }, "priceType": { "anyOf": [ { "type": "string", "description": "The item price type." }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number", "description": "The item purchaser price." }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number", "description": "The currency balance issued by this item." }, { "type": "null" } ] }, "units": { "anyOf": [ { "type": "integer", "description": "The unit balance issued by this item." }, { "type": "null" } ] }, "equivalentValuePerUnit": { "anyOf": [ { "type": "number", "description": "The equivalent value per unit." }, { "type": "null" } ] }, "minimumPrice": { "anyOf": [ { "type": "number", "description": "The minimum custom price." }, { "type": "null" } ] }, "maximumPrice": { "anyOf": [ { "type": "number", "description": "The maximum custom price." }, { "type": "null" } ] }, "availableFrom": { "anyOf": [ { "type": "string", "description": "The datetime when the item becomes available." }, { "type": "null" } ] }, "availableUntil": { "anyOf": [ { "type": "string", "description": "The datetime when the item stops being available." }, { "type": "null" } ] }, "group": { "anyOf": [ { "type": "string", "description": "The item group name." }, { "type": "null" } ] }, "groupId": { "anyOf": [ { "type": "string", "description": "The item group ID." }, { "type": "null" } ] }, "detailsURL": { "anyOf": [ { "type": "string", "description": "The item details URL." }, { "type": "null" } ] }, "artworkURL": { "anyOf": [ { "type": "string", "description": "The item artwork URL." }, { "type": "null" } ] }, "stockLevel": { "anyOf": [ { "type": "integer", "description": "The item stock level." }, { "type": "null" } ] }, "codes": { "type": "array", "items": { "type": "string", "description": "A pre-generated code." }, "description": "The pre-generated item codes." }, "perOrderLimit": { "anyOf": [ { "type": "integer", "description": "The per-order item limit." }, { "type": "null" } ] }, "additionalTerms": { "anyOf": [ { "type": "string", "description": "Additional terms for this item." }, { "type": "null" } ] }, "sku": { "anyOf": [ { "type": "string", "description": "The item SKU." }, { "type": "null" } ] }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "A Gift Up item." }, "description": "The Gift Up items." }, "raw": { "description": "The raw Gift Up list response." } }, "additionalProperties": false, "description": "The Gift Up item list response." } }, { "id": "gift_up.list_locations", "service": "gift_up", "name": "list_locations", "description": "List Gift Up account locations.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": {}, "additionalProperties": false, "description": "Input parameters for listing Gift Up locations." }, "outputSchema": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "description": "The location ID." }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The location name." }, { "type": "null" } ] }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "A Gift Up location." }, "description": "The Gift Up locations." }, "raw": { "description": "The raw Gift Up list response." } }, "additionalProperties": false, "description": "The Gift Up location list response." } }, { "id": "gift_up.list_orders", "service": "gift_up", "name": "list_orders", "description": "List Gift Up orders with optional filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "createdOnOrAfter": { "type": "string", "minLength": 1, "description": "Only include orders created on or after this datetime. Gift Up accepts date or datetime strings." }, "purchaserEmail": { "type": "string", "description": "Only include orders for this purchaser email address.", "format": "email" }, "source": { "type": "string", "enum": [ "API", "Checkout", "Dashboard", "Import", "Square", "Vend", "External" ], "description": "Only include orders from this source." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The maximum number of objects to return." }, "offset": { "type": "integer", "minimum": 0, "description": "The number of objects to skip." } }, "additionalProperties": false, "description": "Input parameters for listing Gift Up orders." }, "outputSchema": { "type": "object", "properties": { "page": { "type": "object", "properties": { "total": { "anyOf": [ { "type": "integer", "description": "The total number of matching objects." }, { "type": "null" } ] }, "hasMore": { "anyOf": [ { "type": "boolean", "description": "Whether Gift Up has more objects after this page." }, { "type": "null" } ] }, "offset": { "anyOf": [ { "type": "integer", "description": "The offset used for the request." }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "description": "The limit used for the request." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Gift Up offset pagination metadata." }, "orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "description": "The order ID." }, { "type": "null" } ] }, "orderNumber": { "anyOf": [ { "type": "string", "description": "The presentable order reference number." }, { "type": "null" } ] }, "createdOn": { "anyOf": [ { "type": "string", "description": "The datetime when the order was created." }, { "type": "null" } ] }, "selectedRecipient": { "anyOf": [ { "type": "string", "description": "The selected recipient mode." }, { "type": "null" } ] }, "purchaserEmail": { "anyOf": [ { "type": "string", "description": "The purchaser email address." }, { "type": "null" } ] }, "purchaserName": { "anyOf": [ { "type": "string", "description": "The purchaser name." }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string", "description": "The order currency code." }, { "type": "null" } ] }, "revenue": { "anyOf": [ { "type": "number", "description": "The order revenue." }, { "type": "null" } ] }, "tip": { "anyOf": [ { "type": "number", "description": "The order tip." }, { "type": "null" } ] }, "serviceFee": { "anyOf": [ { "type": "number", "description": "The order service fee." }, { "type": "null" } ] }, "discount": { "anyOf": [ { "type": "number", "description": "The order discount." }, { "type": "null" } ] }, "shippingFee": { "anyOf": [ { "type": "number", "description": "The order shipping fee." }, { "type": "null" } ] }, "referrer": { "anyOf": [ { "type": "string", "description": "The order referrer." }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "The order source." }, { "type": "null" } ] }, "promotions": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The promotions applied to the order." }, "customFields": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The custom fields collected for the order." }, "salesTaxes": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The sales taxes for the order." }, "notes": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The notes added to the order." }, "metadata": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "downloadLinks": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "payment": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "fulfilments": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The fulfillment results for created gift cards." }, "giftCards": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A nested Gift Up object." }, "description": "The gift cards created by the order." }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "A Gift Up order." }, "description": "The Gift Up orders in this page." }, "raw": { "description": "The raw Gift Up list response." } }, "additionalProperties": false, "description": "The Gift Up order list response." } }, { "id": "gift_up.list_promotions", "service": "gift_up", "name": "list_promotions", "description": "List Gift Up promotions.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": {}, "additionalProperties": false, "description": "Input parameters for listing Gift Up promotions." }, "outputSchema": { "type": "object", "properties": { "promotions": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "description": "The promotion ID." }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The promotion name." }, { "type": "null" } ] }, "noBenefit": { "anyOf": [ { "type": "boolean", "description": "Whether the promotion is used for tracking only." }, { "type": "null" } ] }, "publishedOn": { "anyOf": [ { "type": "string", "description": "The datetime when the promotion was published." }, { "type": "null" } ] }, "stoppedOn": { "anyOf": [ { "type": "string", "description": "The datetime when the promotion was stopped." }, { "type": "null" } ] }, "benefits": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "usage": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "limitations": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "triggers": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "A Gift Up promotion." }, "description": "The Gift Up promotions." }, "raw": { "description": "The raw Gift Up list response." } }, "additionalProperties": false, "description": "The Gift Up promotion list response." } }, { "id": "gift_up.list_report_transactions", "service": "gift_up", "name": "list_report_transactions", "description": "List Gift Up report transactions with optional filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "eventOccurredOnOrAfter": { "type": "string", "minLength": 1, "description": "Only include transactions that occurred on or after this datetime. Gift Up accepts date or datetime strings." }, "eventOccurredOnOrBefore": { "type": "string", "minLength": 1, "description": "Only include transactions that occurred on or before this datetime. Gift Up accepts date or datetime strings." }, "events": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "A Gift Up event type." }, "description": "Only include transactions for these Gift Up event types.", "minItems": 1 }, "users": { "type": "array", "items": { "type": "string", "description": "A Gift Up user email address.", "format": "email" }, "description": "Only include transactions generated by these user email addresses.", "minItems": 1 }, "locations": { "type": "array", "items": { "type": "string", "description": "The Gift Up object ID.", "format": "uuid" }, "description": "Only include transactions generated at these location IDs.", "minItems": 1 }, "code": { "type": "string", "minLength": 1, "description": "The Gift Up gift card code." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The maximum number of objects to return." }, "offset": { "type": "integer", "minimum": 0, "description": "The number of objects to skip." } }, "additionalProperties": false, "description": "Input parameters for listing Gift Up report transactions." }, "outputSchema": { "type": "object", "properties": { "page": { "type": "object", "properties": { "total": { "anyOf": [ { "type": "integer", "description": "The total number of matching objects." }, { "type": "null" } ] }, "hasMore": { "anyOf": [ { "type": "boolean", "description": "Whether Gift Up has more objects after this page." }, { "type": "null" } ] }, "offset": { "anyOf": [ { "type": "integer", "description": "The offset used for the request." }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer", "description": "The limit used for the request." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Gift Up offset pagination metadata." }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "description": "The transaction ID." }, { "type": "null" } ] }, "eventOccurredOn": { "anyOf": [ { "type": "string", "description": "The datetime when the transaction event occurred." }, { "type": "null" } ] }, "eventOccurredAtLocationId": { "anyOf": [ { "type": "string", "description": "The location ID where the transaction event occurred." }, { "type": "null" } ] }, "eventType": { "anyOf": [ { "type": "string", "description": "The transaction event type." }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "description": "The reason recorded for the transaction." }, { "type": "null" } ] }, "referrer": { "anyOf": [ { "type": "string", "description": "The transaction referrer." }, { "type": "null" } ] }, "metadata": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "orderId": { "anyOf": [ { "type": "string", "description": "The order ID associated with the transaction." }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string", "description": "The transaction currency code." }, { "type": "null" } ] }, "giftUpFee": { "anyOf": [ { "type": "number", "description": "The Gift Up fee for the transaction." }, { "type": "null" } ] }, "whoName": { "anyOf": [ { "type": "string", "description": "The name of the user who triggered the event." }, { "type": "null" } ] }, "whoEmail": { "anyOf": [ { "type": "string", "description": "The email of the user who triggered the event." }, { "type": "null" } ] }, "orderDetails": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "giftCard": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "The nested Gift Up object." }, { "type": "null" } ] }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "A Gift Up report transaction." }, "description": "The Gift Up report transactions in this page." }, "raw": { "description": "The raw Gift Up list response." } }, "additionalProperties": false, "description": "The Gift Up report transaction list response." } }, { "id": "gift_up.reactivate_gift_card", "service": "gift_up", "name": "reactivate_gift_card", "description": "Reactivate a voided Gift Up gift card.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "description": "The Gift Up gift card code." }, "reason": { "type": "string", "description": "The reason to record in the Gift Up history log." }, "locationId": { "type": "string", "description": "The Gift Up location ID where the event occurred.", "format": "uuid" }, "metadata": { "type": "object", "additionalProperties": { "description": "A metadata value." }, "description": "Metadata key-value pairs to attach to the Gift Up event." } }, "additionalProperties": false, "required": [ "code" ], "description": "Input parameters for a Gift Up gift card event." }, "outputSchema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether Gift Up accepted the operation." }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "The Gift Up operation result." } }, { "id": "gift_up.redeem_gift_card", "service": "gift_up", "name": "redeem_gift_card", "description": "Redeem a currency amount or units from a Gift Up gift card.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "description": "The Gift Up gift card code." }, "amount": { "type": "number", "exclusiveMinimum": 0, "description": "The currency amount for a currency-backed gift card." }, "units": { "type": "integer", "minimum": 1, "description": "The unit quantity for a units-backed gift card." }, "reason": { "type": "string", "description": "The reason to record in the Gift Up history log." }, "locationId": { "type": "string", "description": "The Gift Up location ID where the event occurred.", "format": "uuid" }, "metadata": { "type": "object", "additionalProperties": { "description": "A metadata value." }, "description": "Metadata key-value pairs to attach to the Gift Up event." }, "redeemedOn": { "type": "string", "minLength": 1, "description": "The datetime when the redemption occurred. Gift Up accepts date or datetime strings." } }, "additionalProperties": false, "required": [ "code" ], "description": "Input parameters for a Gift Up redemption operation. Provide exactly one of amount or units.", "oneOf": [ { "required": [ "amount" ] }, { "required": [ "units" ] } ] }, "outputSchema": { "type": "object", "properties": { "transactionId": { "anyOf": [ { "type": "string", "description": "The Gift Up transaction ID." }, { "type": "null" } ] }, "remainingCredit": { "anyOf": [ { "type": "number", "description": "The remaining currency balance." }, { "type": "null" } ] }, "remainingUnits": { "anyOf": [ { "type": "integer", "description": "The remaining unit balance." }, { "type": "null" } ] }, "redeemedAmount": { "anyOf": [ { "type": "number", "description": "The redeemed currency amount." }, { "type": "null" } ] }, "redeemedUnits": { "anyOf": [ { "type": "integer", "description": "The redeemed units." }, { "type": "null" } ] }, "amountReversed": { "anyOf": [ { "type": "number", "description": "The reversed currency amount." }, { "type": "null" } ] }, "unitsReversed": { "anyOf": [ { "type": "integer", "description": "The reversed units." }, { "type": "null" } ] }, "alreadyReversed": { "anyOf": [ { "type": "boolean", "description": "Whether the transaction was already reversed." }, { "type": "null" } ] }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "The Gift Up gift card transaction result." } }, { "id": "gift_up.redeem_gift_card_in_full", "service": "gift_up", "name": "redeem_gift_card_in_full", "description": "Redeem all remaining balance from a Gift Up gift card.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "description": "The Gift Up gift card code." }, "reason": { "type": "string", "description": "The reason to record in the Gift Up history log." }, "locationId": { "type": "string", "description": "The Gift Up location ID where the event occurred.", "format": "uuid" }, "metadata": { "type": "object", "additionalProperties": { "description": "A metadata value." }, "description": "Metadata key-value pairs to attach to the Gift Up event." }, "redeemedOn": { "type": "string", "minLength": 1, "description": "The datetime when the redemption occurred. Gift Up accepts date or datetime strings." } }, "additionalProperties": false, "required": [ "code" ], "description": "Input parameters for redeeming a Gift Up gift card in full." }, "outputSchema": { "type": "object", "properties": { "transactionId": { "anyOf": [ { "type": "string", "description": "The Gift Up transaction ID." }, { "type": "null" } ] }, "remainingCredit": { "anyOf": [ { "type": "number", "description": "The remaining currency balance." }, { "type": "null" } ] }, "remainingUnits": { "anyOf": [ { "type": "integer", "description": "The remaining unit balance." }, { "type": "null" } ] }, "redeemedAmount": { "anyOf": [ { "type": "number", "description": "The redeemed currency amount." }, { "type": "null" } ] }, "redeemedUnits": { "anyOf": [ { "type": "integer", "description": "The redeemed units." }, { "type": "null" } ] }, "amountReversed": { "anyOf": [ { "type": "number", "description": "The reversed currency amount." }, { "type": "null" } ] }, "unitsReversed": { "anyOf": [ { "type": "integer", "description": "The reversed units." }, { "type": "null" } ] }, "alreadyReversed": { "anyOf": [ { "type": "boolean", "description": "Whether the transaction was already reversed." }, { "type": "null" } ] }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "The Gift Up gift card transaction result." } }, { "id": "gift_up.top_up_gift_card", "service": "gift_up", "name": "top_up_gift_card", "description": "Add currency amount or units to a Gift Up gift card.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "description": "The Gift Up gift card code." }, "amount": { "type": "number", "exclusiveMinimum": 0, "description": "The currency amount for a currency-backed gift card." }, "units": { "type": "integer", "minimum": 1, "description": "The unit quantity for a units-backed gift card." }, "reason": { "type": "string", "description": "The reason to record in the Gift Up history log." }, "locationId": { "type": "string", "description": "The Gift Up location ID where the event occurred.", "format": "uuid" }, "metadata": { "type": "object", "additionalProperties": { "description": "A metadata value." }, "description": "Metadata key-value pairs to attach to the Gift Up event." } }, "additionalProperties": false, "required": [ "code" ], "description": "Input parameters for a Gift Up top-up operation. Provide exactly one of amount or units.", "oneOf": [ { "required": [ "amount" ] }, { "required": [ "units" ] } ] }, "outputSchema": { "type": "object", "properties": { "transactionId": { "anyOf": [ { "type": "string", "description": "The Gift Up transaction ID." }, { "type": "null" } ] }, "remainingCredit": { "anyOf": [ { "type": "number", "description": "The remaining currency balance." }, { "type": "null" } ] }, "remainingUnits": { "anyOf": [ { "type": "integer", "description": "The remaining unit balance." }, { "type": "null" } ] }, "redeemedAmount": { "anyOf": [ { "type": "number", "description": "The redeemed currency amount." }, { "type": "null" } ] }, "redeemedUnits": { "anyOf": [ { "type": "integer", "description": "The redeemed units." }, { "type": "null" } ] }, "amountReversed": { "anyOf": [ { "type": "number", "description": "The reversed currency amount." }, { "type": "null" } ] }, "unitsReversed": { "anyOf": [ { "type": "integer", "description": "The reversed units." }, { "type": "null" } ] }, "alreadyReversed": { "anyOf": [ { "type": "boolean", "description": "Whether the transaction was already reversed." }, { "type": "null" } ] }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "The Gift Up gift card transaction result." } }, { "id": "gift_up.undo_gift_card_redemption", "service": "gift_up", "name": "undo_gift_card_redemption", "description": "Undo a previous Gift Up gift card redemption transaction.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "description": "The Gift Up gift card code." }, "transactionId": { "type": "string", "description": "The Gift Up object ID.", "format": "uuid" }, "reason": { "type": "string", "description": "The reason to record in the Gift Up history log." }, "metadata": { "type": "object", "additionalProperties": { "description": "A metadata value." }, "description": "Metadata key-value pairs to attach to the Gift Up event." } }, "additionalProperties": false, "required": [ "code", "transactionId" ], "description": "Input parameters for undoing a Gift Up gift card redemption." }, "outputSchema": { "type": "object", "properties": { "transactionId": { "anyOf": [ { "type": "string", "description": "The Gift Up transaction ID." }, { "type": "null" } ] }, "remainingCredit": { "anyOf": [ { "type": "number", "description": "The remaining currency balance." }, { "type": "null" } ] }, "remainingUnits": { "anyOf": [ { "type": "integer", "description": "The remaining unit balance." }, { "type": "null" } ] }, "redeemedAmount": { "anyOf": [ { "type": "number", "description": "The redeemed currency amount." }, { "type": "null" } ] }, "redeemedUnits": { "anyOf": [ { "type": "integer", "description": "The redeemed units." }, { "type": "null" } ] }, "amountReversed": { "anyOf": [ { "type": "number", "description": "The reversed currency amount." }, { "type": "null" } ] }, "unitsReversed": { "anyOf": [ { "type": "integer", "description": "The reversed units." }, { "type": "null" } ] }, "alreadyReversed": { "anyOf": [ { "type": "boolean", "description": "Whether the transaction was already reversed." }, { "type": "null" } ] }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "The Gift Up gift card transaction result." } }, { "id": "gift_up.void_gift_card", "service": "gift_up", "name": "void_gift_card", "description": "Void a Gift Up gift card so it can no longer be redeemed.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "description": "The Gift Up gift card code." }, "reason": { "type": "string", "description": "The reason to record in the Gift Up history log." }, "locationId": { "type": "string", "description": "The Gift Up location ID where the event occurred.", "format": "uuid" }, "metadata": { "type": "object", "additionalProperties": { "description": "A metadata value." }, "description": "Metadata key-value pairs to attach to the Gift Up event." } }, "additionalProperties": false, "required": [ "code" ], "description": "Input parameters for a Gift Up gift card event." }, "outputSchema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether Gift Up accepted the operation." }, "raw": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The raw Gift Up object." } }, "additionalProperties": false, "description": "The Gift Up operation result." } } ] }