---
title: "List all gift cards"
method: POST
path: "/giftcards/_search"
tags: ["Gift Card"]
---

# List all gift cards

`POST /giftcards/_search`

Returns a list of all gift cards available for a specific customer's cart.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| GiftCard | GiftCard | **Gift card full access** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Headers

- `Content-Type` string, required
- `Accept` string, required
- `REST-Range` string

## Request body

- GetGiftCardusingJSONRequest — Gift card information.
  - `cart` Cart, required — Cart information.
    - `grandTotal` integer, required — Total payment value.
    - `relationName` string, nullable, required — Represents the relationship between the client and the store.
    - `redemptionCode` string, required — Gift card identification code used at checkout. Minimum of 6 characters.
    - `discounts` integer, required — Discounts value.
    - `shipping` integer, required — Shipping value.
    - `taxes` integer, required — Taxes value.
    - `items` Item[], required — Items information.
      - `productId` string, required — Product ID.
      - `id` string, required — The ID of the SKU in VTEX platform.
      - `refId` string, required — Product Reference ID.
      - `name` string, required — Product name.
      - `price` integer, required — Product price.
      - `quantity` integer, required — Product quantity.
    - `itemsTotal` integer, required — Total items value.
  - `client` Client, required — Client information.
    - `id` string, required — Customer's identification.
    - `email` string, required — Customer's email address.
    - `document` string, required — Document number informed by the customer.

## Response `200`

OK

- Response2 — Items information.
  - `items` Item1[], required — Items information.
    - `id` string, required — Item identification.
    - `_self` Self, required — Object that carries an auto reference of the transaction (on its API).
      - `href` string, required — Gift card resource URL. The first number described in the URL refers to the gift card identification. The second number, refers to the transaction identification.
  - `paging` Paging, required — Paging information.
    - `page` integer, required — Page number of the gift card list.
    - `perPage` integer, required — Quantity of gift cards per page.
    - `total` integer, required — Total of gift cards in the store.
    - `pages` integer, required — Total number of pages.

## Changes

- **2023-09-27** `7e6920bdee2e` — 2 info
  - the `` request property default value `{"productId":"2000000","id":"2000002","refId":"MEV41","name":"Shoes","price":200,"quantity":1}` was removed
  - the `cart` request property default value `{"grandTotal":182,"relationName":null,"redemptionCode":"XTYB","discounts":20,"shipping":2,"taxes":0,"items":[{"productId":"2000000","id":"2000002","refId":"MEV41","name":null,"price":200,"quantity":1}],"itemsTotal":200}` was removed
- **2023-08-31** `4be9fbcceb62` — 1 info
  - the `redemptionCode` request property default value `AH52F7` was removed
- **2023-08-30** `0af884ae7f9e` — 5 breaking, 8 info
  - the request property `cart/items/items/name` became not nullable
  - the `paging/page` response's property type/format changed from `integer`/`int32` to `integer`/`` for status `200`
  - the `paging/pages` response's property type/format changed from `integer`/`int32` to `integer`/`` for status `200`
  - the `paging/perPage` response's property type/format changed from `integer`/`int32` to `integer`/`` for status `200`
  - …9 more
- …earlier changes not shown

[Full history](https://skmtc.dev/vtex/apis/giftcard-api/changes/giftcards/_search/post.md)

---

[API](https://skmtc.dev/vtex/apis/giftcard-api.md) · [All operations](https://skmtc.dev/vtex/apis/giftcard-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/giftcard-api/revisions/108d07014ee3/schema)