# 获取优惠券促销活动列表

获取项目的优惠券促销活动列表。

Endpoint: GET /v3/project/{project_id}/admin/coupon
Version: 2.0.0
Security: basicAuth

## Path parameters:

  - `project_id` (integer, required)
    项目ID。您可以在发布商帐户的项目名称旁找到此参数；使用项目时，也可以在浏览器地址栏中找到此参数。URL格式如下：https://publisher.xsolla.com//projects/。
    Example: 44056

## Query parameters:

  - `limit` (integer)
    页面上元素数量的限制。
    Example: 50

  - `offset` (integer)
    生成列表时作为起始位置的元素编号（从0开始计数）。

## Response 200 fields (application/json):

  - `items` (array)

  - `items.external_id` (string)
    唯一促销活动ID。 external_id只能包含大小写英文字母和数字字符、句点、破折号和下划线。

  - `items.promotion_periods` (array)
    促销活动有效期。若指定了多个时间段，则date_from和date_until均为必需。

  - `items.promotion_periods.date_from` (string, required)
    指定促销活动的开始日期。
    Example: "2020-08-11T10:00:00+03:00"

  - `items.promotion_periods.date_until` (string,null)
    促销活动的结束日期。设置为null时，促销活动永久有效。仅在指定单个有效期时可设置为null。
    Example: "2020-08-11T20:00:00+03:00"

  - `items.name` (object)
    促销活动名称。应包含键/值对，
其中键是"^[a-z]{2}-[A-Z]{2}$"格式的区域设置，值是字符串。

  - `items.bonus` (array,null)

  - `items.bonus.sku` (string)
    商品SKU。

  - `items.bonus.quantity` (number)
    商品数量。

  - `items.is_enabled` (boolean)

  - `items.redeem_total_limit` (integer,null)
    限制优惠券的总数。

  - `items.redeem_user_limit` (integer,null)
    限制单个用户兑换的优惠券总数。

  - `items.redeem_code_limit` (integer,null)
    每个代码的核销次数。

  - `items.total_limit_state` (object,null)
    每个唯一优惠券码的限制。

  - `items.total_limit_state.available` (integer)
    优惠券剩余可使用次数。
    Example: 3

  - `items.total_limit_state.reserved` (integer)
    优惠券预留数量。
    Example: 3

  - `items.total_limit_state.used` (integer)
    优惠券被使用的次数。
    Example: 5

  - `items.attribute_conditions` (array)
    用于验证用户属性的条件。根据用户属性是否匹配所有指定条件，确定促销活动是否可用。

  - `total_promotions_count` (integer)
    促销活动总数。

  - `active_promotions_count` (integer)
    进行中的促销活动的数量。

  - `inactive_promotions_count` (integer)
    已停用的促销活动的数量。

## Response 401 fields (application/json):

  - `statusCode` (integer)
    Example: 401

  - `errorCode` (integer)
    Example: 1020

  - `errorMessage` (string)
    Example: "[0401-1020]: Error in Authentication method occurred"