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.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

address_typestringOptional

Query parameter address_type used to filter results based on specific conditions.

cityintegerOptional

Query parameter city used to filter results based on specific conditions.

company_namestringOptional

Query parameter company_name used to filter results based on specific conditions.

countryintegerOptional

Query parameter country used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

districtintegerOptional

Query parameter district used to filter results based on specific conditions.

e_bill_taxpayerbooleanOptional

Query parameter e_bill_taxpayer used to filter results based on specific conditions.

emailstringOptional

Query parameter email used to filter results based on specific conditions.

extra_fieldany · nullableOptional

Query parameter extra_field used to filter results based on specific conditions.

first_namestringOptional

Query parameter first_name used to filter results based on specific conditions.

hash_datastringOptional

Query parameter hash_data used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

identity_numberstringOptional

Query parameter identity_number used to filter results based on specific conditions.

is_activebooleanOptional

Query parameter is_active used to filter results based on specific conditions.

last_namestringOptional

Query parameter last_name used to filter results based on specific conditions.

limitinteger · max: 1000Optional

Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.

linestringOptional

Query parameter line used to filter results based on specific conditions.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

notesstringOptional

Query parameter notes used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

phone_numberstringOptional

Query parameter phone_number used to filter results based on specific conditions.

postcodestringOptional

Query parameter postcode used to filter results based on specific conditions.

primarybooleanOptional

Query parameter primary used to filter results based on specific conditions.

remote_idstringOptional

Query parameter remote_id used to filter results based on specific conditions.

retail_storeintegerOptional

Query parameter retail_store used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

tax_nostringOptional

Query parameter tax_no used to filter results based on specific conditions.

tax_officestringOptional

Query parameter tax_office used to filter results based on specific conditions.

titlestringOptional

Query parameter title used to filter results based on specific conditions.

townshipintegerOptional

Query parameter township used to filter results based on specific conditions.

userintegerOptional

Query parameter user used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

address_typestringOptional

This field defines the address type. Possible values are: customer, retail_store, pickup_location, checkout_provider

citystringOptional

This field defines the city ID associated with the address.

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

countrystringOptional

This field defines the country ID associated with the address.

created_datestringOptional

This field defines the creation date.

districtstringOptional

This field defines the district ID associated with the address.

e_bill_taxpayerstringOptional

This field defines whether the person is an e-bill taxpayer.

emailstringOptional

This field defines the email address associated with the address.

extra_fieldstringOptional

This field defines the extra fields associated with the address.

first_namestringOptional

This field defines the name of the address owner.

hash_datastringOptional

This field defines the hash value generated using specific fields associated with the address.

idstringOptional

This field defines the database ID of the record.

identity_numberstringOptional

This field defines the identification number.

is_activestringOptional

This field defines whether the address is active.

last_namestringOptional

This field defines the surname of the address owner.

linestringOptional

This field defines the full address associated with the location.

modified_datestringOptional

This field defines the last updated date.

nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4

notesstringOptional

This field defines the note associated with the address.

phone_numberstringOptional

This field defines the phone number associated with the address.

postcodestringOptional

This field defines the postal code.

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2

primarystringOptional

This field defines whether the address is the default among the user's addresses.

remote_idstringOptional

This field defines the ID corresponding to the address from any 3rd party address service.

retail_storestringOptional

This field defines the retail_store ID associated with the address.

tax_nostringOptional

This field defines the tax number associated with the address.

tax_officestringOptional

This field defines the tax office associated with the address.

titlestringOptional

This field defines the address title.

townshipstringOptional

This field defines the township ID associated with the address.

userstringOptional

This field defines the user ID.

get/addresses/

GET /api/v1/remote/1/data-warehouse/addresses/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response for status code 200.

{
  "address_type": "text",
  "city": "text",
  "count": 123,
  "country": "text",
  "created_date": "text",
  "district": "text",
  "e_bill_taxpayer": "text",
  "email": "text",
  "extra_field": "text",
  "first_name": "text",
  "hash_data": "text",
  "id": "text",
  "identity_number": "text",
  "is_active": "text",
  "last_name": "text",
  "line": "text",
  "modified_date": "text",
  "next": "http://api.example.org/accounts/?page=4",
  "notes": "text",
  "phone_number": "text",
  "postcode": "text",
  "previous": "http://api.example.org/accounts/?page=2",
  "primary": "text",
  "remote_id": "text",
  "results": [
    {
      "address_type": "customer",
      "city": 1,
      "company_name": "text",
      "country": 1,
      "created_date": "2026-01-01T00:00:00.000Z",
      "district": 1,
      "e_bill_taxpayer": true,
      "email": "name@gmail.com",
      "extra_field": null,
      "first_name": "text",
      "hash_data": "text",
      "id": 1,
      "identity_number": "text",
      "is_active": true,
      "last_name": "text",
      "line": "text",
      "modified_date": "2026-01-01T00:00:00.000Z",
      "notes": "text",
      "phone_number": "text",
      "postcode": "text",
      "primary": true,
      "remote_id": "text",
      "retail_store": 1,
      "tax_no": "text",
      "tax_office": "text",
      "title": "text",
      "township": 1,
      "user": 1
    }
  ],
  "retail_store": "text",
  "tax_no": "text",
  "tax_office": "text",
  "title": "text",
  "township": "text",
  "user": "text"
}

get

/addresses/{id}/

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this address.

Responses

200

Successful response for status code 200.

application/json

address_typestring · enumOptional

The classification or type related to this field.

Possible values:

cityintegerOptional

This field defines the city ID associated with the address.

company_namestring · max: 255 · nullableOptional

The full name or label associated with the record.

countryintegerOptional

Numerical value representing quantity or total amount.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

districtinteger · nullableOptional

This field defines the district ID associated with the address.

e_bill_taxpayerbooleanOptional

This field defines whether the person is an e-bill taxpayer.

emailstring · email · max: 254Optional

Email address of the user or entity.

extra_fieldany · nullableOptional

This field defines the extra fields associated with the address.

first_namestring · max: 255Optional

The full name or label associated with the record.

hash_datastring · max: 256Optional

This field defines the hash value generated using specific fields associated with the address.

idintegerOptional

Unique identifier for the record.

identity_numberstring · max: 64 · nullableOptional

This field defines the identification number.

is_activebooleanOptional

Boolean flag indicating whether the condition is met.

last_namestring · max: 255Optional

The full name or label associated with the record.

linestring · max: 255Optional

This field defines the full address associated with the location.

modified_datestring · date-timeOptional

This field defines the last updated date.

notesstring · nullableOptional

This field defines the note associated with the address.

phone_numberstring · max: 128 · nullableOptional

Phone number in international format.

postcodestring · max: 64 · nullableOptional

This field defines the postal code.

primarybooleanOptional

This field defines whether the address is the default among the user's addresses.

remote_idstring · max: 1024 · nullableOptional

This field defines the ID corresponding to the address from any 3rd party address service.

retail_storeinteger · nullableOptional

This field defines the retail_store ID associated with the address.

tax_nostring · max: 20 · nullableOptional

This field defines the tax number associated with the address.

tax_officestring · max: 64 · nullableOptional

This field defines the tax office associated with the address.

titlestring · max: 128Optional

This field defines the address title.

townshipinteger · nullableOptional

This field defines the township ID associated with the address.

userinteger · nullableOptional

This field defines the user ID.

404

Object not found.

application/json

get/addresses/{id}/

GET /api/v1/remote/1/data-warehouse/addresses/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "address_type": "customer",
  "city": 1,
  "company_name": "text",
  "country": 1,
  "created_date": "2026-01-01T00:00:00.000Z",
  "district": 1,
  "e_bill_taxpayer": true,
  "email": "name@gmail.com",
  "extra_field": null,
  "first_name": "text",
  "hash_data": "text",
  "id": 1,
  "identity_number": "text",
  "is_active": true,
  "last_name": "text",
  "line": "text",
  "modified_date": "2026-01-01T00:00:00.000Z",
  "notes": "text",
  "phone_number": "text",
  "postcode": "text",
  "primary": true,
  "remote_id": "text",
  "retail_store": 1,
  "tax_no": "text",
  "tax_office": "text",
  "title": "text",
  "township": 1,
  "user": 1
}

PreviousAccount

NextAudit Events

Last updated 19 days ago

Was this helpful?