Customer created

Event GroupEvent Identification
customerscustomers/create
Occurs whenever a customer is created.
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • 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
    Whether the customer accepts subscribing to marketing information via email.
    • true: Accepts
    • false: Does not accept
    DEPRECATED
    This parameter is deprecated from API version v20250601.
  • accepts_marketing_updated_at string
    The date and time when the customer's subscription status for email marketing was last updated. Format: ISO 8601.
    DEPRECATED
    This parameter is deprecated from API version v20250601.
    Example: 2022-12-16T11:06:11+08:00
  • accepts_mobile_marketing boolean
    Whether the customer accepts subscribing to marketing information via SMS.
    • true: Accepts
    • false: Does not accept
    DEPRECATED
    This parameter is deprecated from API version v20250601.
  • accepts_mobile_marketing_updated_at string
    The date and time when the customer's subscription status for SMS marketing was last updated. Format: ISO 8601.
    DEPRECATED
    This parameter is deprecated from API version v20250601.
    Example: 2022-12-16T11:06:11+08:00
  • addressesobject[]
    A list of customer addresses.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
    Example: 7720 Cherokee Road
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
    Example: Apartment 2
  • city string
    The city in the address.
    Example: Hagerman
  • company string
    The customer's company.
  • country string
    The country or region in the address.
    Example: United States
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 (alpha 2) standard, used to identify a specific country or region in the address.
    Example: US
  • customer_id string
    The unique identifier for the customer.
    Example: 2007347234
  • default boolean
    Whether the address is set as the default address.
    • true: Set as the default address.
    • false: Not set as the default address.
  • first_name string
    The customer's first name.
    Example: Bob
  • id string
    The unique identifier for the address.
    Example: SL201UA4840334721187149827
  • last_name string
    The customer's last name.
    Example: James
  • phone string
    The customer's mobile phone number.
    Example: 008613987985473
  • province string
    The province or state in the address.
    Example: Kentucky
  • province_code string
    The code for the province or state, represented by a custom code or the portion after the hyphen (-) in the ISO 3166-2 code. For example, RI in US-RI or ENG in GB-ENG.
  • zip string
    The postal code information of the address.
    Example: 40202
  • asid string
    The unique app-scoped user identifier provided after the customer logs in via Facebook.
  • attributesobject[]
    Additional customer information (formatted as key-value pairs) collected during registration.
  • key string
    The key or name of the attribute.
    Example: plugin.membership.invite_code
  • value string
    The value of the attribute.
    Example: WELCOME
  • birthday string
    The customer's birthday. Format: yyyyMMdd.
    Example: 20210831
  • created_at string
    The date and time when the customer was created. Format: ISO 8601.
    Example: 2022-12-16T11:06:11+08:00
  • currency string
    The currency used by the customer to place an order. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • default_addressobject
    The default address.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
    Example: 7720 Cherokee Road
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
    Example: Apartment 2
  • city string
    The city in the address.
    Example: Hagerman
  • company string
    The company name.
    Example: Joy
  • country string
    The country or region in the address.
    Example: United States
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 (alpha 2) standard, used to identify a specific country or region in the address.
    Example: US
  • customer_id string
    The unique identifier for the customer.
    Example: 2007347234
  • default boolean
    Whether the address is set as the default address.
    • true: Set as the default address.
    • false: Not set as the default address.
  • first_name string
    The customer's first name.
    Example: Bob
  • id string
    The unique identifier for the address.
    Example: SL201UA4840334721187149827
  • last_name string
    The customer's last name.
    Example: James
  • phone string
    The customer's mobile phone number.
    Example: 008613977865436
  • province string
    The province or state in the address.
    Example: Kentucky
  • province_code string
    The code for the province or state, represented by a custom code or the portion after the hyphen (-) in the ISO 3166-2 code. For example, RI in US-RI or ENG in GB-ENG.
  • zip string
    The postal code information of the address.
    Example: 40202
  • email string
    The customer's email address.
    Example: steve@example.com
  • email_marketing_consentobject
    The information about the email marketing subscription.
  • consent_collected_from string
    The source of the subscription information.
    Example: extInfo
  • consent_updated_at string
    The date and time when the subscription status was updated. Format: ISO 8601.
    Example: 2021-08-31T02:20:26+08:00
  • opt_in_level integer
    The subscription method. Valid values are:
    • 0: Unknown
    • 1: Single opt-in
    • 2: Confirmed opt-in
    The default value depends on whether Email marketing consent checkbox is preselected is enabled under Settings > Customer Account > Marketing options in the SHOPLINE Admin.
    • Enabled: The default value is 2.
    • Disabled: The default value is 1.
  • state integer
    Email subscription status. Valid values are:
    • 0: Unsubscribed
    • 1: Subscribed
    • 2: Not subscribed
  • email_subscribe_flag integer
    The final subscription status of email marketing. The value is determined based on the parameters within email_marketing_consent. Valid values are:
    • 0: Unsubscribed
    • 1: Subscribed
    • 2: Not subscribed
  • first_name string
    The customer's first name.
    Example: Bob
  • gender string
    The customer's gender. Valid values are:
    • 0: Unknown
    • 1: Male
    • 2: Female
    • 3: Secret
  • id string
    The customer's unique ID .
    Example: 2007347234
  • language string
    The customer's language.
    Example: en
  • last_name string
    The customer's last name.
    Example: James
  • last_order_id string
    The order number of the most recent order.
    DEPRECATED
    This parameter is deprecated from API version v20250601.
    Example: 200066283289389
  • mobile_subscribe_flag integer
    The final subscription status of SMS marketing. The value is determined based on the parameters within sms_marketing_consent. Valid values are:
    • 0: Unsubscribed
    • 1: Subscribed
    • 2: Not subscribed
  • multipass_identifier string
    A unique identifier for the customer that logs in with Multipass.
    Example: extInfo
  • nick_name string
    The customer's nickname.
    Example: Bob James
  • note string
    The merchant's notes on the customer.
  • orders_count long
    The number of orders.
    DEPRECATED
    This parameter is deprecated from API version v20250601.
  • phone string
    The customer's mobile phone number.
    Example: 008613987675435
  • sms_marketing_consentobject
    The information about the SMS marketing subscription.
  • consent_collected_from string
    The source of the subscription information.
    Example: extInfo
  • consent_updated_at string
    The date and time when the subscription status was updated. Format: ISO 8601.
    Example: 2022-12-16T11:06:11+08:00
  • opt_in_level integer
    The subscription method. Valid values are:
    • 0: Unknown
    • 1: Single opt-in
    • 2: Confirmed opt-in
  • state integer
    SMS subscription status. Valid values are:
    • 0: Unsubscribed
    • 1: Subscribed
    • 2: Not subscribed
  • social_customer string
    The customer's unique ID on social media.
    DEPRECATED
    This parameter is deprecated from API version v20250601.
    Example: 7566553464365
  • state string
    The customer's status. Valid values are:
    • 0: Blacklisted
    • 1: Not invited
    • 2: Invited
    • 3: Registered
  • tags string
    The tags to be added to the customer, with multiple tags separated by commas.
  • total_spent string
    Total cost amount.
    DEPRECATED
    This parameter is deprecated from API version v20250601.
  • updated_at string
    The date and time when the customer was updated. Format: ISO 8601.
    Example: 2022-09-07T10:53:31+08:00
  • verified_email boolean
    Whether the email has been verified.
    • true: Verified
    • false: Unverified
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
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2026 SHOPLINE Limited.