<- Payments API

Payments API

List gift card activities

GET

 /v2/gift-cards/activities

Lists gift card activities.

By default, you get gift card activities for all gift cards in the seller's account. You can optionally specify query parameters to filter the list. For example, you can get a list of gift card activities for a gift card, for all gift cards in a specific region, or for activities within a time window.

Permissions:GIFTCARDS_READ

Guide

List gift card activities

Try in API Explorer
Link to section

Query parameters

Example code

Link to section

gift_card_id

string

If a gift card ID is provided, the endpoint returns activities related to the specified gift card. Otherwise, the endpoint returns all gift card activities for the seller.

Link to section

type

string

If a type is provided, the endpoint returns gift card activities of the specified type. Otherwise, the endpoint returns all types of gift card activities.

Link to section

location_id

string

If a location ID is provided, the endpoint returns gift card activities for the specified location. Otherwise, the endpoint returns gift card activities for all locations.

Link to section

begin_time

string

The timestamp for the beginning of the reporting period, in RFC 3339 format. This start time is inclusive. The default value is the current time minus one year.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

end_time

string

The timestamp for the end of the reporting period, in RFC 3339 format. This end time is inclusive. The default value is the current time.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

limit

integer(32-bit)

If a limit is provided, the endpoint returns the specified number of results (or fewer) per page. The maximum value is 100. The default value is 50. For more information, see Pagination.

Link to section

cursor

string

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see Pagination.

Link to section

sort_order

string

The order in which the endpoint returns the activities, based on created_at.

  • ASC - Oldest to newest.
  • DESC - Newest to oldest (default).
Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

gift_card_activities

The requested gift card activities or an empty object if none are found.

Link to section

cursor

string

When a response is truncated, it includes a cursor that you can use in a subsequent request to retrieve the next set of activities. If a cursor is not present, this is the final response. For more information, see Pagination.