v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Customers

Get Customers's Membership Info

To get detailed information of the membership of the customers<br> 獲取顧客的會員資料

get/customers/membership_info

Query parameters

pageinteger

Page Number<br>頁數

per_pageinteger

Numbers of records per Page<br>每頁顯示 n 筆資料

customer_ids[]string[]

The result only shows the selected customers<br>結果只顯示指定的顧客群

[
  "61ee33cfc15d41002b4bdb72"
]

Response

OK

Example response

{
  "items": [
    {
      "id": "5de6192b9a8b7900365abb5b",
      "membership_tier": {
        "_id": "5de6192b9a8b7900365abb5b",
        "level": 2,
        "name_translations": {
          "zh-hant": "山竹會員"
        },
        "merchant_id": "611cd8ade0f510001e130048",
        "promotion_count": 1,
        "valid_period": {
          "type": "unlimited",
          "time_unit": "month"
        },
        "membership_tier_rules": [
          {
            "id": "61653d1ce250830024bc53de",
            "effect_type": "upgrade",
            "condition_interval": {
              "type": "single_purchase",
              "time_unit": "month",
              "time_value": 12
            },
            "effect_interval": {
              "type": "unlimited",
              "time_unit": "month",
              "time_value": 12
            },
            "total_spending": {
              "cents": 110,
              "currency_symbol": "HK$",
              "currency_iso": "HKD",
              "label": "HK$1.10",
              "dollars": 1.1
            },
            "created_at": "2021-10-12T07:45:32.383Z",
            "updated_at": "2021-10-12T07:45:32.383Z"
          }
        ]
      },
      "tier_expires_at": "2018-07-05T02:44:59.596+00:00",
      "membership_tier_gap": {
        "next_tier": {
          "id": "5de6192b9a8b7900365abb5b",
          "level": 2,
          "name_translations": {
            "zh-hant": "山竹會員"
          },
          "membership_tier_rules": [
            {
              "id": "61653d1ce250830024bc53de",
              "effect_type": "upgrade",
              "condition_interval": {
                "type": "single_purchase",
                "time_unit": "month",
                "time_value": 12
              },
              "effect_interval": {
                "type": "unlimited",
                "time_unit": "month",
                "time_value": 12
              },
              "total_spending": {
                "cents": 110,
                "currency_symbol": "HK$",
                "currency_iso": "HKD",
                "label": "HK$1.10",
                "dollars": 1.1
              },
              "created_at": "2021-10-12T07:45:32.383Z",
              "updated_at": "2021-10-12T07:45:32.383Z"
            }
          ]
        }
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 1,
    "total_pages": 1
  }
}