User Addresses
Manage delivery addresses (login required)
Get all saved delivery addresses for the logged-in user.
Page number (starts from 1)
1Example: 1Number of records per page
10Example: 10Use the X-Cookie header instead of the Cookie header in the “TEST IT” section. When testing via Postman or other external tools, continue using the standard Cookie header. Some commerce applications may use 'sessionid' instead of 'osessionid'. Set 'ENABLE_X_COOKIE_HEADER = True' in your project environments to enable the “TEST IT” feature. This setting should be applied only for the “TEST IT” button.
osessionid=abc123Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr
trExample: trPossible values: List of addresses
Not logged in
Save a new delivery address.
Related Settings (Omnitron → Sales Channels → Dynamic Settings):
ADDRESS_PHONE_MIN_LENGTH (Integer, default:
11): Minimum phone number length. Example: Set to10for countries with shorter phone numbers.ADDRESS_DISTRICT_REQUIRED (Boolean, default:
False): Makes district field mandatory. Set totrueto require district selection.ADDRESS_SERIALIZER_FIELDS (Dictionary): Country-specific extra fields for addresses. Example:
{ "TR": [ {"field": "tax_office", "validators": [], "kwargs": {}}, {"field": "tax_no", "validators": [], "kwargs": {}} ] }Fields not in base Address model are stored in
extra_fieldJSON column.IDENTITY_NUMBER_VALIDATOR (String, default:
"omnicore.address.validators.null_identity_validator"): Validates identity_number field. Options:"omnicore.address.validators.null_identity_validator"- No validation"omnicore.address.validators.tc_identity_number_validator"- Turkish ID validation
IDENTITY_NUMBER_REQUIRED_AMOUNT (Number, nullable, default:
None): Order amount threshold requiring identity number. Example:5000means ID required for orders above 5000 TRY.ANONYMOUS_ADDRESS_EXPIRE_SECONDS (Integer, default:
1800): How long to keep guest user addresses before cleanup (30 minutes by default).
Use the X-Cookie header instead of the Cookie header in the “TEST IT” section. When testing via Postman or other external tools, continue using the standard Cookie header. Some commerce applications may use 'sessionid' instead of 'osessionid'. Set 'ENABLE_X_COOKIE_HEADER = True' in your project environments to enable the “TEST IT” feature. This setting should be applied only for the “TEST IT” button.
osessionid=abc123Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr
trExample: trPossible values: CSRF token for write operations (POST, PUT, PATCH, DELETE). Required for security when using session authentication. Obtain token from cookie 'csrftoken' or meta tag in HTML.
abc123def456ghi789Input schema for creating/updating addresses
International format, min 11 chars (e.g., +905551234567)
Country ID
City ID
Street address
Address nickname (e.g., "Ev", "İş")
Township ID
District ID (optional unless ADDRESS_DISTRICT_REQUIRED=True)
Registered for e-invoicing?
Retail store ID for click-and-collect orders
National ID (may be required for large orders)
Set as default address?
Address created
Validation error (invalid fields, city mismatch, etc.)
Not logged in
Too many requests (rate limit exceeded)
View a specific address by ID.
Address ID
Use the X-Cookie header instead of the Cookie header in the “TEST IT” section. When testing via Postman or other external tools, continue using the standard Cookie header. Some commerce applications may use 'sessionid' instead of 'osessionid'. Set 'ENABLE_X_COOKIE_HEADER = True' in your project environments to enable the “TEST IT” feature. This setting should be applied only for the “TEST IT” button.
osessionid=abc123Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr
trExample: trPossible values: Address details
Not logged in
Address not found
Replace all fields of an address.
Use the X-Cookie header instead of the Cookie header in the “TEST IT” section. When testing via Postman or other external tools, continue using the standard Cookie header. Some commerce applications may use 'sessionid' instead of 'osessionid'. Set 'ENABLE_X_COOKIE_HEADER = True' in your project environments to enable the “TEST IT” feature. This setting should be applied only for the “TEST IT” button.
osessionid=abc123Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr
trExample: trPossible values: CSRF token for write operations (POST, PUT, PATCH, DELETE). Required for security when using session authentication. Obtain token from cookie 'csrftoken' or meta tag in HTML.
abc123def456ghi789Input schema for creating/updating addresses
International format, min 11 chars (e.g., +905551234567)
Country ID
City ID
Street address
Address nickname (e.g., "Ev", "İş")
Township ID
District ID (optional unless ADDRESS_DISTRICT_REQUIRED=True)
Registered for e-invoicing?
Retail store ID for click-and-collect orders
National ID (may be required for large orders)
Set as default address?
Address updated
Validation error (invalid fields, city mismatch, etc.)
Not logged in
Address not found
Remove an address from your account.
Use the X-Cookie header instead of the Cookie header in the “TEST IT” section. When testing via Postman or other external tools, continue using the standard Cookie header. Some commerce applications may use 'sessionid' instead of 'osessionid'. Set 'ENABLE_X_COOKIE_HEADER = True' in your project environments to enable the “TEST IT” feature. This setting should be applied only for the “TEST IT” button.
osessionid=abc123Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr
trExample: trPossible values: Address deleted
Not logged in
Address not found
No content
Update only specific fields.
Use the X-Cookie header instead of the Cookie header in the “TEST IT” section. When testing via Postman or other external tools, continue using the standard Cookie header. Some commerce applications may use 'sessionid' instead of 'osessionid'. Set 'ENABLE_X_COOKIE_HEADER = True' in your project environments to enable the “TEST IT” feature. This setting should be applied only for the “TEST IT” button.
osessionid=abc123Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr
trExample: trPossible values: CSRF token for write operations (POST, PUT, PATCH, DELETE). Required for security when using session authentication. Obtain token from cookie 'csrftoken' or meta tag in HTML.
abc123def456ghi789Input schema for creating/updating addresses
International format, min 11 chars (e.g., +905551234567)
Country ID
City ID
Street address
Address nickname (e.g., "Ev", "İş")
Township ID
District ID (optional unless ADDRESS_DISTRICT_REQUIRED=True)
Registered for e-invoicing?
Retail store ID for click-and-collect orders
National ID (may be required for large orders)
Set as default address?
Address updated
Validation error (invalid fields)
Not logged in
Address not found
View address with full geographic data (country, city, township, district objects).
Use the X-Cookie header instead of the Cookie header in the “TEST IT” section. When testing via Postman or other external tools, continue using the standard Cookie header. Some commerce applications may use 'sessionid' instead of 'osessionid'. Set 'ENABLE_X_COOKIE_HEADER = True' in your project environments to enable the “TEST IT” feature. This setting should be applied only for the “TEST IT” button.
osessionid=abc123Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr
trExample: trPossible values: Detailed address data
Not logged in
Address not found
Mark this address as your default.
Send {"primary": true} to set as default address.
Use the X-Cookie header instead of the Cookie header in the “TEST IT” section. When testing via Postman or other external tools, continue using the standard Cookie header. Some commerce applications may use 'sessionid' instead of 'osessionid'. Set 'ENABLE_X_COOKIE_HEADER = True' in your project environments to enable the “TEST IT” feature. This setting should be applied only for the “TEST IT” button.
osessionid=abc123Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr
trExample: trPossible values: CSRF token for write operations (POST, PUT, PATCH, DELETE). Required for security when using session authentication. Obtain token from cookie 'csrftoken' or meta tag in HTML.
abc123def456ghi789Default address updated
Validation error (invalid primary value)
Not logged in
Address not found
Get all addresses with full geographic data.
Page number (starts from 1)
1Example: 1Number of records per page
10Example: 10Use the X-Cookie header instead of the Cookie header in the “TEST IT” section. When testing via Postman or other external tools, continue using the standard Cookie header. Some commerce applications may use 'sessionid' instead of 'osessionid'. Set 'ENABLE_X_COOKIE_HEADER = True' in your project environments to enable the “TEST IT” feature. This setting should be applied only for the “TEST IT” button.
osessionid=abc123Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr
trExample: trPossible values: List of detailed addresses
Not logged in
Find addresses by postal code.
Returns geographic data (country, city, township, district objects) matching the postcode.
Postal code to search (minimum 1 character)
Filter by country ID
Page number (starts from 1)
1Example: 1Number of records per page
10Example: 10Use the X-Cookie header instead of the Cookie header in the “TEST IT” section. When testing via Postman or other external tools, continue using the standard Cookie header. Some commerce applications may use 'sessionid' instead of 'osessionid'. Set 'ENABLE_X_COOKIE_HEADER = True' in your project environments to enable the “TEST IT” feature. This setting should be applied only for the “TEST IT” button.
osessionid=abc123Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr
trExample: trPossible values: Matching geographic data
Validation error (invalid postcode format)
Not logged in
Last updated
Was this helpful?