Get Gift Card

To get a gift card or list of gift cards, you need to send a GET request to the /api/gifts/gift endpoint.

The request parameters should contain the following:

orderId: The order ID of the gift card. This is an required field of type string.

Example

Here is an example of how you can get a gift card using Roamify Gift Card API.

curl --request GET \
--url 'https://api-dev.getroamify.com/api/gifts/gift?orderId=your-order-id' \
--header 'Authorization: Bearer Access Token' \
--header 'Content-Type: application/json'

Get Gift Cards

To get a list of gift cards, you need to send a GET request to the /api/gifts/gifts endpoint.

There are no required parameters for this endpoint, but you can filter the gift cards based on the following optional parameters:

status: The status of the gift card. This is an optional field of type string. Possible values are NEW, REDEEMED, EXPIRED, VOIDED, REFUNDED, UNKNOWN.

Example

Here is an example of how you can get a list of gift cards using Roamify Gift Card API.

curl --request GET \
--url 'https://api-dev.getroamify.com/api/gifts/gifts?status=NEW' \
--header 'Authorization: Bearer Access Token' \
--header 'Content-Type: application/json'

Revoke Gift Card Health Check