Get Address Form Schema

GET

{store_url}/api/v1/account/addresses/schema

Retrieves the dynamic address form schema based on the provided country code.

This endpoint is typically used to:

Dynamically build address forms on the frontend

Support country-specific address requirements (e.g., postcode, building number)

Validate address inputs before submission

Request

Query Params

🟢200Success

application/json

Bodyapplication/json

🟠422Validation Error

🟠401Unauthorized

🔴500Internal Server error

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff '{store_url}/api/v1/account/addresses/schema?country_code=SA'

Response Example

200 - Example 1

"Address schema retrieved successfully"

Modified at 2026-02-23 09:00:07