Gift cards - export

The Gift Cards export includes a row for every purchased gift card on your site. Here you can see what gift card amounts are most popular, who is purchasing the most gift cards, who is redeeming gift cards, and what gift cards haven't been redeemed or still have remaining balances. To access the Gift Cards export, visit the Exports page under Reports in your Recurly site.

Date Range Filters

Created

Shows all gift cards purchased during the selected time range. Uses the "created_at" field from this export.

Modified

Shows all gift cards changed during the selected time range. Changes could be triggered by a resent email, edited delivery information, regenerated redemption code, cancelation, redemption, or change in balance. Uses the "updated_at" field from this export.

Redeemed

Shows all gift cards redeemed on an account during the selected time range. Uses the "redeemed_at" field from this export.

Delivered

Shows all gift cards delivered during the selected time range. Delivery indicates the last time Recurly sent the Gift Card Delivery email to the delivery email address. Uses the "delivered_at" field from this export.

Canceled

Show all gift cards canceled during the selected time range. Uses the "canceled_at" field from this export.

Exports table

Download Button Download our complete export schema

To help you identify and organize information effectively, the export provides a structured table that contains the following columns:

ID

Example

Description

Data type (max size)

id

2003020297591186183

The unique ID of the gift card.

string

redemption_code

518822D87268C142

The redemption code, which the recipient uses to redeem the gift card credit.

varchar(255)

amount

50.00

The amount of the gift card.

numeric

balance

40.00

The remaining balance of the gift card. Will be empty if redeemed_at is null. Will be 0.00 if gift card credit has been completely used up.

numeric

currency

USD

The currency of the amount and balance.

varchar(3)

gifter_account_code

3345634

The account code of the gifter's account.

varchar(50)

purchase_invoice_number

1001

The invoice number of the gift card purchase on the gifter's account.

string

purchase_adjustment_uuid

385a6a380e8228b298d8d7414183a8e1

The unique id of the gift card charge on the purchase invoice.

varchar(32)

recipient_account_code

3345700

The account code of the recipient's account.

varchar(50)

recipient_adjustment_uuid

387fbbdcdbd2473d4f6a3e480cb6f966

The unique id of the gift card redemption credit. This is the original gift card credit.

varchar(32)

created_at

2016-09-02 15:53:18 UTC

The date the gift card was purchased by the gifter.

timestamp

updated_at

2016-09-02 15:53:18 UTC

The date the gift card was last modified. Will equal created_at at initial creation.

timestamp

delivered_at

2016-09-02 15:53:18 UTC

The last date Recurly sent the Gift Card Delivery email to the email address in the gift card's delivery information.

timestamp

redeemed_at

2016-09-02 15:53:18 UTC

The date the gift card was redeemed on the recipient's account.

timestamp

canceled_at

2016-09-02 15:53:18 UTC

The date the gift card was canceled. If empty, the gift card has not been canceled.

timestamp

delivery_method

email, post

The method of delivery, either email or post.

varchar(255)

delivery_first_name

John

The first name of the recipient.

varchar(255)

delivery_last_name

Smith

The last name of the recipient.

varchar(255)

delivery_email_address

john@example.com

The email address of the recipient.

varchar(255)

delivery_deliver_at

12/05/2020

Will have a value if a future delivery date was specified. This feature is not yet supported, so it will be empty always.

timestamp

delivery_address1

123 Main Street

The first street address of the recipient.

string

delivery_address2

Apt 100

The second street address of the recipient.

string

delivery_city

San Francisco

The city of the recipient.

string

delivery_state

CA

The state/province of the recipient.

string

delivery_zip

94110

The zip/postal code of the recipient.

string

delivery_country

US

The country of the recipient.

string

delivery_phone

8003334444

The phone number of the recipient.

string

delivery_gifter_name

Sally

The gifter's name, if provided.

varchar(255)

delivery_personal_message

Hi John, Happy Birthday! I hope you have a great day! Love, Sally

The personal message from the gifter to the recipient.

string

redemption_invoice_number

1001

If the Credit Invoices feature is enabled, this is the credit invoice issued when the gift card was redeemed. Credit Invoices is currently in beta. Contact Recurly Support to learn more.

string

gift_card_api_id

e28zov4fw0v2

Gift Card API ID

string

Changelog

Version 2

  • Addition of gift_card_api_id.