---
title: "Get Customer Coupon Promotions"
method: GET
path: "/customers/{customer_id}/coupon_promotions"
tags: ["Promotions"]
---

# Get Customer Coupon Promotions

`GET /customers/{customer_id}/coupon_promotions`

To get customer coupon promotions with promotion_ids.<br> The API returns promotions only if the given promotions whose type are draw.<br> And it returns the promotions which are available to draw or have already been drawn.<br> It returns null if the given promotions are not available.<br><br> 使用 promotion_ids 獲取用戶優惠活動。<br> 此 API 只會回傳傳入的 promotion_ids 中，類型為領取型的優惠活動，並僅回傳已領取或可領取的優惠動。<br> 若傳入的 promotion_ids 中有不可領取的優惠活動，則該優惠活動會回傳 null。

## Path parameters

- `customer_id` string, required

## Query parameters

- `promotion_ids` string[], required

## Response `200`

OK

- CustomerCouponPromotions
  - `{promotion_id}` CustomerPromotion
    - `id` string — Promotion ID<br>優惠活動ID
    - `title_translations` object — Title translations <br> 標題翻譯
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `discount_on` 'order' | 'item' | 'category' — Promotion target<br>優惠套用對象<br>-<br>order = Entire shop 全店<br>item = Specific item 指定商品<br>category = Specific category 指定分類
    - `first_purchase_only` boolean — For first purchase only<br>創建自動套用—每位會員限用優惠一次的任選優惠
    - `first_purchase_all_platform` boolean — For first purchase all platform<br>全通路首購
    - `codes` string[] — Coupon Code<br>促銷代碼
    - `user_max_use_count` integer — Limit per member<br>每會員最多使用次數<br>-<br>null = Unlimited 不限使用次數
    - `max_use_count` integer — How many times can this promotion be used?<br>活動限使用次數<br>-<br>null = Unlimited 不限使用次數
    - `use_count` integer — Usage of this layer of promotion<br>本階層活動已使用次數
    - `user_use_count` integer — 用戶活動已使用次數
    - `start_at` string — Promotion start time<br>活動開始時間
    - `end_at` string — Promotion end time<br>活動結束時間<br>-<br>null = no end date 永不過期
    - `available_platforms` string[]
    - `coupon_type` 'draw' | 'single' | 'multi'
    - `drew_coupon_count` integer — How many times did this promotion been drew?<br>活動被領取次數
    - `discount_type` string — discount type of the promotion <br>優惠券的折扣類型
    - `user_coupon_status` 'active' | 'used' | 'inactive' — User Coupon Status, Only expose when coupon_type is draw <br>優惠卷領取狀態，只在領取型優惠卷顯示此欄位 <br>active = 已領取 <br>used = 已使用 <br>inactive = 未領取
    - `available_channel_ids` string[] — Ids of available channel<br>指定通路ids
    - `available_channels` object[] — available channel<br>指定通路
      - `_id` string
      - `name` object — Name translations <br> 名稱翻譯
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `condition_scope` string — Promotion condition scope, Dependent on promotion's conditions, it could be 'discounted_subtotal', 'discounted_products', 'discounted_categories', or empty <br>優惠套用條件

---

[API](https://skmtc.net/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.net/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/revisions/1675ac12cde7/schema)