Customer editing
Event Group | Event Identification |
---|---|
customers | customers/update |
Customer update
Request Headers
- X-Shopline-Topic string requiredEvent operation identificationExample:
orders/edited
- X-Shopline-Hmac-Sha256 string requiredSignatureExample:
XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
- X-Shopline-Shop-Domain string requiredShop domainExample:
shophub.myshopline.com
- X-Shopline-Shop-Id string requiredShop IDExample:
1610418123456
- X-Shopline-Merchant-Id string requiredMerchant IDExample:
2000001234
- X-Shopline-API-Version string requiredVersionExample:
v20210901
- X-Shopline-Webhook-Id string requiredMessage IDExample:
b54557e48a5fbf7d70bcd043
Request Body
- accepts_marketing booleanSubscription mail or notExample:
true
- accepts_marketing_updated_at stringMailbox subscription timeExample:
2022-12-16T11:06:11+08:00
- accepts_mobile_marketing booleanAccept telemarketing or notExample:
true
- accepts_mobile_marketing_updated_at stringTelephone subscription time (see IOS8601 for the format)Example:
2022-12-16T11:06:11+08:00
addressesobject[]
Address information listaddress1 stringAddress 1Example:7720 Cherokee Road
address2 stringAddress 2Example:Apartment
city stringCityExample:Hagerman
company stringCompanyExample:Joy
country stringCountryExample:United States
country_code stringCountry codeExample:US
customer_id stringCustomer idExample:200093842
default booleanDefault address or notExample:true
first_name stringNameExample:Bob
id stringAddress IDExample:SL201UA5006511321220969539
last_name stringLast nameExample:James
phone stringPhone numberExample:008613978653472
province stringProvinceExample:Kentucky
province_code stringProvincial encodingExample:KY
zip stringZip codeExample:40202
- asid stringFB login IDExample:
542132312312323
- birthday stringCustomer birthday Format: YYYYMMDDExample:
19900625
- created_at stringCreation timeExample:
2022-12-16T11:06:11+08:00
- currency stringCurrencyExample:
CNY
default_addressobject
Default addressaddress1 stringAddress 1Example:7720 Cherokee Road
address2 stringAddress 2Example:Apartment
city stringCityExample:Hagerman
company stringCompanyExample:Joy
country stringCountryExample:United States
country_code stringCountry codeExample:US
customer_id stringCustomer idExample:200838473
default booleanDefault address or notExample:true
first_name stringNameExample:Bob
id stringAddress IDExample:SL201UA5006511321220969539
last_name stringLast nameExample:James
phone stringPhone numberExample:008613965748321
province stringProvinceExample:Kentucky
province_code stringProvincial encodingExample:KY
zip stringZip codeExample:40202
- email stringMailboxExample:
gungcherny@gamil.com
email_marketing_consentobject
E-mail marketing subscription informationconsent_collected_from stringSubscription information sourceExample:Subscription information source
consent_updated_at stringSubscription change timeExample:2022-12-16T11:06:11+08:00
opt_in_level integerSubscription method ( 0 : unknown ; 1 : single_opt_in ; 2 : confirmed_opt_in )Example:2
state integerSubscription status ( 0 : cancelled subscription ; 1 : on subscription ; 2 : not on subscription ; 3 : on-subscription confirmation )Example:2
- email_subscribe_flag integerMailbox subscription status 0 : cancelled subscription , 1 : already available , 2 : not availableExample:
2
- first_name stringNameExample:
Bob
- gender stringGender : male / female / others/secretExample:
male
- id stringCustomer idExample:
231321312321
- language stringCustomer languageExample:
en
- last_name stringLast nameExample:
James
- last_order_id stringRecent order numberExample:
200832869120938
- mobile_subscribe_flag integerMobile phone subscription status 0 : cancelled subscription , 1 : already available , 2 : not availableExample:
2
- multipass_identifier stringMultipass logoExample:
multipass_identifier
- nick_name stringUser nicknameExample:
Bob James
- note stringNotesExample:
test
- orders_count longOrder quantityExample:
4223
- phone stringPhone numberExample:
008613987864352
sms_marketing_consentobject
Sms marketing subscription informationconsent_collected_from stringSubscription information sourceExample:Subscription information source
consent_updated_at stringSubscription change timeExample:2022-12-16T11:06:11+08:00
opt_in_level integerSubscription method ( 0 : unknown ; 1 : single_opt_in ; 2 : confirmed_opt_in )Example:1
state integerSubscription status ( 0 : cancelled subscription ; 1 : on subscription ; 2 : not availableExample:1
- social_customer stringSocial media user IDExample:
43245645353245
- state integerCustomer status [ 0 : disabled account , 1 : to enable account , 2 : invited account , 3 : valid account ]Example:
2
- tags stringCustomer tagExample:
good
- total_spent stringTotal cost amountExample:
324324
- updated_at stringUpdate timeExample:
2022-12-16T11:06:11+08:00
- verified_email booleanVerify if e-mail or notExample:
true
Response
After receiving a webhook notification from SHOPLINE, you must respond with the following format:
HTTP/1.1 200 OK
For more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.
Was this article helpful to you?