v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB

Promotions

Get Customer Promotions

To get customer promotions<br>取得用戶優惠活動

get/customers/{customer_id}/promotions

Path parameters

customer_idstring required

用戶id

Query parameters

coupon_status'valid' | 'invalid' | 'comingSoon'

優惠券狀態

available_platformsstring[]

優惠券適用渠道

coupon_typestring[]

優惠券形式

Response

Example response

{
  "items": [
    {
      "id": "5e8445bcca53240021eab706",
      "discount_on": "order",
      "first_purchase_only": true,
      "codes": [
        "VIP001",
        "VIP002"
      ],
      "user_max_use_count": 1,
      "max_use_count": 20,
      "use_count": 5,
      "user_use_count": 5,
      "start_at": "2020-07-09T04:00:00.000+00:00",
      "end_at": "null",
      "coupon_type": "draw",
      "drew_coupon_count": 20,
      "discount_type": "gift",
      "user_coupon_status": "active",
      "available_channel_ids": [
        "5e8420f2ad0fba0015406e56",
        "5e8420b54c61c3001ea5155c"
      ],
      "available_channels": [
        {
          "_id": "612ca19087ce190044574691",
          "name": {
            "en": "POS-001",
            "zh-hant": "POS-001"
          }
        }
      ],
      "condition_scope": "discounted_subtotal"
    }
  ]
}