put
https://{subdomain}.myshoplaza.com/openapi/2025-06/customers//addresses//default
Requireswrite_customeraccess scope.
The Set Default Address API allows set a specific address as the default for a given customer.
This API is especially useful for:
- Managing default shipping or billing addresses for customers.
- Allowing users to quickly access and use their preferred address.
- Updating address priority in customer profiles.
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 | Description | Example |
|---|---|---|---|---|
customer_id | string | Yes | Unique identifier of the customer. | 165618e4-3243-4cd7-abc3-1234567890ab |
address_id | string | Yes | Unique identifier of the address. | 2490dc6a-d511-4e5e-bbcb-d58e913243ad |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Response status code |
message | string | "" | Descriptive message of the response |
data | object |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |