Find Address Metafield
API operation: Open the endpoint in Scalar
Use GET /users/{user_id}/addresses/{address_id}/metafields/{metafield_id} to retrieve one metafield from a user's address. The operation is AddressMetafield.find.
The operation requires authentication. A non-administrator can read only when user_id identifies the authenticated user, and the controller verifies the full user-address-metafield relationship.
See List address metafields and Extra attributes (Metafields).
OpenAPI reference
Operation: GET /users/{user_id}/addresses/{address_id}/metafields/{metafield_id}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id | integer | Yes | — |
address_id | integer | Yes | — |
metafield_id | integer | Yes | — |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
params | string | No | Comma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields. |
Responses
| Code | Description |
|---|---|
| 200 | OK (Envelope) |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |