Sign in

v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Customers

Get Customers

To get detailed information of couple customers sorted by time<br>利用時間範圍選取與排序獲取數筆顧客資料

get/customers

Query parameters

updated_afterstring

Filter data by those updated after specific time.<br>取得 updated_at 大於指定時間的顧客(包含指定時間)<br> *Should use UTC time

updated_beforestring

Filter data by those updated before specific time.<br>取得 updated_at 小於指定時間的顧客(包含指定時間)<br> *Should use UTC time

created_afterstring

Filter data by those created after specific time.<br>取得 created_at 大於指定時間的顧客(包含指定時間)<br> *Should use UTC time

created_beforestring

Filter data by those created before specific time.<br>取得 created_at 小於指定時間的顧客(包含指定時間)<br> *Should use UTC time

pageinteger

Page Number<br>頁數

per_pageinteger

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

sort_by'asc' | 'desc'

Setting sort by created time<br>設定創建時間排序

previous_idstring

Customer id before the first record of the target records as pagination cursor<br> 目標資料的第一個顧客的前一個顧客ID，同作分頁標記。<br> * If "previous_id" is provided, this operation will ignore "page" param. <br> * 如果使用param "previous_id"，這次操作會忽略param "page"

include_fields[]string[]

Provide additional attributes in the response<br>結果添加哪些參數

fields[]string[]

Only show certain parameters in the response<br> This field will have conflicts to the include_fields[]<br> To avoid the conflicts<br> please also input all the items included in the include_fields[] to this field<br> otherwise those fields will not be shown<br> 結果只顯示哪些參數<br> 這個欄位會跟include_fields[]的欄位有衝突<br> 要避免衝突的話，請輸入所有也包括在include_fields[]內的項目<br> 否則那些項目將不能被顯示

[
  "items.id"
]

Response

OK

Example response

{
  "items": [
    {
      "id": "5ce0d084e388096bdb229a59",
      "name": "Shopline User",
      "email": "rich+2019@shopline.com",
      "gender": "male",
      "birthday": "2013-06-01",
      "birth_year": 2013,
      "birth_month": 6,
      "birth_day": 2,
      "memo": "高級客戶",
      "phones": [],
      "phone": "0910000123",
      "phone_country_code": "886",
      "mobile_phone": "0910000123",
      "mobile_phone_verified": true,
      "mobile_phone_country_calling_code": "886",
      "locale_code": "zh-hant",
      "order_count": 1,
      "orders_total_sum": {
        "cents": 999999999,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$999,999,999",
        "dollars": 999999999
      },
      "is_member": true,
      "is_subscribed_marketing_email": true,
      "credit_balance": 500,
      "member_point_balance": 30,
      "custom_data": [
        {
          "type": "text",
          "name_translations": {
            "zh-hant": "測試欄位",
            "en": "Test Field"
          },
          "field_id": "5ad86757e38809441400001b",
          "value": "Test Field Value"
        }
      ],
      "membership_tier": {
        "id": "5de6192b9a8b7900365abb5b",
        "level": 2,
        "name_translations": {
          "zh-hant": "山竹會員"
        },
        "status": "active"
      },
      "delivery_addresses": [],
      "subscribed_email_types": [
        "marketing.news"
      ],
      "ref_user_id": "SL001",
      "line_id": "null",
      "facebook_id": "null",
      "google_id": "null",
      "updated_at": "2018-07-31T03:57:36.409+00:00",
      "created_at": "2018-01-10T06:33:45.231+00:00",
      "current_sign_in_at": "2018-07-31T03:49:52.725+00:00",
      "last_sign_in_at": "2018-04-02T04:02:23.391+00:00",
      "registered_at": "2018-01-10T06:33:45.231+00:00",
      "registered_from_channel": {
        "id": "5ce0d084e388096bdb229a59",
        "updated_at": "2018-07-31T03:57:36.409+00:00",
        "created_at": "2018-07-31T03:57:36.409+00:00",
        "default_warehouse_id": "5ce0d084e388096bdb229a59",
        "identifier": "00222333",
        "phones": {
          "main": "0912345678"
        },
        "address": {
          "address_1": "1/F, Some Building",
          "city": "City",
          "state": "Perak",
          "postcode": "36500",
          "country": "Malaysia",
          "country_code": "MY"
        },
        "pin_codes": [
          {
            "scope": "switch_store"
          }
        ],
        "e_invoice_setting": {
          "invoice_type": "none"
        }
      },
      "tags": [
        "Tag A",
        "Tag B"
      ],
      "tier_expires_at": "2021-12-18T15:59:59.999+00:00",
      "confirmed_at": "2021-12-06T02:37:06.363+00:00",
      "utm_data": {
        "utm_source": "google",
        "utm_campaign": "spring_sale",
        "utm_medium": "cpc",
        "utm_content": "logolink",
        "utm_term": "running+shoes"
      },
      "offline_referral_registered_at": "2021-12-06T02:37:06.363+00:00",
      "offline_referral_channel_id": "5de6192b9a8b7900365abb5b",
      "offline_referral_agent_id": "5de6192b9a8b7900365abb5b",
      "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"
            }
          ]
        }
      },
      "current_membership_tier_info": {
        "_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"
          }
        ]
      },
      "metafields": {
        "namespace": {
          "key1": "value",
          "key2": 3,
          "key3": {
            "json": "object"
          }
        }
      },
      "customer_authentication_linkings": [
        {
          "_id": "6360c5e74835a50010314af9",
          "created_at": "2022-11-01T07:08:23.185Z",
          "customer_authentication_id": "6050398ea3546c0032a7ed32",
          "merchant_id": "6037452b4bf8b200305d7ed6",
          "platform": null,
          "ref_id": "739790",
          "ref_info": {
            "wmid": "739790",
            "email": "lowdown0619@gmail.com ",
            "name": "lowdown0619",
            "profile": "womany member"
          },
          "status": "active",
          "updated_at": "2022-11-01T07:08:23.185Z",
          "user_id": "6360c5e6b2c2bb0012d3e2a5"
        }
      ],
      "subscriptions": [
        {
          "platform": "sms"
        }
      ],
      "orders_totals": [
        {
          "id": "59e97965e388095314000010",
          "total": {
            "cents": 999999999,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "NT$999,999,999",
            "dollars": 999999999
          },
          "platform": "mc"
        }
      ],
      "member_info_reward": {
        "custom_fields": [
          {
            "name_translations": {
              "zh-hant": "LINE ID"
            },
            "member_info_reward": true,
            "field_id": "64250e522e1b87003ed0286f"
          }
        ],
        "reward_on": [
          "name",
          "email",
          "mobile_phone",
          "gender",
          "birthday"
        ],
        "promotion_ids": [
          "promotion_id_1",
          "promotion_id_2"
        ],
        "user_credits": 20,
        "member_points": 100
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 1,
    "total_pages": 1
  }
}