Gift Up!

gift_up

Gift Up! is a digital platform that allows businesses to sell, manage, and redeem gift cards online, integrating seamlessly with websites and apps to streamline gift card transactions and promotions.

Ecommerce Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (9)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Get Checkout SettingsGIFT_UP_GET_CHECKOUT_SETTINGSAcción

Tool to retrieve the current checkout settings. Use when you need to display or audit your checkout configuration.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Company DetailsGIFT_UP_GET_COMPANYAcción

Tool to retrieve company details. Use when you need to fetch the current company associated with the API key.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Gift CardsGIFT_UP_LIST_GIFT_CARDSAcción

Tool to list gift cards. Use when you need to retrieve gift cards with optional filters.

Parámetros de entrada

skustring
Include only gift cards with this private SKU value
limitinteger
Number of gift cards to return; default is 10
offsetinteger
Number of gift cards to skip; default is 0
statusstringenum
Include only gift cards in this state
activeexpiredredeemedvoided
orderIdstring
Include only gift cards for this order ID (GUID)
purchaserEmailstringemail
Include only gift cards with this purchaser email address
recipientEmailstringemail
Include only gift cards with this recipient email address
createdOnOrAfterstringdate-time
Include only gift cards created on or after this UTC datetime (ISO 8601)
updatedOnOrAfterstringdate-time
Include only gift cards updated on or after this UTC datetime (ISO 8601)
paymentTransactionIdstring
Include only gift cards where the payment provider transaction ID matches

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Item GroupsGIFT_UP_LIST_ITEM_GROUPSAcción

Tool to list item groups. Use when you need to retrieve all item groups for filtering items by group.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ItemsGIFT_UP_LIST_ITEMSAcción

Tool to list items. Use when you need to retrieve all items available for sale, optional filter by groupId.

Parámetros de entrada

groupIdstring
Include only items in this group (UUID)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List LocationsGIFT_UP_LIST_LOCATIONSAcción

Tool to list all locations. Use when you need to retrieve all locations associated with the account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Report TransactionsGIFT_UP_LIST_REPORT_TRANSACTIONSAcción

Tool to list report transactions with optional filters. Use after setting desired filters to retrieve transactions report.

Parámetros de entrada

codestring
Filter by gift card code.
limitinteger
Number of transactions to return (default 20).
usersstring[]
Filter by user email address; can be specified multiple times.
eventsstring[]
Filter by event type; can be specified multiple times. One of: OrderPlaced, GiftCardCreated, CreditAdded, Redeemed, Expired, Unexpired, Voided, Reactivated.
offsetinteger
Number of transactions to skip (default 0).
locationsstring[]
Filter by location id (GUID); can be specified multiple times.
test_modeboolean
If true, include header x-giftup-testmode: true to use test mode.
eventOccurredOnOrAfterstringdate-time
Include only transactions occurring on or after this UTC datetime.
eventOccurredOnOrBeforestringdate-time
Include only transactions occurring on or before this UTC datetime.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List GiftUp UsersGIFT_UP_LIST_USERSAcción

Tool to list all users. Use when you need to retrieve all users who have access to your Gift Up! account.

Parámetros de entrada

x_giftup_testmodeboolean
If true, call runs against test data where supported
x_giftup_displaynamestring
Overrides display name used in API calls

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Subscribe to WebhookGIFT_UP_SUBSCRIBE_WEBHOOKAcción

Tool to subscribe to a Gift Up! webhook event. Use when you need to register a callback URL for specific account events.

Parámetros de entrada

eventstringObligatorioenum
Type of webhook event to subscribe to. Supported: order-created, gift-card-created, gift-card-updated, gift-card-redeemed.
order-createdgift-card-createdgift-card-updatedgift-card-redeemed
secretstring
Optional secret used to sign webhook requests.
targetUrlstringObligatoriouri
The URL to which Gift Up! will POST webhook events.
isTestModeboolean
If true, only test webhooks will be sent.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not