Retrieve An Address

Retrieve an specific customer address with id

HTTP Request

Retrieve Address:

GET/api/shop/customers/me/addresses/:id

Authorization

Authorization

• Required: Yes
• Permission: Authenticated Customer
• Authentication: Token-based (`Authorization: Token <your_api_key>`)

Path Parameters

Parameter	Type	Required	Description
id	Integer	Yes	Unique ID of the address

Example Requests

🐍 Python

1import requests
2
3import requests
4
5# Get specific address
6response = requests.get('http://www.example.com/api/shop/customers/me/addresses/123', 
7  headers={'Authorization': 'Token <your_api_key>'}
8)
9print(response.json())

🌐 Curl

1# Get specific address
2curl "http://www.example.com/api/shop/customers/me/addresses/123" -H "Authorization: Token <your_api_key>"

Response Fields

Field	Type	Description
id	Integer	Unique ID of the address
default	Boolean	Whether this is the default address
country_data	Object	Country details (read-only)
state_data	Object	State details (read-only)
city_data	Object	City details (read-only)
address	String	Detailed address
postal_code	String	Postal/ZIP code
first_name	String	Recipients first name
last_name	String	Recipients last name
national_code	String	National identification code
mobile_number	String	Recipients mobile number
text	String	Additional notes
created_at	String (ISO 8601)	Timestamp when address was created
updated_at	String (ISO 8601)	Timestamp when address was last updated

Country/State Data Structure:

Field	Type	Description
id	Integer	Unique ID
name	String	Name of the country/state
code	String	Code (e.g., ISO code for country)

City Data Structure:

Field	Type	Description
id	Integer	Unique ID
name	String	Name of the city

Example Response

{
    "id": 7,
    "default": true,
    "country_data": {
        "id": 1,
        "name": "ایران",
        "code": "IR"
    },
    "state_data": {
        "id": 17,
        "name": "فارس",
        "code": "FA"
    },
    "city_data": {
        "id": 642,
        "name": "ششده"
    },
    "address": "713 Wiza Fords",
    "postal_code": "6934169688",
    "first_name": "پژمان",
    "last_name": "اعتماد",
    "national_code": null,
    "mobile_number": "09501223992",
    "text": "ایران-فارس-ششده-713 Wiza Fords",
    "created_at": "2025-12-30T10:09:51.354368Z",
    "updated_at": "2025-12-30T10:09:51.354376Z"
}

Notes

• Geographic Validation: State must belong to the specified country, and city must belong to the specified state
• Access Control: Customers can only access their own addresses
• Default Address: Only one address can be set as default per customer