---
title: "cart.giftcard.list"
method: GET
path: "/cart.giftcard.list.json"
tags: ["cart"]
---

# cart.giftcard.list

`GET /cart.giftcard.list.json`

## Request

- Base URL: `https://api.api2cart.com/v1.1`
- URL: `https://api.api2cart.com/v1.1/cart.giftcard.list.json`
- Auth: API key in header `x-api-key` and API key in header `x-store-key`

Get gift cards list.

## Query parameters

- `ids` string
- `start` integer
- `count` integer
- `page_cursor` string
- `store_id` string
- `response_fields` string
- `params` string
- `exclude` string

## Response `200`

successful operation

- ModelResponseCartGiftCardList
  - `return_code` integer, nullable
  - `return_message` string, nullable
  - `pagination` Pagination
    - `previous` string, nullable
    - `next` string, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `result` ResponseCartGiftcardListResult
    - `gift_card` GiftCard[]
      - `id` string
      - `code` string
      - `name` string, nullable
      - `type` string
      - `currency_code` string, nullable
      - `amount` number
      - `initial_amount` number
      - `status` string
      - `created_at` string, nullable
      - `avail_to` string, nullable
      - `free_product_ids` string, nullable
      - `message` string, nullable
      - `issuer_email` string, nullable
      - `recipient_email` string, nullable
      - `issuer_name` string, nullable
      - `recipient_name` string, nullable
      - `usage_history` CouponHistory[]
        - `order_id` string
        - `amount` number
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `additional_fields` object, nullable
      - `custom_fields` object, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `additional_fields` object, nullable
  - `custom_fields` object, nullable

---

[API](https://skmtc.dev/api2cart/apis/api2cart-openapi.md) · [All operations](https://skmtc.dev/api2cart/apis/api2cart-openapi/llms.txt) · [OpenAPI document](https://skmtc.dev/api2cart/apis/api2cart-openapi/revisions/c34440741693?raw)