# Addresses

## GET /addresses/

> This method is used to fetch address details associated with user profiles. An address entry contains information like address type, creation and modification dates, contact details, and geographical identifiers such as country, city, and district.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedAddressList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/Address"},"type":"array"}},"type":"object"},"Address":{"properties":{"address_type":{"$ref":"#/components/schemas/AddressTypeEnum","description":"The classification or type related to this field."},"city":{"description":"This field defines the city ID associated with the address.","type":"integer"},"company_name":{"description":"The full name or label associated with the record.","maxLength":255,"nullable":true,"type":"string"},"country":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"district":{"description":"This field defines the district ID associated with the address.","nullable":true,"type":"integer"},"e_bill_taxpayer":{"description":"This field defines whether the person is an e-bill taxpayer.","type":"boolean"},"email":{"description":"Email address of the user or entity.","format":"email","maxLength":254,"title":"E-posta","type":"string"},"extra_field":{"description":"This field defines the extra fields associated with the address.","nullable":true},"first_name":{"description":"The full name or label associated with the record.","maxLength":255,"type":"string"},"hash_data":{"description":"This field defines the hash value generated using specific fields associated with the address.","maxLength":256,"type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"identity_number":{"description":"This field defines the identification number.","maxLength":64,"nullable":true,"type":"string"},"is_active":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"last_name":{"description":"The full name or label associated with the record.","maxLength":255,"type":"string"},"line":{"description":"This field defines the full address associated with the location.","maxLength":255,"title":"Line of address","type":"string"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"notes":{"description":"This field defines the note associated with the address.","nullable":true,"title":"Instructions","type":"string"},"phone_number":{"description":"Phone number in international format.","maxLength":128,"nullable":true,"type":"string"},"postcode":{"description":"This field defines the postal code.","maxLength":64,"nullable":true,"title":"Post/Zip-code","type":"string"},"primary":{"description":"This field defines whether the address is the default among the user's addresses.","type":"boolean"},"remote_id":{"description":"This field defines the ID corresponding to the address from any 3rd party address service.","maxLength":1024,"nullable":true,"type":"string"},"retail_store":{"description":"This field defines the retail_store ID associated with the address.","nullable":true,"type":"integer"},"tax_no":{"description":"This field defines the tax number associated with the address.","maxLength":20,"nullable":true,"type":"string"},"tax_office":{"description":"This field defines the tax office associated with the address.","maxLength":64,"nullable":true,"type":"string"},"title":{"description":"This field defines the address title.","maxLength":128,"type":"string"},"township":{"description":"This field defines the township ID associated with the address.","nullable":true,"type":"integer"},"user":{"description":"This field defines the user ID.","nullable":true,"type":"integer"}},"type":"object"},"AddressTypeEnum":{"description":"* `customer` - Customer\n* `retail_store` - Retail Store\n* `pickup_location` - Pickup Location\n* `checkout_provider` - Checkout Provider","enum":["customer","retail_store","pickup_location","checkout_provider"],"type":"string"}}},"paths":{"/addresses/":{"get":{"description":"This method is used to fetch address details associated with user profiles. An address entry contains information like address type, creation and modification dates, contact details, and geographical identifiers such as country, city, and district.","operationId":"addresses_list","parameters":[{"description":"Query parameter `address_type` used to filter results based on specific conditions.","in":"query","name":"address_type","schema":{"type":"string"}},{"description":"Query parameter `city` used to filter results based on specific conditions.","in":"query","name":"city","schema":{"type":"integer"}},{"description":"Query parameter `company_name` used to filter results based on specific conditions.","in":"query","name":"company_name","schema":{"type":"string"}},{"description":"Query parameter `country` used to filter results based on specific conditions.","in":"query","name":"country","schema":{"type":"integer"}},{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `district` used to filter results based on specific conditions.","in":"query","name":"district","schema":{"type":"integer"}},{"description":"Query parameter `e_bill_taxpayer` used to filter results based on specific conditions.","in":"query","name":"e_bill_taxpayer","schema":{"type":"boolean"}},{"description":"Query parameter `email` used to filter results based on specific conditions.","in":"query","name":"email","schema":{"type":"string"}},{"description":"Query parameter `extra_field` used to filter results based on specific conditions.","in":"query","name":"extra_field","schema":{"nullable":true}},{"description":"Query parameter `first_name` used to filter results based on specific conditions.","in":"query","name":"first_name","schema":{"type":"string"}},{"description":"Query parameter `hash_data` used to filter results based on specific conditions.","in":"query","name":"hash_data","schema":{"type":"string"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Query parameter `identity_number` used to filter results based on specific conditions.","in":"query","name":"identity_number","schema":{"type":"string"}},{"description":"Query parameter `is_active` used to filter results based on specific conditions.","in":"query","name":"is_active","schema":{"type":"boolean"}},{"description":"Query parameter `last_name` used to filter results based on specific conditions.","in":"query","name":"last_name","schema":{"type":"string"}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `line` used to filter results based on specific conditions.","in":"query","name":"line","schema":{"type":"string"}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `notes` used to filter results based on specific conditions.","in":"query","name":"notes","schema":{"type":"string"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `phone_number` used to filter results based on specific conditions.","in":"query","name":"phone_number","schema":{"type":"string"}},{"description":"Query parameter `postcode` used to filter results based on specific conditions.","in":"query","name":"postcode","schema":{"type":"string"}},{"description":"Query parameter `primary` used to filter results based on specific conditions.","in":"query","name":"primary","schema":{"type":"boolean"}},{"description":"Query parameter `remote_id` used to filter results based on specific conditions.","in":"query","name":"remote_id","schema":{"type":"string"}},{"description":"Query parameter `retail_store` used to filter results based on specific conditions.","in":"query","name":"retail_store","schema":{"type":"integer"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `tax_no` used to filter results based on specific conditions.","in":"query","name":"tax_no","schema":{"type":"string"}},{"description":"Query parameter `tax_office` used to filter results based on specific conditions.","in":"query","name":"tax_office","schema":{"type":"string"}},{"description":"Query parameter `title` used to filter results based on specific conditions.","in":"query","name":"title","schema":{"type":"string"}},{"description":"Query parameter `township` used to filter results based on specific conditions.","in":"query","name":"township","schema":{"type":"integer"}},{"description":"Query parameter `user` used to filter results based on specific conditions.","in":"query","name":"user","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAddressList"}}},"description":"Successful response for status code 200."}},"tags":["addresses"]}}}}
```

## GET /addresses/{id}/

> This method is used to fetch address details associated with user profiles. An address entry contains information like address type, creation and modification dates, contact details, and geographical identifiers such as country, city, and district. This endpoint retrieves a specific record by its unique identifier.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"Address":{"properties":{"address_type":{"$ref":"#/components/schemas/AddressTypeEnum","description":"The classification or type related to this field."},"city":{"description":"This field defines the city ID associated with the address.","type":"integer"},"company_name":{"description":"The full name or label associated with the record.","maxLength":255,"nullable":true,"type":"string"},"country":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"district":{"description":"This field defines the district ID associated with the address.","nullable":true,"type":"integer"},"e_bill_taxpayer":{"description":"This field defines whether the person is an e-bill taxpayer.","type":"boolean"},"email":{"description":"Email address of the user or entity.","format":"email","maxLength":254,"title":"E-posta","type":"string"},"extra_field":{"description":"This field defines the extra fields associated with the address.","nullable":true},"first_name":{"description":"The full name or label associated with the record.","maxLength":255,"type":"string"},"hash_data":{"description":"This field defines the hash value generated using specific fields associated with the address.","maxLength":256,"type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"identity_number":{"description":"This field defines the identification number.","maxLength":64,"nullable":true,"type":"string"},"is_active":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"last_name":{"description":"The full name or label associated with the record.","maxLength":255,"type":"string"},"line":{"description":"This field defines the full address associated with the location.","maxLength":255,"title":"Line of address","type":"string"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"notes":{"description":"This field defines the note associated with the address.","nullable":true,"title":"Instructions","type":"string"},"phone_number":{"description":"Phone number in international format.","maxLength":128,"nullable":true,"type":"string"},"postcode":{"description":"This field defines the postal code.","maxLength":64,"nullable":true,"title":"Post/Zip-code","type":"string"},"primary":{"description":"This field defines whether the address is the default among the user's addresses.","type":"boolean"},"remote_id":{"description":"This field defines the ID corresponding to the address from any 3rd party address service.","maxLength":1024,"nullable":true,"type":"string"},"retail_store":{"description":"This field defines the retail_store ID associated with the address.","nullable":true,"type":"integer"},"tax_no":{"description":"This field defines the tax number associated with the address.","maxLength":20,"nullable":true,"type":"string"},"tax_office":{"description":"This field defines the tax office associated with the address.","maxLength":64,"nullable":true,"type":"string"},"title":{"description":"This field defines the address title.","maxLength":128,"type":"string"},"township":{"description":"This field defines the township ID associated with the address.","nullable":true,"type":"integer"},"user":{"description":"This field defines the user ID.","nullable":true,"type":"integer"}},"type":"object"},"AddressTypeEnum":{"description":"* `customer` - Customer\n* `retail_store` - Retail Store\n* `pickup_location` - Pickup Location\n* `checkout_provider` - Checkout Provider","enum":["customer","retail_store","pickup_location","checkout_provider"],"type":"string"}}},"paths":{"/addresses/{id}/":{"get":{"description":"This method is used to fetch address details associated with user profiles. An address entry contains information like address type, creation and modification dates, contact details, and geographical identifiers such as country, city, and district. This endpoint retrieves a specific record by its unique identifier.","operationId":"addresses_retrieve","parameters":[{"description":"A unique integer value identifying this address.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["addresses"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.akinon.com/commerce-openapis/data-warehouse/addresses.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.