Update customer information

Requires write_customers access scope.
For more info , refer to:
PUT https://{handle}.myshopline.com/admin/openapi/v20250601/customers/:id.json
handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .
Update customer
Path Parameters
  • id string required
    Customer id
    Example: 4211465524
Request Headers
  • Content-Type required
    The value of this field is fixed to application/json; charset=utf-8
  • Authorization string required
    The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Request Body
  • customerobject
    Customer information
  • accepts_marketing boolean
    Subscribe to the mailbox , and the user mailbox is required when modifying the subscription status ( soon abandoned , it is recommended to use email_marketing_consent ) or not
    Example: true
  • addressesobject[]
    Number of customer address lists limited to : 50
  • address1 string
    Address 1 length limited to : 255
    Example: 7720 Cherokee Road
  • address2 string
    Address 2 length limited to : 255
    Example: Apartment 2
  • city string
    City length limited to : 64
    Example: Hagerman
  • company string
    Company length limited to : 255
    Example: Joy
  • country string
    Country length limited to : 64
    Example: United States
  • country_code string
    National code length limited to : 50
    Example: US
  • country_name string
    User's standardized country name
    Example: United States
  • customer_id string
    Customer id
    Example: 4201825054
  • default boolean
    Default address or not
    Example: true
  • first_name string
    Name length limited to : 128
    Example: Bob
  • id string
    Address ID
    Example: 207119551
  • last_name string
    Last name length limited to : 128
    Example: Norman
  • name string
    User nickname
    Example: NormanBob
  • phone string
    Phone number length limited to : 16
    Example: 001467326483
  • province string
    Length saving limited to : 64
    Example: Kentucky
  • province_code string
    Provincial code length limited to : 50
    Example: KY
  • zip string
    Zip code length limited to : 10
    Example: 40202
  • birthday string
    Birthday . format : yyyyMMdd
    Example: 19970102
  • email string
    Mailbox length limited to : 50
    Example: gungcherny@gamil.com
  • email_marketing_consentobject
    E-mail marketing subscription information
  • consent_collected_from string
    Subscription information source ( no more than 50 characters )
    Example: pop
  • consent_updated_at string
    Subscription change time
    Example: 2022-05-31T15:32:46+08:00
  • opt_in_level integer
    Subscription method ( 0 : unknown ; 1 : single_opt_in ; 2 : confirmed_opt_in )
    Example: 2
  • state integer
    Subscription status ( 0 : cancelled subscription ; 1 : on subscription ; 2 : not on subscription ; 3 : on-subscription confirmation )
    Example: 2
  • first_name string
    Name length limited to : 128
    Example: Bob
  • gender integer
    Gender , 0 : unknown / others , 1 : male , 2 : female , 3 : secret / prefer not to say
    Example: 1
  • last_name string
    Last name length limited to : 128
    Example: Norman
  • multipass_identifier string
    Multipass markers ( length limited to 100 )
    Example: multipassIdentifier
  • note string
    Memo length limited to : 1000
    Example: Placed an order that had a fraud warning
  • password string
    Password ( 6-18 characters , only case english letters , numbers , symbols );
    To protect customer privacy, the user password cannot be modified at present. This field will no longer be provided in versions 20250601 and later.
    Example: 123456
  • password_confirmation string
    Confirm password ( 6-18 characters , only case english letters , numbers , symbols );
    To protect customer privacy, the user password cannot be modified at present. This field will no longer be provided in versions 20250601 and later.
    Example: 123456
  • phone string
    Phone number length limited to : 20
    Example: 001467326483
  • sms_marketing_consentobject
    Sms marketing subscription information
  • consent_collected_from string
    Subscription information source ( no more than 50 characters )
    Example: pop
  • consent_updated_at string
    Subscription change time
    Example: 2022-05-31T15:32:46+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
  • tags string
    Tag are used between different tag . a single tag limited to is 100 characters , and the number of limited to is 100. the total length of this field is limited to 1000 characters
    Example: loyal
  • verified_email boolean
    Mailbox verified
    Example: true
Response
For more information about status codes, see Http status code.
Response Headers
  • traceId
    traceId
Response Body
  • customerobject
    Customer details
  • accepts_marketing boolean
    Mail subscription or not
    Example: true
  • accepts_marketing_updated_at string
    Email subscription time (see IOS8601 for the format)
    Example: 2022-05-31T15:32:46+08:00
  • accepts_mobile_marketing_updated_at string
    Telephone subscription time (see IOS8601 for the format)
    Example: true
  • accepts_phone_marketing boolean
    Accept telemarketing or not
  • addressesobject[]
    Address information list
  • address1 string
    Address 1
    Example: 7720 Cherokee Road
  • address2 string
    Address 2
    Example: Apartment 2
  • 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: 4201825054
  • 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: Norman
  • phone string
    Telephone number
    Example: 001467326483
  • province string
    Province
    Example: Kentucky
  • province_code string
    Provincial encoding
    Example: KY
  • zip string
    Zip code
    Example: 40202
  • asid string
    FB login ID
    Example: 481007156599455
  • created_at string
    Creation time (see IOS8601 for the format)
    Example: 2022-09-07T10:53:31+08:00
  • currency string
    Currency
    Example: USD
  • default_addressobject
    Default address
  • address1 string
    Address 1
    Example: 7720 Cherokee Road
  • address2 string
    Address 2
    Example: Apartment 2
  • 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: 4201825054
  • 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: Norman
  • phone string
    Telephone number
    Example: 008615834564475
  • province string
    Province
    Example: Kentucky
  • province_code string
    Provincial encoding
    Example: KY
  • zip string
    Zip code
    Example: 40202
  • email string
    E-mail
    Example: gungcherny@gamil.com
  • email_marketing_consentobject
    E-mail marketing subscription information
  • consent_collected_from string
    Subscription information source
    Example: pop
  • consent_updated_at string
    Subscription change time
    Example: 2022-09-07T10:53:31+08:00
  • opt_in_level integer
    Subscription method ( 0 : unknown ; 1 : single_opt_in ; 2 : confirmed_opt_in )
    Example: 2
  • 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
    User nickname
    Example: Bob
  • id string
    Customer id
    Example: 4201825054
  • last_name string
    Last name
    Example: Norman
  • last_order_id string
    Recent order number
    Example: 2005473211984312275741
  • last_order_name string
    Recent custom single number
    Example: #11279M
  • mobile_subscribe_flag integer
    Mobile phone subscription status 0 : cancelled subscription , 1 : already available , 2 : not available
  • multipass_identifier string
    Multipass markers
    Example: multipassIdentifier
  • note string
    Remark
    Example: Placed an order that had a fraud warning
  • orders_count long
    Order quantity
    Example: 12
  • phone string
    Phone number
    Example: 008615834564475
  • sms_marketing_consentobject
    Sms marketing subscription information
  • consent_collected_from string
    Subscription information source
    Example: pop
  • consent_updated_at string
    Subscription change time
    Example: 2022-09-07T10:53:31+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
  • state integer
    Customer status [ 0 : disabled account , 1 : to enable account , 2 : invited account , 3 : valid account ]
    Example: 2
  • tags string
    Customer tag
    Example: loyal
  • total_spent string
    Total cost amount
    Example: 100
  • updated_at string
    Update time (see IOS8601 for the format)
    Example: 2022-09-07T10:53:31+08:00
  • verified_email boolean
    Verify if e-mail or not
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

— path required
— header required

Body

required
{
  "customer": {
    "accepts_marketing": true,
    "addresses": [
      {
        "address1": "7720 Cherokee Road",
        "address2": "Apartment 2",
        "city": "Hagerman",
        "company": "Joy",
        "country": "United States",
        "country_code": "US",
        "country_name": "United States",
        "customer_id": "4201825054",
        "default": true,
        "first_name": "Bob",
        "id": "207119551",
        "last_name": "Norman",
        "name": "NormanBob",
        "phone": "001467326483",
        "province": "Kentucky",
        "province_code": "KY",
        "zip": "40202"
      }
    ],
    "birthday": "19970102",
    "email": "gungcherny@gamil.com",
    "email_marketing_consent": {
      "consent_collected_from": "pop",
      "consent_updated_at": "2022-05-31T15:32:46+08:00",
      "opt_in_level": 2,
      "state": 2
    },
    "first_name": "Bob",
    "gender": 1,
    "last_name": "Norman",
    "multipass_identifier": "multipassIdentifier",
    "note": "Placed an order that had a fraud warning",
    "password": "123456",
    "password_confirmation": "123456",
    "phone": "001467326483",
    "sms_marketing_consent": {
      "consent_collected_from": "pop",
      "consent_updated_at": "2022-05-31T15:32:46+08:00",
      "opt_in_level": 1,
      "state": 1
    },
    "tags": "loyal",
    "verified_email": true
  }
}

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/customers/id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.