put https://{shopdomain}.myshoplaza.com/openapi/2022-01/customers//addresses//default
Requires
write_customeraccess scope.
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
| Status Code | Description | Example Response |
|---|---|---|
200 OK | Address set as default successfully. | {} |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Email or Phone is already taken | ["Record not found"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 404 | Record Not Found | The customer_id and address_id provided is not found | Record Not Found |