put
https://{subdomain}.myshoplaza.com/openapi/2025-06/customers/
Update the details of an existing customer using its unique identifier.
Requireswrite_customeraccess scope.
Update Customer API allows developers update specific attributes of a customer by their unique ID.
This API is especially useful for:
- Modifying customer information like name, marketing subscriptions, or tags.
- Managing updates to customer records efficiently.
- Personalizing customer data for reporting or segmentation.
Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
id | string | Yes | 2dd957e3-2051-4cdf-8584-9c0046b4d1ae | Unique identifier of the customer. |
Body Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
customer | object | Yes | The object containing customer attributes to be updated. | |
customer.first_name | string | No | Ryan | Customer's first name. |
customer.last_name | string | No | Zhang | Customer's last name. |
customer. accepts_marketing | boolean | No | true | Whether to subscribe to marketing email campaigns. Defaults to true. |
customer. accepts_sms_marketing | boolean | No | true | Whether to subscribe to SMS marketing campaigns. Defaults to true. |
customer.tags | array of string | No | ["New Customer"] | Comma-separated tags assigned to the customer. |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Response status code |
message | string | "Addresses retrieved" | Descriptive message of the response |
data.customer | object | Customer object containing customer details. | |
data.customer.id | string | 2dd957e3-2051-4cdf-8584-9c0046b4d1ae | Unique identifier for the customer. |
data.customer.first_name | string | Ryan | Customer's first name. |
data.customer.last_name | string | Zhang | Customer's last name. |
data.customer.name | string | Ryan Zhang | Full name of the customer. |
data.customer.email | string | [email protected] | Customer's email address. |
data.customer.phone | string | +86 1231231234 | Customer's phone number. |
data.customer.phone_area_code | string | null | Area code of the phone number. |
data.customer.contact_type | string | email | Contact type, either email or phone. |
data.customer.accepts_marketing | boolean | true | Indicates if the customer is subscribed to marketing emails. |
data.customer.source | string | null | Source of the customer data. |
data.customer.free_tax | boolean | false | Indicates if the customer is exempt from taxes. |
data.customer.registered | boolean | false | Indicates if the customer is registered. |
data.customer.orders_count | integer | 0 | Number of orders placed by the customer. |
data.customer.last_order_at | string | null | Timestamp of the customer's last order. |
data.customer.total_spent | string | "0.00" | Total amount spent by the customer. |
data.customer.tags | array of string | ["New Customer"] | array of tag strings. |
data.customer.created_at | string | 2024-04-17T11:10:33Z | Timestamp when the customer was created, in ISO8601 format. |
data.customer.updated_at | string | 2024-04-17T11:10:33Z | Timestamp when the customer was last updated, in ISO8601 format. |
data.customer.subscribed_flag | integer | 5 | Customer's marketing subscription status flag. |
data.customer. sms_subscribed_flag | integer | 5 | Customer's SMS subscription status flag. |
data.customer. accepts_sms_marketing | boolean | true | Indicates if the customer is subscribed to SMS marketing campaigns. |
data.customer.addresses | array of objects | See Address Object fields below for full details. | List of all customer addresses. |
data.customer.addresses.id | string | 9ffa8dc0-25b8-4424-832e-bab46fcfeb20 | Unique identifier for the address. |
data.customer. addresses.customer_id | string | 2dd957e3-2051-4cdf-8584-9c0046b4d1ae | ID of the customer this address belongs to. |
data.customer. addresses.first_name | string | Test | First name of the consignee. |
data.customer. addresses.last_name | string | Test | Last name of the consignee. |
data.customer.addresses.company | string | "" | Company name. |
data.customer.addresses.city | string | 深圳 | City of the address. |
data.customer.addresses.province | string | "" | Province or state of the address. |
data.customer.addresses.country | string | Aland Islands | Country name of the address. |
data.customer.addresses.zip | string | 515300 | Postal or ZIP code. |
data.customer. addresses.province_code | string | "US-NM" | Province code. |
data.customer. addresses.country_code | string | US | ISO country code. |
data.customer. addresses.gender | string | "" | Gender of the consignee. |
data.customer.addresses.phone | string | +86 1231231234 | Phone number associated with the address. |
data.customer.addresses.area | string | "" | Area or region of the address. |
data.customer.addresses.email | string | [email protected] | Email associated with the address. |
data.customer.addresses.address1 | string | 6 三聖街 | Primary street address. |
data.customer.addresses.address2 | string | 1111 | Secondary street address. |
data.customer. addresses.country_name | string | Aland Islands | Full name of the country. |
data.customer.addresses.default | boolean | true | Indicates if this is the default address. |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |