Gift Up

Gift Up integration (Finance, Marketing). Imported from open-connector.

API key17 toolshttps://api.giftup.app

GET

gift_up_get_company

Get the Gift Up company associated with the API key.

/company

GET

gift_up_list_gift_cards

List Gift Up gift cards with optional filters.

/gift-cards

10 parameters

Param	Type	Required	Description
status	string	optional	Only include gift cards in this state.
createdOnOrAfter	string	optional	Only include gift cards created on or after this datetime. Gift Up accepts date…
updatedOnOrAfter	string	optional	Only include gift cards updated on or after this datetime. Gift Up accepts date…
orderId	string	optional	The Gift Up object ID.
sku	string	optional	Only include gift cards with this SKU.
recipientEmail	string	optional	Only include gift cards for this recipient email address.
purchaserEmail	string	optional	Only include gift cards for this purchaser email address.
paymentTransactionId	string	optional	Only include gift cards with this payment provider transaction ID.
limit	integer	optional	The maximum number of objects to return.
offset	integer	optional	The number of objects to skip.

GET

gift_up_get_gift_card

Get one Gift Up gift card by code.

/gift-cards/{code}

1 parameter

Param	Type	Required	Description
code	string	required	The Gift Up gift card code.

POST

gift_up_reactivate_gift_card

Reactivate a voided Gift Up gift card.

/gift-cards/{code}/reactivate

4 parameters

Param	Type	Required	Description
code	string	required	The Gift Up gift card code.
reason	string	optional	The reason to record in the Gift Up history log.
locationId	string	optional	The Gift Up location ID where the event occurred.
metadata	object	optional	Metadata key-value pairs to attach to the Gift Up event.

POST

gift_up_void_gift_card

Void a Gift Up gift card so it can no longer be redeemed.

/gift-cards/{code}/void

4 parameters

Param	Type	Required	Description
code	string	required	The Gift Up gift card code.
reason	string	optional	The reason to record in the Gift Up history log.
locationId	string	optional	The Gift Up location ID where the event occurred.
metadata	object	optional	Metadata key-value pairs to attach to the Gift Up event.

POST

gift_up_top_up_gift_card

Add currency amount or units to a Gift Up gift card.

/gift-cards/{code}/top-up

6 parameters

Param	Type	Required	Description
code	string	required	The Gift Up gift card code.
amount	number	optional	The currency amount for a currency-backed gift card.
units	integer	optional	The unit quantity for a units-backed gift card.
reason	string	optional	The reason to record in the Gift Up history log.
locationId	string	optional	The Gift Up location ID where the event occurred.
metadata	object	optional	Metadata key-value pairs to attach to the Gift Up event.

POST

gift_up_redeem_gift_card

Redeem a currency amount or units from a Gift Up gift card.

/gift-cards/{code}/redeem

7 parameters

Param	Type	Required	Description
code	string	required	The Gift Up gift card code.
amount	number	optional	The currency amount for a currency-backed gift card.
units	integer	optional	The unit quantity for a units-backed gift card.
reason	string	optional	The reason to record in the Gift Up history log.
locationId	string	optional	The Gift Up location ID where the event occurred.
metadata	object	optional	Metadata key-value pairs to attach to the Gift Up event.
redeemedOn	string	optional	The datetime when the redemption occurred. Gift Up accepts date or datetime str…

POST

gift_up_redeem_gift_card_in_full

Redeem all remaining balance from a Gift Up gift card.

/gift-cards/{code}/redeem-in-full

5 parameters

Param	Type	Required	Description
code	string	required	The Gift Up gift card code.
reason	string	optional	The reason to record in the Gift Up history log.
locationId	string	optional	The Gift Up location ID where the event occurred.
metadata	object	optional	Metadata key-value pairs to attach to the Gift Up event.
redeemedOn	string	optional	The datetime when the redemption occurred. Gift Up accepts date or datetime str…

POST

gift_up_undo_gift_card_redemption

Undo a previous Gift Up gift card redemption transaction.

/gift-cards/{code}/undo-redemption

4 parameters

Param	Type	Required	Description
code	string	required	The Gift Up gift card code.
transactionId	string	required	The Gift Up object ID.
reason	string	optional	The reason to record in the Gift Up history log.
metadata	object	optional	Metadata key-value pairs to attach to the Gift Up event.

GET

gift_up_list_items

List Gift Up items, optionally filtered by item group.

/items

1 parameter

Param	Type	Required	Description
groupId	string	optional	The Gift Up object ID.

GET

gift_up_get_item

Get one Gift Up item by ID.

/items/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The Gift Up object ID.

GET

gift_up_list_orders

List Gift Up orders with optional filters.

/orders

5 parameters

Param	Type	Required	Description
createdOnOrAfter	string	optional	Only include orders created on or after this datetime. Gift Up accepts date or …
purchaserEmail	string	optional	Only include orders for this purchaser email address.
source	string	optional	Only include orders from this source.
limit	integer	optional	The maximum number of objects to return.
offset	integer	optional	The number of objects to skip.

GET

gift_up_get_order

Get one Gift Up order by ID or order number.

/orders/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The Gift Up order ID or order number.

GET

gift_up_list_locations

List Gift Up account locations.

/locations

GET

gift_up_list_promotions

List Gift Up promotions.

/promotions

GET

gift_up_list_report_transactions

List Gift Up report transactions with optional filters.

/reports/transactions

8 parameters

Param	Type	Required	Description
eventOccurredOnOrAfter	string	optional	Only include transactions that occurred on or after this datetime. Gift Up acce…
eventOccurredOnOrBefore	string	optional	Only include transactions that occurred on or before this datetime. Gift Up acc…
events	array	optional	Only include transactions for these Gift Up event types.
users	array	optional	Only include transactions generated by these user email addresses.
locations	array	optional	Only include transactions generated at these location IDs.
code	string	optional	The Gift Up gift card code.
limit	integer	optional	The maximum number of objects to return.
offset	integer	optional	The number of objects to skip.

GET

gift_up_get_report_transaction

Get one Gift Up report transaction by ID.

/reports/transactions/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The Gift Up object ID.