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

# cart.coupon.list

`GET /cart.coupon.list.json`

## Request

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

Get cart coupon discounts.

## Query parameters

- `start` integer
- `count` integer
- `page_cursor` string
- `coupons_ids` string
- `store_id` string
- `lang_id` string
- `avail` boolean
- `status` string
- `date_start_from` string
- `date_start_to` string
- `date_end_from` string
- `date_end_to` string
- `response_fields` string
- `params` string
- `exclude` string

## Response `200`

successful operation

- ModelResponseCartCouponList
  - `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` ResponseCartCouponListResult
    - `coupon_count` integer, nullable
    - `coupon` Coupon[]
      - `id` string
      - `code` string, nullable
      - `codes` CouponCode[]
        - `id` string
        - `code` string
        - `used_times` integer, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `name` string, nullable
      - `description` string, nullable
      - `actions` CouponAction[]
        - `scope` string
        - `apply_to` string
        - `amount` number
        - `currency_code` string, nullable
        - `include_tax` boolean, nullable
        - `type` string
        - `discounted_quantity` number, nullable
        - `discount_quantity_step` integer, nullable
        - `logic_operator` string, nullable
        - `conditions` CouponCondition[]
          - `id` string
          - `entity` string
          - `match_items` string, nullable
          - `key` string, nullable
          - `operator` string, nullable
          - `value` string, nullable
          - `logic_operator` string, nullable
          - `sub-conditions` CouponCondition[]
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `date_start` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `date_end` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `avail` boolean, nullable
      - `priority` integer, nullable
      - `used_times` integer, nullable
      - `usage_limit` integer, nullable
      - `usage_limit_per_customer` integer, nullable
      - `logic_operator` string, nullable
      - `conditions` CouponCondition[]
        - `id` string
        - `entity` string
        - `match_items` string, nullable
        - `key` string, nullable
        - `operator` string, nullable
        - `value` string, nullable
        - `logic_operator` string, nullable
        - `sub-conditions` CouponCondition[]
        - `additional_fields` object, nullable
        - `custom_fields` object, 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)