🔒
Requires read_customer access scope.

The Create Customer API retrieves the details of a specific address for a given customer.

This API is especially useful for:

Fetching detailed address information for shipping or billing purposes.
Managing and validating address information for a customer.
Supporting detailed address retrieval for edits or confirmations.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all queries are applied to the correct store.

Request Parameters

Public 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

📘
Public Response Parameters

Successful Response

Field	Type	Example	Description
`code`	string	`"success"`	Response status code
`message`	string	`"Addresses retrieved"`	Descriptive message of the response
`data.cursor`	string	`"cursor_123"`	Pagination token
`data.has_more`	boolean	`true`	More results available
`data.addresses`			List of addresses
`data.addresses.id`	string	`"addr_123"`	Unique address ID
`data.addresses.customer_id`	string	`"cust_456"`	Owning customer ID
`data.addresses.first_name`	string	`"John"`	Recipient first name
`data.addresses.last_name`	string	`"Doe"`	Recipient last name
`data.addresses.company`	string	`"ACME Inc"`	Company name
`data.addresses.address1`	string	`"123 Main St"`	Primary address line
`data.addresses.address2`	string	`"Suite 200"`	Secondary address line
`data.addresses.city`	string	`"New York"`	City name
`data.addresses.province`	string	`"New York"`	State/province
`data.addresses.country`	string	`"United States"`	Country name
`data.addresses.zip`	string	`"10001"`	Postal code
`data.addresses.province_code`	string	`"US-NY"`	Province abbreviation
`data.addresses.country_code`	string	`"US"`	ISO country code
`data.addresses.gender`	string	`"male"`	Recipient gender
`data.addresses.phone`	string	`"+12125551234"`	Contact number
`data.addresses.phone_area_code`	string	`"212"`	Phone area code
`data.addresses.area`	string	`"Manhattan"`	District/region
`data.addresses.email`	string	`"john@example.com"`	Contact email
`data.addresses.name`	string	`"John Doe"`	Full recipient name
`data.addresses.country_name`	string	`"United States"`	Official country name
`data.addresses.default`	boolean	`true`	Default address flag

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message

API Structure Overview

200OK