Customer subscription

Event Group	Event Identification
customers_marketing_consent	customers_marketing_consent/update

Request Headers

X-Shopline-Topic string required

The unique identifier for the event.

Example: orders/edited
X-Shopline-Hmac-Sha256 string required

The signature of the request. Upon receiving the request, you must verify the signature to confirm the authenticity and integrity of the data.

Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
X-Shopline-Shop-Domain string required

The store domain.

Example: example.myshopline.com
X-Shopline-Shop-Id string required

The store ID.

Example: 1610418123456
X-Shopline-Merchant-Id string required

The merchant ID.

Example: 2000001234
X-Shopline-API-Version string required

The API version.

Example: v20250601
X-Shopline-Webhook-Id string required

The ID of this Webhook event.

Example: b54557e48a5fbf7d70bcd043

Request Body

accepts_marketing boolean

Subscription mail or not
Example: true
accepts_marketing_updated_at string

Mailbox subscription time
Example: 2022-12-16T11:06:11+08:00
accepts_mobile_marketing boolean

Accept telemarketing or not
Example: true
accepts_mobile_marketing_updated_at string

Telephone subscription time (see IOS8601 for the format)
Example: 2022-12-16T11:06:11+08:00
addressesobject[]

Address information list
address1 string

Address 1
Example: 7720 Cherokee Road
address2 string

Address 2
Example: 22 Street
city string

City
Example: Hagerman
company string

Company
Example: Joy
country string

Country
Example: United States
country_code string

Country code
Example: US
customer_id string

Customer id
Example: 2004324532
default boolean

Default address or not
Example: true
first_name string

Name
Example: wude
id string

Address ID
Example: SL201342344234525
last_name string

Last name
Example: James
phone string

Phone number
Example: 008615098695473
province string

Province
Example: Kentucky
province_code string

Provincial encoding
Example: KY
zip string

Zip code
Example: 40202
asid string

FB login ID
Example: 456542342
birthday string

Customer birthday Format: YYYYMMDD
Example: 19930426
created_at string

Creation time
Example: 2022-12-16T11:06:11+08:00
currency string

Currency
Example: CNY
default_addressobject

Default address
address1 string

Address 1
Example: 7720 Cherokee Road
address2 string

Address 2
Example: 22 Street
city string

City
Example: Hagerman
company string

Company
Example: Joy
country string

Country
Example: United States
country_code string

Country code
Example: US
customer_id string

Customer id
Example: 20024344
default boolean

Default address or not
Example: true
first_name string

Name
Example: Bob
id string

Address ID
Example: SL201UA5006511321220969539
last_name string

Last name
Example: James
phone string

Phone number
Example: 008613923874352
province string

Province
Example: Kentucky
province_code string

Provincial encoding
Example: KY
zip string

Zip code
Example: 40202
email string

Mailbox
Example: gungcherny@gamil.com
email_marketing_consentobject

E-mail marketing subscription information
consent_collected_from string

Subscription information source
Example: consent_collected_from
consent_updated_at string

Subscription change time
Example: 2022-12-16T11:06:11+08:00
opt_in_level integer

Subscription method ( 0 : unknown ; 1 : single_opt_in ; 2 : confirmed_opt_in )
Example: 1
state integer

Subscription status ( 0 : cancelled subscription ; 1 : on subscription ; 2 : not on subscription ; 3 : on-subscription confirmation )
Example: 1
email_subscribe_flag integer

Mailbox subscription status 0 : cancelled subscription , 1 : already available , 2 : not available
Example: 1
first_name string

Name
Example: wude
gender string

Gender : male / female / others/secret
Example: male
id string

Customer id
Example: 2003242345
language string

Customer language
Example: en
last_name string

Last name
Example: James
last_order_id string

Recent order number
Example: 2007732692139103132
mobile_subscribe_flag integer

Mobile phone subscription status 0 : cancelled subscription , 1 : already available , 2 : not available
Example: 1
multipass_identifier string

Multipass logo
Example: multipass_identifier
nick_name string

User nickname
Example: Bob James
note string

Notes
Example: high spent customer
orders_count long

Order quantity
Example: 4
phone string

Phone number
Example: 008615087594362
sms_marketing_consentobject

Sms marketing subscription information
consent_collected_from string

Subscription information source
Example: consent_collected_from
consent_updated_at string

Subscription change time
Example: 2022-12-16T11:06:11+08:00
opt_in_level integer

Subscription method ( 0 : unknown ; 1 : single_opt_in ; 2 : confirmed_opt_in )
Example: 1
state integer

Subscription status ( 0 : cancelled subscription ; 1 : on subscription ; 2 : not available
Example: 1
social_customer string

Social media user ID
Example: 62384242394395
state string

Customer status [ 0 : disabled account , 1 : to enable account , 2 : invited account , 3 : valid account ]
Example: 2
subscribeActionType integer

Subscription behavior 1 , mailbox subscription ; 2 , sms subscription ; 3 , cancelled mailbox subscription ; 4 , cancelled text message subscription
Example: 1
tags string

Customer tag
Example: test
total_spent string

Total cost amount
Example: 3243
updated_at string

Update time
Example: 2022-12-16T11:06:11+08:00
verified_email boolean

Verify if e-mail or not
Example: true

Status Codes

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?

SHOPLINE

Legal