Create Customer

post

https://open.shopline.io/v1/customers

To create a customer with open API
透過open API創建一筆新的顧客資料

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

excludes[]

array of strings

Exclude certain parameters in the response
結果要排除哪些參數

excludes[]

fields[]

array of strings

Only show certain parameters in the response
結果只顯示哪些參數

fields[]

Body Params

Payload for updating customer

name

string | null

Customer Name
顧客姓名

string

Customer's Email
顧客電子郵件
-
*Customers will receive a requirement to reset password by email after creation.
使用open api Create Customer之後顧客將會收到要求重新設定密碼之email

mobile_phone

string

Customer Mobile Phone, separate by comma if multiple
It has to be used with mobile_phone_country_calling_code 顧客手機, 以逗號分隔, 需與mobile_phone_country_calling_code一同使用

mobile_phone_country_calling_code

string

Country Code of Mobile Phone. It has to be used with mobile_phone
It has to be comply with the "Mobile sign up country" in customer setting 手機號碼國碼, 需與mobile_phone一同使用
號碼所屬國家需符合後台設定的「手機註冊支援國家」

send_notification

boolean

Will send welcome email/sms if True
是否發出歡迎電郵/短訊
--
Default: true

notification_types

array of strings

Email and/or SMS.
SMS can be sent only after enabling feature.
System will try to send both email and SMS if this field is not specified.
電郵及/或短訊。
需開通功能後才能發出短訊。
如漏空，系統會嘗試所有通知方法

notification_types

phones

string

Customer's Phones
顧客電話
-
*Not verified mobile phone number
請注意，非客戶手機驗證電話

phone

string

Customer's Phone
顧客電話
-
*Not verified mobile phone number
請注意，非客戶手機驗證電話

phone_country_code

string

Customer Phone Country Code.
顧客電話國碼

gender

string | null

enum

Customer Gender
顧客性別

Allowed:

birthday

string | null

Customer's birthday
顧客生日

*Will check age limit based on admin setting
將依據後台年齡限制檢查顧客生日

birth_year

integer

Customer's birth year
顧客出生年份
-
*Could not be used with the birthday parameter at the same time.

birth_month

integer

Customer's birth month
顧客出生月份
-
*Could not be used with the birthday parameter at the same time.

birth_day

integer

Customer's birth day
顧客出生日期
-
*Could not be used with the birthday parameter at the same time.

is_member

boolean

Set as True for registered customer
是否為會員？

is_accept_marketing

boolean

Set as True for acceptance of marketing news.
是否接受優惠宣傳？

is_subscribed_marketing_email

boolean

Set as True for acceptance of email marketing news.
是否接受email優惠宣傳？

is_subscribed_marketing_sms

boolean

Set as True for acceptance of sms marketing news.
是否接受sms優惠宣傳？

delivery_addresses

array of objects

Customer's Delivery Address
顧客送貨地址
-
*Maximum for 5 delivery address groups
最多五組

delivery_addresses

is_allow_welcome_credit

boolean

Set as True for sending welcome credit.
是否發送入會購物金

*If welcome credit is enabled at admin panel, welcome credit and notification will be sent when creating customer.
若後台啟用入會購物金功能，建立顧客時會發送入會購物金與通知

Default: false

created_by

string

enum

Creation source
記錄創建來源

Allowed:

created_by_channel_id

string

Creation source id
記錄創建來源的id

registered_by

string

enum

Registration source
會員註冊來源

Allowed:

registered_by_channel_id

string

Registration source id
會員註冊來源的id

memo

string | null

Customer memo
顧客備註

201CREATED

401Bad authentication

403Forbidden

422Unprocessable entity error

500Server error