# SalesChannelAddresses

## Retrieve Sales Channel Address

> Retrieve a specific Sales Channel Address by ID

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"Address":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"type":"integer","description":"Related country ID"},"city":{"type":"integer","description":"Related city ID"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"type":"integer","description":"Related township ID"},"district":{"type":"integer","description":"Related district ID"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"type":"integer","description":"Related retail store ID"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"type":"integer","description":"Related customer ID"},"is_active":{"type":"boolean","description":"Indicates if the address is active"}},"required":["phone_number"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/addresses/{id}/":{"get":{"summary":"Retrieve Sales Channel Address","description":"Retrieve a specific Sales Channel Address by ID","tags":["SalesChannelAddresses"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Sales Channel Address retrieved successfully","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Address"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Update Sales Channel Address

> Update a specific Sales Channel Address by ID

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"Address":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"type":"integer","description":"Related country ID"},"city":{"type":"integer","description":"Related city ID"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"type":"integer","description":"Related township ID"},"district":{"type":"integer","description":"Related district ID"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"type":"integer","description":"Related retail store ID"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"type":"integer","description":"Related customer ID"},"is_active":{"type":"boolean","description":"Indicates if the address is active"}},"required":["phone_number"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/addresses/{id}/":{"put":{"summary":"Update Sales Channel Address","description":"Update a specific Sales Channel Address by ID","tags":["SalesChannelAddresses"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"responses":{"200":{"description":"Sales Channel Address updated"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Delete Sales Channel Address

> Delete Sales Channel Address for a specific channel.

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/addresses/{id}/":{"delete":{"summary":"Delete Sales Channel Address","description":"Delete Sales Channel Address for a specific channel.","tags":["SalesChannelAddresses"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"204":{"description":"Sales Channel Address deleted successfully"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Partial Update Sales Channel Address

> Partial update a specific Sales Channel Address by ID

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"Address":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"type":"integer","description":"Related country ID"},"city":{"type":"integer","description":"Related city ID"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"type":"integer","description":"Related township ID"},"district":{"type":"integer","description":"Related district ID"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"type":"integer","description":"Related retail store ID"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"type":"integer","description":"Related customer ID"},"is_active":{"type":"boolean","description":"Indicates if the address is active"}},"required":["phone_number"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/addresses/{id}/":{"patch":{"summary":"Partial Update Sales Channel Address","description":"Partial update a specific Sales Channel Address by ID","tags":["SalesChannelAddresses"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"responses":{"200":{"description":"Sales Channel Address updated"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Retrieve Sales Channel Cities with details

> Retrieve a specific Sales Channel Cities by ID with details

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/addresses/{id}/detailed/":{"get":{"summary":"Retrieve Sales Channel Cities with details","description":"Retrieve a specific Sales Channel Cities by ID with details","tags":["SalesChannelAddresses"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Sales Channel Address retrieved successfully with details","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/AddressDetailed"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## List Sales Channel Addresses

> List Sales Channel Addresses

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"pk__in":{"name":"pk__in","in":"query","description":"Filter by multiple primary key values (comma-separated list of integers)","required":false,"schema":{"type":"array","items":{"type":"integer"}},"style":"form","explode":false},"email":{"name":"email","in":"query","description":"Email address of the customer","required":false,"schema":{"type":"string","format":"email"}},"phone_number":{"name":"phone_number","in":"query","description":"Phone number of the customer","required":false,"schema":{"type":"string"}},"first_name":{"name":"first_name","in":"query","description":"First name of the customer","required":false,"schema":{"type":"string"}},"last_name":{"name":"last_name","in":"query","description":"Last name of the customer","required":false,"schema":{"type":"string"}},"customer":{"name":"customer_id","in":"query","description":"Filter by customer ID.","required":false,"schema":{"type":"integer"}},"country":{"name":"country_id","in":"query","required":false,"description":"Filter by County ID","schema":{"type":"integer","minimum":1}},"township":{"name":"township_id","in":"query","required":false,"description":"Filter by Township ID","schema":{"type":"integer","minimum":1}},"city":{"name":"city_id","in":"query","required":false,"description":"Filter by City ID","schema":{"type":"integer","minimum":1}},"district":{"name":"district_id","in":"query","required":false,"description":"Filter by District ID","schema":{"type":"integer","minimum":1}},"is_active":{"name":"is_active","in":"query","description":"Filter by active status (True or False)","required":false,"schema":{"type":"boolean"}},"postcode":{"name":"postcode","in":"query","required":false,"description":"Filter by Postcode","schema":{"type":"string"}},"line__exact":{"name":"line__exact","in":"query","required":false,"description":"Filters by exact line","schema":{"type":"string"}},"line__iexact":{"name":"line__iexact","in":"query","required":false,"description":"Filters case insensitive by exact line","schema":{"type":"string"}},"line__contains":{"name":"line__contains","in":"query","description":"Filter by line containing the given string","required":false,"schema":{"type":"string"}},"line__icontains":{"name":"line__icontains","in":"query","description":"Filter by line case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"title__exact":{"name":"title__exact","in":"query","required":false,"description":"Filters by exact title","schema":{"type":"string"}},"title__iexact":{"name":"title__iexact","in":"query","required":false,"description":"Filters case insensitive by exact title","schema":{"type":"string"}},"title__contains":{"name":"title__contains","in":"query","description":"Filter by title containing the given string","required":false,"schema":{"type":"string"}},"title__icontains":{"name":"title__icontains","in":"query","description":"Filter by title case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"notes__exact":{"name":"notes__exact","in":"query","required":false,"description":"Filters by exact notes","schema":{"type":"string"}},"notes__iexact":{"name":"notes__iexact","in":"query","required":false,"description":"Filters case insensitive by exact notes","schema":{"type":"string"}},"notes__contains":{"name":"notes__contains","in":"query","description":"Filter by notes containing the given string","required":false,"schema":{"type":"string"}},"notes__icontains":{"name":"notes__icontains","in":"query","description":"Filter by notes case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"company_name__exact":{"name":"company_name__exact","in":"query","required":false,"description":"Filters by exact company_name","schema":{"type":"string"}},"company_name__iexact":{"name":"company_name__iexact","in":"query","required":false,"description":"Filters case insensitive by exact company_name","schema":{"type":"string"}},"company_name__contains":{"name":"company_name__contains","in":"query","description":"Filter by company_name containing the given string","required":false,"schema":{"type":"string"}},"company_name__icontains":{"name":"company_name__icontains","in":"query","description":"Filter by company_name case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"tax_office__exact":{"name":"tax_office__exact","in":"query","required":false,"description":"Filters by exact tax_office","schema":{"type":"string"}},"tax_office__iexact":{"name":"tax_office__iexact","in":"query","required":false,"description":"Filters case insensitive by exact tax_office","schema":{"type":"string"}},"tax_office__contains":{"name":"tax_office__contains","in":"query","description":"Filter by tax_office containing the given string","required":false,"schema":{"type":"string"}},"tax_office__icontains":{"name":"tax_office__icontains","in":"query","description":"Filter by tax_office case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"tax_no__exact":{"name":"tax_no__exact","in":"query","required":false,"description":"Filters by exact tax_no","schema":{"type":"string"}},"tax_no__iexact":{"name":"tax_no__iexact","in":"query","required":false,"description":"Filters case insensitive by exact tax_no","schema":{"type":"string"}},"tax_no__contains":{"name":"tax_no__contains","in":"query","description":"Filter by tax_no containing the given string","required":false,"schema":{"type":"string"}},"tax_no__icontains":{"name":"tax_no__icontains","in":"query","description":"Filter by tax_no case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"hash_data__exact":{"name":"hash_data__exact","in":"query","required":false,"description":"Filters by exact hash_data","schema":{"type":"string"}},"hash_data__iexact":{"name":"hash_data__iexact","in":"query","required":false,"description":"Filters case insensitive by exact hash_data","schema":{"type":"string"}},"hash_data__contains":{"name":"hash_data__contains","in":"query","description":"Filter by hash_data containing the given string","required":false,"schema":{"type":"string"}},"hash_data__icontains":{"name":"hash_data__icontains","in":"query","description":"Filter by hash_data case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"e_bill_taxpayer":{"name":"e_bill_taxpayer","in":"query","description":"Filter by e_bill_taxpayer","required":false,"schema":{"type":"boolean"}},"city__priority":{"name":"city__priority","in":"query","description":"Filter by city's priority","required":false,"schema":{"type":"integer"}},"city__country":{"name":"city__country_id","in":"query","required":false,"description":"Filter by City's County ID","schema":{"type":"integer","minimum":1}},"city__postcode":{"name":"city__postcode","in":"query","required":false,"description":"Filter by City's Postcode","schema":{"type":"string"}},"district__city":{"name":"district__city_id","in":"query","required":false,"description":"Filter by District's City ID","schema":{"type":"integer","minimum":1}},"district__township":{"name":"district__township_id","in":"query","required":false,"description":"Filter by District's Township ID","schema":{"type":"integer","minimum":1}},"district__postcode":{"name":"district__postcode","in":"query","required":false,"description":"Filter by District's Postcode","schema":{"type":"string"}},"township__priority":{"name":"township__priority","in":"query","description":"Filter by township's priority","required":false,"schema":{"type":"integer"}},"township__city":{"name":"township__city_id","in":"query","required":false,"description":"Filter by Township's City ID","schema":{"type":"integer","minimum":1}},"township__postcode":{"name":"township__postcode","in":"query","required":false,"description":"Filter by Township's Postcode","schema":{"type":"string"}},"retail_store":{"name":"retail_store_id","in":"query","required":false,"description":"Filter by Retail Store ID","schema":{"type":"integer","minimum":1}},"extra_field":{"name":"extra_field","in":"query","description":"Filter by extra field attributes","schema":{"type":"object","additionalProperties":true}},"mapping__integration_type":{"name":"mapping__integration_type","in":"query","description":"Filter by integration mapping object's integration type","required":false,"schema":{"type":"string","enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]}},"mapping__code__exact":{"name":"mapping__code__exact","in":"query","description":"Filter by integration mapping object's code","required":false,"schema":{"type":"string"}},"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}}},"schemas":{"Address":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"type":"integer","description":"Related country ID"},"city":{"type":"integer","description":"Related city ID"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"type":"integer","description":"Related township ID"},"district":{"type":"integer","description":"Related district ID"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"type":"integer","description":"Related retail store ID"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"type":"integer","description":"Related customer ID"},"is_active":{"type":"boolean","description":"Indicates if the address is active"}},"required":["phone_number"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/addresses/":{"get":{"summary":"List Sales Channel Addresses","description":"List Sales Channel Addresses","tags":["SalesChannelAddresses"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/pk__in"},{"$ref":"#/components/parameters/email"},{"$ref":"#/components/parameters/phone_number"},{"$ref":"#/components/parameters/first_name"},{"$ref":"#/components/parameters/last_name"},{"$ref":"#/components/parameters/customer"},{"$ref":"#/components/parameters/country"},{"$ref":"#/components/parameters/township"},{"$ref":"#/components/parameters/city"},{"$ref":"#/components/parameters/district"},{"$ref":"#/components/parameters/is_active"},{"$ref":"#/components/parameters/postcode"},{"$ref":"#/components/parameters/line__exact"},{"$ref":"#/components/parameters/line__iexact"},{"$ref":"#/components/parameters/line__contains"},{"$ref":"#/components/parameters/line__icontains"},{"$ref":"#/components/parameters/title__exact"},{"$ref":"#/components/parameters/title__iexact"},{"$ref":"#/components/parameters/title__contains"},{"$ref":"#/components/parameters/title__icontains"},{"$ref":"#/components/parameters/notes__exact"},{"$ref":"#/components/parameters/notes__iexact"},{"$ref":"#/components/parameters/notes__contains"},{"$ref":"#/components/parameters/notes__icontains"},{"$ref":"#/components/parameters/company_name__exact"},{"$ref":"#/components/parameters/company_name__iexact"},{"$ref":"#/components/parameters/company_name__contains"},{"$ref":"#/components/parameters/company_name__icontains"},{"$ref":"#/components/parameters/tax_office__exact"},{"$ref":"#/components/parameters/tax_office__iexact"},{"$ref":"#/components/parameters/tax_office__contains"},{"$ref":"#/components/parameters/tax_office__icontains"},{"$ref":"#/components/parameters/tax_no__exact"},{"$ref":"#/components/parameters/tax_no__iexact"},{"$ref":"#/components/parameters/tax_no__contains"},{"$ref":"#/components/parameters/tax_no__icontains"},{"$ref":"#/components/parameters/hash_data__exact"},{"$ref":"#/components/parameters/hash_data__iexact"},{"$ref":"#/components/parameters/hash_data__contains"},{"$ref":"#/components/parameters/hash_data__icontains"},{"$ref":"#/components/parameters/e_bill_taxpayer"},{"$ref":"#/components/parameters/city__priority"},{"$ref":"#/components/parameters/city__country"},{"$ref":"#/components/parameters/city__postcode"},{"$ref":"#/components/parameters/district__city"},{"$ref":"#/components/parameters/district__township"},{"$ref":"#/components/parameters/district__postcode"},{"$ref":"#/components/parameters/township__priority"},{"$ref":"#/components/parameters/township__city"},{"$ref":"#/components/parameters/township__postcode"},{"$ref":"#/components/parameters/retail_store"},{"$ref":"#/components/parameters/extra_field"},{"$ref":"#/components/parameters/mapping__integration_type"},{"$ref":"#/components/parameters/mapping__code__exact"},{"$ref":"#/components/parameters/hyper"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","description":"Next page URL","nullable":true},"previous":{"type":"string","description":"Previous page URL","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Address"}}}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Create Sales Channel Address

> Create Sales Channel Address for a specific channel.

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}}},"schemas":{"Address":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"type":"integer","description":"Related country ID"},"city":{"type":"integer","description":"Related city ID"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"type":"integer","description":"Related township ID"},"district":{"type":"integer","description":"Related district ID"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"type":"integer","description":"Related retail store ID"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"type":"integer","description":"Related customer ID"},"is_active":{"type":"boolean","description":"Indicates if the address is active"}},"required":["phone_number"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/addresses/":{"post":{"summary":"Create Sales Channel Address","description":"Create Sales Channel Address for a specific channel.","tags":["SalesChannelAddresses"],"parameters":[{"$ref":"#/components/parameters/channel_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"responses":{"201":{"description":"Address Created","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Address"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## List Sales Channel Addresses with details

> List Sales Channel Addresses with details

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"pk__in":{"name":"pk__in","in":"query","description":"Filter by multiple primary key values (comma-separated list of integers)","required":false,"schema":{"type":"array","items":{"type":"integer"}},"style":"form","explode":false},"email":{"name":"email","in":"query","description":"Email address of the customer","required":false,"schema":{"type":"string","format":"email"}},"phone_number":{"name":"phone_number","in":"query","description":"Phone number of the customer","required":false,"schema":{"type":"string"}},"first_name":{"name":"first_name","in":"query","description":"First name of the customer","required":false,"schema":{"type":"string"}},"last_name":{"name":"last_name","in":"query","description":"Last name of the customer","required":false,"schema":{"type":"string"}},"customer":{"name":"customer_id","in":"query","description":"Filter by customer ID.","required":false,"schema":{"type":"integer"}},"country":{"name":"country_id","in":"query","required":false,"description":"Filter by County ID","schema":{"type":"integer","minimum":1}},"township":{"name":"township_id","in":"query","required":false,"description":"Filter by Township ID","schema":{"type":"integer","minimum":1}},"city":{"name":"city_id","in":"query","required":false,"description":"Filter by City ID","schema":{"type":"integer","minimum":1}},"district":{"name":"district_id","in":"query","required":false,"description":"Filter by District ID","schema":{"type":"integer","minimum":1}},"is_active":{"name":"is_active","in":"query","description":"Filter by active status (True or False)","required":false,"schema":{"type":"boolean"}},"postcode":{"name":"postcode","in":"query","required":false,"description":"Filter by Postcode","schema":{"type":"string"}},"line__exact":{"name":"line__exact","in":"query","required":false,"description":"Filters by exact line","schema":{"type":"string"}},"line__iexact":{"name":"line__iexact","in":"query","required":false,"description":"Filters case insensitive by exact line","schema":{"type":"string"}},"line__contains":{"name":"line__contains","in":"query","description":"Filter by line containing the given string","required":false,"schema":{"type":"string"}},"line__icontains":{"name":"line__icontains","in":"query","description":"Filter by line case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"title__exact":{"name":"title__exact","in":"query","required":false,"description":"Filters by exact title","schema":{"type":"string"}},"title__iexact":{"name":"title__iexact","in":"query","required":false,"description":"Filters case insensitive by exact title","schema":{"type":"string"}},"title__contains":{"name":"title__contains","in":"query","description":"Filter by title containing the given string","required":false,"schema":{"type":"string"}},"title__icontains":{"name":"title__icontains","in":"query","description":"Filter by title case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"notes__exact":{"name":"notes__exact","in":"query","required":false,"description":"Filters by exact notes","schema":{"type":"string"}},"notes__iexact":{"name":"notes__iexact","in":"query","required":false,"description":"Filters case insensitive by exact notes","schema":{"type":"string"}},"notes__contains":{"name":"notes__contains","in":"query","description":"Filter by notes containing the given string","required":false,"schema":{"type":"string"}},"notes__icontains":{"name":"notes__icontains","in":"query","description":"Filter by notes case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"company_name__exact":{"name":"company_name__exact","in":"query","required":false,"description":"Filters by exact company_name","schema":{"type":"string"}},"company_name__iexact":{"name":"company_name__iexact","in":"query","required":false,"description":"Filters case insensitive by exact company_name","schema":{"type":"string"}},"company_name__contains":{"name":"company_name__contains","in":"query","description":"Filter by company_name containing the given string","required":false,"schema":{"type":"string"}},"company_name__icontains":{"name":"company_name__icontains","in":"query","description":"Filter by company_name case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"tax_office__exact":{"name":"tax_office__exact","in":"query","required":false,"description":"Filters by exact tax_office","schema":{"type":"string"}},"tax_office__iexact":{"name":"tax_office__iexact","in":"query","required":false,"description":"Filters case insensitive by exact tax_office","schema":{"type":"string"}},"tax_office__contains":{"name":"tax_office__contains","in":"query","description":"Filter by tax_office containing the given string","required":false,"schema":{"type":"string"}},"tax_office__icontains":{"name":"tax_office__icontains","in":"query","description":"Filter by tax_office case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"tax_no__exact":{"name":"tax_no__exact","in":"query","required":false,"description":"Filters by exact tax_no","schema":{"type":"string"}},"tax_no__iexact":{"name":"tax_no__iexact","in":"query","required":false,"description":"Filters case insensitive by exact tax_no","schema":{"type":"string"}},"tax_no__contains":{"name":"tax_no__contains","in":"query","description":"Filter by tax_no containing the given string","required":false,"schema":{"type":"string"}},"tax_no__icontains":{"name":"tax_no__icontains","in":"query","description":"Filter by tax_no case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"hash_data__exact":{"name":"hash_data__exact","in":"query","required":false,"description":"Filters by exact hash_data","schema":{"type":"string"}},"hash_data__iexact":{"name":"hash_data__iexact","in":"query","required":false,"description":"Filters case insensitive by exact hash_data","schema":{"type":"string"}},"hash_data__contains":{"name":"hash_data__contains","in":"query","description":"Filter by hash_data containing the given string","required":false,"schema":{"type":"string"}},"hash_data__icontains":{"name":"hash_data__icontains","in":"query","description":"Filter by hash_data case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"e_bill_taxpayer":{"name":"e_bill_taxpayer","in":"query","description":"Filter by e_bill_taxpayer","required":false,"schema":{"type":"boolean"}},"city__priority":{"name":"city__priority","in":"query","description":"Filter by city's priority","required":false,"schema":{"type":"integer"}},"city__country":{"name":"city__country_id","in":"query","required":false,"description":"Filter by City's County ID","schema":{"type":"integer","minimum":1}},"city__postcode":{"name":"city__postcode","in":"query","required":false,"description":"Filter by City's Postcode","schema":{"type":"string"}},"district__city":{"name":"district__city_id","in":"query","required":false,"description":"Filter by District's City ID","schema":{"type":"integer","minimum":1}},"district__township":{"name":"district__township_id","in":"query","required":false,"description":"Filter by District's Township ID","schema":{"type":"integer","minimum":1}},"district__postcode":{"name":"district__postcode","in":"query","required":false,"description":"Filter by District's Postcode","schema":{"type":"string"}},"township__priority":{"name":"township__priority","in":"query","description":"Filter by township's priority","required":false,"schema":{"type":"integer"}},"township__city":{"name":"township__city_id","in":"query","required":false,"description":"Filter by Township's City ID","schema":{"type":"integer","minimum":1}},"township__postcode":{"name":"township__postcode","in":"query","required":false,"description":"Filter by Township's Postcode","schema":{"type":"string"}},"retail_store":{"name":"retail_store_id","in":"query","required":false,"description":"Filter by Retail Store ID","schema":{"type":"integer","minimum":1}},"extra_field":{"name":"extra_field","in":"query","description":"Filter by extra field attributes","schema":{"type":"object","additionalProperties":true}},"mapping__integration_type":{"name":"mapping__integration_type","in":"query","description":"Filter by integration mapping object's integration type","required":false,"schema":{"type":"string","enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]}},"mapping__code__exact":{"name":"mapping__code__exact","in":"query","description":"Filter by integration mapping object's code","required":false,"schema":{"type":"string"}},"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}}},"schemas":{"AddressDetailed":{"type":"object","properties":{"pk":{"type":"integer","description":"Primary key of the address"},"email":{"type":"string","format":"email","description":"Email address of the contact person"},"phone_number":{"type":"string","description":"Phone number of the contact person"},"first_name":{"type":"string","description":"First name of the contact person"},"last_name":{"type":"string","description":"Last name of the contact person"},"country":{"$ref":"#/components/schemas/Country"},"city":{"$ref":"#/components/schemas/City"},"line":{"type":"string","description":"Street address line"},"title":{"type":"string","description":"Title of the contact person"},"township":{"$ref":"#/components/schemas/Township"},"district":{"$ref":"#/components/schemas/District"},"postcode":{"type":"string","description":"Postal code"},"notes":{"type":"string","description":"Additional notes about the address"},"company_name":{"type":"string","description":"Company name associated with the address"},"tax_office":{"type":"string","description":"Tax office name"},"tax_no":{"type":"string","description":"Tax number"},"e_bill_taxpayer":{"type":"boolean","description":"Indicates if the address is an e-bill taxpayer"},"hash_data":{"type":"string","readOnly":true,"description":"Hash data for the address"},"address_type":{"$ref":"#/components/schemas/AddressType"},"retail_store":{"$ref":"#/components/schemas/RetailStore"},"remote_id":{"type":"string","description":"Remote ID for the address"},"identity_number":{"type":"string","nullable":true,"description":"Identity number of the contact person"},"extra_field":{"type":"object","description":"Extra field for additional data"},"customer":{"$ref":"#/components/schemas/Customer"},"is_active":{"type":"boolean","description":"Indicates if the address is active"},"modified_date":{"type":"string","format":"date-time","description":"Date when the address was last modified"}},"required":["phone_number"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Country ID"},"name":{"type":"string","description":"Country Name"},"code":{"type":"string","description":"Country Code"},"is_active":{"type":"boolean","description":"Is Active (true/false)"},"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"Created Date"},"modified_date":{"type":"string","format":"date-time","readOnly":true,"description":"Modified Date"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}},"required":["name","code"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"AddressType":{"type":"string","description":"Type of address","enum":["customer","retail_store","pickup_location","checkout_provider"]},"RetailStore":{"type":"object","description":"A store that participates in retail sales across multiple channels and store groups.","allOf":[{"$ref":"#/components/schemas/StarterModel"},{"$ref":"#/components/schemas/IntegrationRelation"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier for the retail store."},"name":{"type":"string","description":"Human-readable name of the store."},"township_id":{"type":"integer","description":"ID of the township where the store is located."},"district_id":{"type":"integer","nullable":true,"description":"ID of the district associated with the store (optional)."},"address":{"type":"string","description":"Full address of the store."},"phone_number":{"type":"string","description":"Phone number for the store."},"fax_phone_number":{"type":"string","nullable":true,"description":"Fax number of the store, if applicable."},"image":{"type":"string","format":"uri","nullable":true,"description":"URL to the store’s image."},"store_hours":{"type":"array","description":"Weekly store hours. Each day has a list of time ranges (open and close).","items":{"type":"array","items":{"type":"string","format":"time"}}},"latitude":{"type":"number","format":"float","nullable":true,"description":"Latitude of the store."},"longitude":{"type":"number","format":"float","nullable":true,"description":"Longitude of the store."},"is_active":{"type":"boolean","description":"Whether the store is currently active and visible in the system."},"click_and_collect":{"type":"boolean","description":"Whether click-and-collect is available at this store."},"kapida_enabled":{"type":"boolean","description":"Whether kapıda is enabled."},"fast_delivery":{"type":"boolean","description":"Whether the store supports fast delivery options."},"store_type_id":{"type":"integer","nullable":true,"description":"ID of the store type, used to categorize store behavior."},"config":{"type":"object","additionalProperties":true,"description":"Store-specific configuration object (flexible schema)."},"group_id":{"type":"integer","nullable":true,"description":"ID of the main store group the store belongs to."},"related_retail_stores":{"type":"array","description":"IDs of related or linked retail stores.","items":{"type":"integer"}},"sort_order":{"type":"integer","nullable":true,"description":"Display order or priority for UI sorting."},"is_return_accepted":{"type":"boolean","nullable":true,"description":"Indicates if product returns are accepted at this store."},"channels":{"type":"array","description":"List of channel IDs this store is configured for.","items":{"type":"integer"}},"mapping":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/IntegrationMapping"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"IntegrationRelation":{"type":"object","properties":{"integration":{"type":"array","description":"Integration actions associated with the object.","items":{"$ref":"#/components/schemas/IntegrationAction"}}}},"IntegrationAction":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"content_type":{"$ref":"#/components/schemas/ContentType"},"object_id":{"type":"integer","description":"ID of the related object (used with GenericForeignKey)"},"remote_id":{"type":"string","maxLength":255,"nullable":true},"version_date":{"type":"string","format":"date-time","description":"The version date of the action"},"state":{"type":"object","description":"JSON representation of the state"},"local_batch_id":{"type":"string","maxLength":255,"nullable":true},"status":{"$ref":"#/components/schemas/IntegrationActionStatus"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"}}},"Channel":{"type":"object","required":["name","catalog","channel_type","conf","is_active"],"properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"catalog":{"type":"integer"},"channel_type":{"type":"string","description":"The type of channel. ex: web, distributed, hepsiburada, etc.","enum":["hepsiburada","hepsiburadads","gittigidiyor","n11","web","feed","trendyol","morhipo","morhipoV2","lidyana","amazon","allegro","distributed","aliexpress","emag","ciceksepeti","gordumaldim","pazarama","flo","turkcellds","sales_channel"]},"conf":{"type":"object","description":"A JSON object containing configuration settings for the channel.","additionalProperties":{"type":"string"}},"category_tree":{"type":"string","nullable":true,"description":"The category tree related to this channel."},"is_active":{"type":"boolean","description":"Specifies whether the channel is active.","default":true},"schema":{"type":"object","description":"Additional schema information for the channel.","nullable":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time"}}},"ContentType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Content Type ID"},"app_label":{"type":"string","description":"App label for the content type"},"model":{"type":"string","description":"Model for the content type"}},"required":["app_label","model"]},"IntegrationActionStatus":{"type":"string","enum":["processing","success","error"],"description":"Status of the integration action"},"IntegrationMapping":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true},"content_type":{"type":"integer","description":"Associated content type id"},"object_id":{"type":"integer","description":"Associated content type's object id value"},"content_object":{"type":"object","nullable":true,"description":"Generic foreign key, handled dynamically"},"integration_type":{"type":"string","maxLength":20,"enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]},"code":{"type":"string","maxLength":499,"description":"Code value of integration mapping"}}},"Customer":{"type":"object","properties":{"pk":{"format":"int64","readOnly":true,"description":"Customer ID"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"first_name":{"type":"string","description":"First name of the customer","maxLength":255},"last_name":{"type":"string","description":"Last name of the customer","maxLength":255},"phone_number":{"type":"string","description":"Phone number of the customer","nullable":true,"maxLength":128},"is_active":{"type":"boolean","description":"Indicates if the customer is active","default":false},"channel_code":{"type":"string","description":"Code representing the channel the customer belongs to","maxLength":64},"erp_code":{"type":"string","description":"Partner customer code (ERP code)","nullable":true,"maxLength":64},"attributes":{"type":"object","description":"Attributes as a JSON object"},"attribute_kwargs":{"type":"object","description":"Attribute kwargs as a JSON object"},"localized_attributes":{"type":"object","description":"Localized attributes as a JSON object"},"localized_attribute_kwargs":{"type":"object","description":"Localized attribute kwargs as a JSON object"},"extra_field":{"type":"object","description":"Additional fields as a JSON object"},"email_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving emails"},"sms_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving SMS"},"call_allowed":{"type":"boolean","description":"Indicates if the customer allows receiving calls"},"date_joined":{"type":"string","format":"date-time","description":"The date when the customer joined","nullable":true},"gender":{"type":"string","description":"Gender of the customer","nullable":true,"enum":["male","female"]},"user_type":{"type":"string","description":"Type of user","nullable":true,"enum":["guest","registered"]},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the customer","nullable":true},"channel":{"type":"integer","nullable":true,"description":"ID of the channel the customer belongs to"}},"required":["email","channel_code","is_active","email_allowed","sms_allowed","call_allowed"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/addresses/detailed/":{"get":{"summary":"List Sales Channel Addresses with details","description":"List Sales Channel Addresses with details","tags":["SalesChannelAddresses"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/pk__in"},{"$ref":"#/components/parameters/email"},{"$ref":"#/components/parameters/phone_number"},{"$ref":"#/components/parameters/first_name"},{"$ref":"#/components/parameters/last_name"},{"$ref":"#/components/parameters/customer"},{"$ref":"#/components/parameters/country"},{"$ref":"#/components/parameters/township"},{"$ref":"#/components/parameters/city"},{"$ref":"#/components/parameters/district"},{"$ref":"#/components/parameters/is_active"},{"$ref":"#/components/parameters/postcode"},{"$ref":"#/components/parameters/line__exact"},{"$ref":"#/components/parameters/line__iexact"},{"$ref":"#/components/parameters/line__contains"},{"$ref":"#/components/parameters/line__icontains"},{"$ref":"#/components/parameters/title__exact"},{"$ref":"#/components/parameters/title__iexact"},{"$ref":"#/components/parameters/title__contains"},{"$ref":"#/components/parameters/title__icontains"},{"$ref":"#/components/parameters/notes__exact"},{"$ref":"#/components/parameters/notes__iexact"},{"$ref":"#/components/parameters/notes__contains"},{"$ref":"#/components/parameters/notes__icontains"},{"$ref":"#/components/parameters/company_name__exact"},{"$ref":"#/components/parameters/company_name__iexact"},{"$ref":"#/components/parameters/company_name__contains"},{"$ref":"#/components/parameters/company_name__icontains"},{"$ref":"#/components/parameters/tax_office__exact"},{"$ref":"#/components/parameters/tax_office__iexact"},{"$ref":"#/components/parameters/tax_office__contains"},{"$ref":"#/components/parameters/tax_office__icontains"},{"$ref":"#/components/parameters/tax_no__exact"},{"$ref":"#/components/parameters/tax_no__iexact"},{"$ref":"#/components/parameters/tax_no__contains"},{"$ref":"#/components/parameters/tax_no__icontains"},{"$ref":"#/components/parameters/hash_data__exact"},{"$ref":"#/components/parameters/hash_data__iexact"},{"$ref":"#/components/parameters/hash_data__contains"},{"$ref":"#/components/parameters/hash_data__icontains"},{"$ref":"#/components/parameters/e_bill_taxpayer"},{"$ref":"#/components/parameters/city__priority"},{"$ref":"#/components/parameters/city__country"},{"$ref":"#/components/parameters/city__postcode"},{"$ref":"#/components/parameters/district__city"},{"$ref":"#/components/parameters/district__township"},{"$ref":"#/components/parameters/district__postcode"},{"$ref":"#/components/parameters/township__priority"},{"$ref":"#/components/parameters/township__city"},{"$ref":"#/components/parameters/township__postcode"},{"$ref":"#/components/parameters/retail_store"},{"$ref":"#/components/parameters/extra_field"},{"$ref":"#/components/parameters/mapping__integration_type"},{"$ref":"#/components/parameters/mapping__code__exact"},{"$ref":"#/components/parameters/hyper"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","description":"Next page URL","nullable":true},"previous":{"type":"string","description":"Previous page URL","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/AddressDetailed"}}}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```