# SalesChannelRetailStore ## Remove districts from a store > Remove one or more districts from the specified retail store. ```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"}},"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}}},"schemas":{"SalesChannelRetailStoreDistrictsSerializer":{"$ref":"#/components/schemas/RetailStoreDistrictsSerializer"},"RetailStoreDistrictsSerializer":{"type":"object","description":"A request to add or remove districts from a retail store.","properties":{"districts":{"type":"array","items":{"type":"integer"}}},"required":["districts"]},"SalesChannelRetailStoreSerializer":{"$ref":"#/components/schemas/RetailStoreSerializer"},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"403":{"description":"Forbidden"},"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}/retail_stores/{id}/remove_districts/":{"post":{"summary":"Remove districts from a store","description":"Remove one or more districts from the specified retail store.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/hyper"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreDistrictsSerializer"}}}},"responses":{"200":{"description":"District successfully removed from the retail store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreSerializer"}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Get retail store by ID > Retrieve detailed information about a specific retail store. ```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":{"SalesChannelRetailStoreSerializer":{"$ref":"#/components/schemas/RetailStoreSerializer"},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"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."}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/retail_stores/{id}":{"get":{"summary":"Get retail store by ID","description":"Retrieve detailed information about a specific retail store.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Retail store details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreSerializer"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Fully update a retail store > Fully update the details of a specific retail store associated with a sales 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"}}},"schemas":{"SalesChannelRetailStoreSerializer":{"$ref":"#/components/schemas/RetailStoreSerializer"},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"403":{"description":"Forbidden"},"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}/retail_stores/{id}":{"put":{"summary":"Fully update a retail store","description":"Fully update the details of a specific retail store associated with a sales channel.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreSerializer"}}}},"responses":{"200":{"description":"Successfully updated the retail store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreSerializer"}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Partially update a retail store > Partially update the details of a specific retail store associated with a sales 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"}}},"schemas":{"SalesChannelRetailStoreSerializer":{"$ref":"#/components/schemas/RetailStoreSerializer"},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"403":{"description":"Forbidden"},"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}/retail_stores/{id}":{"patch":{"summary":"Partially update a retail store","description":"Partially update the details of a specific retail store associated with a sales channel.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreSerializer"}}}},"responses":{"200":{"description":"Successfully partially updated the retail store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreSerializer"}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Get detailed retail store by ID > Retrieve detailed information about a specific retail store. ```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":{"SalesChannelRetailStoreDetailedSerializer":{"$ref":"#/components/schemas/RetailStoreSerializerDetailed"},"RetailStoreSerializerDetailed":{"allOf":[{"$ref":"#/components/schemas/RetailStoreSerializer"}],"properties":{"township":{"$ref":"#/components/schemas/TownshipDetailed"},"district":{"$ref":"#/components/schemas/District"}}},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"TownshipDetailed":{"allOf":[{"$ref":"#/components/schemas/Township"}],"properties":{"city":{"$ref":"#/components/schemas/City"}}},"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."}}},"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"]},"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"]}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"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."}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/retail_stores/{id}/detailed/":{"get":{"summary":"Get detailed retail store by ID","description":"Retrieve detailed information about a specific retail store.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Detailed retail store information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreDetailedSerializer"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Bulk add retail store to store groups > Adds all retail stores to a group asynchronously. ```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"}},"click_and_collect":{"name":"click_and_collect","in":"query","description":"Filter by click-and-collect availability.","required":false,"schema":{"type":"boolean"}},"erp_code":{"name":"erp_code","in":"query","description":"Filter by ERP code (contains)","required":false,"schema":{"type":"string"}},"erp_code_iexact":{"name":"erp_code_iexact","in":"query","description":"Filter by exact ERP code (case-insensitive)","required":false,"schema":{"type":"string"}},"erp_code__in":{"name":"erp_code__in","in":"query","description":"Filter by multiple ERP codes (comma-separated list)","required":false,"schema":{"type":"array","items":{"type":"string"}}},"township":{"name":"township_id","in":"query","required":false,"description":"Filter by Township ID","schema":{"type":"integer","minimum":1}},"country":{"name":"country_id","in":"query","required":false,"description":"Filter by County ID","schema":{"type":"integer","minimum":1}},"city":{"name":"city_id","in":"query","required":false,"description":"Filter by City ID","schema":{"type":"integer","minimum":1}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"kapida_enabled":{"name":"kapida_enabled","in":"query","description":"Filter by kapıda enabled status.","required":false,"schema":{"type":"boolean"}},"fast_delivery":{"name":"fast_delivery","in":"query","description":"Filter by fast delivery availability.","required":false,"schema":{"type":"boolean"}},"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"]}},"related_retail_store_excluded":{"name":"related_retail_store_excluded","in":"query","description":"Exclude the specified store and all stores related to it.","schema":{"type":"integer"}},"retail_store_excluded":{"name":"retail_store_excluded","in":"query","description":"Exclude the specified store and all stores for which it is a related store.","schema":{"type":"integer"}},"retail_store_group":{"name":"retail_store_group","in":"query","description":"Filter by store group ID.","required":false,"schema":{"type":"integer"}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"403":{"description":"Forbidden"},"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}/retail_stores/bulk_add_store_group/":{"post":{"summary":"Bulk add retail store to store groups","description":"Adds all retail stores to a group asynchronously.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/click_and_collect"},{"$ref":"#/components/parameters/erp_code"},{"$ref":"#/components/parameters/erp_code_iexact"},{"$ref":"#/components/parameters/erp_code__in"},{"$ref":"#/components/parameters/township"},{"$ref":"#/components/parameters/country"},{"$ref":"#/components/parameters/city"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/kapida_enabled"},{"$ref":"#/components/parameters/fast_delivery"},{"$ref":"#/components/parameters/mapping__integration_type"},{"$ref":"#/components/parameters/related_retail_store_excluded"},{"$ref":"#/components/parameters/retail_store_excluded"},{"$ref":"#/components/parameters/retail_store_group"}],"responses":{"200":{"description":"Successfully added all retail stores to the group.","content":{"application/json":{"schema":{"type":"object","properties":{"cache_key":{"type":"string","description":"Cache key for the operation."}}}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Deactivate a retail store > Deactivate a specific retail store associated with a sales 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":{"403":{"description":"Forbidden"},"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}/retail_stores/{id}/":{"delete":{"summary":"Deactivate a retail store","description":"Deactivate a specific retail store associated with a sales channel.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"204":{"description":"Successfully deleted the retail store."},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Add districts to a store > Add one or more districts to the specified retail store. ```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"}},"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}}},"schemas":{"SalesChannelRetailStoreDistrictsSerializer":{"$ref":"#/components/schemas/RetailStoreDistrictsSerializer"},"RetailStoreDistrictsSerializer":{"type":"object","description":"A request to add or remove districts from a retail store.","properties":{"districts":{"type":"array","items":{"type":"integer"}}},"required":["districts"]},"SalesChannelRetailStoreSerializer":{"$ref":"#/components/schemas/RetailStoreSerializer"},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"403":{"description":"Forbidden"},"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}/retails_stores/{id}/add_districts/":{"post":{"summary":"Add districts to a store","description":"Add one or more districts to the specified retail store.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/hyper"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreDistrictsSerializer"}}}},"responses":{"200":{"description":"District successfully added to the retail store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreSerializer"}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## List retail stores > Returns a list of all retail stores. ```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"}},"click_and_collect":{"name":"click_and_collect","in":"query","description":"Filter by click-and-collect availability.","required":false,"schema":{"type":"boolean"}},"erp_code":{"name":"erp_code","in":"query","description":"Filter by ERP code (contains)","required":false,"schema":{"type":"string"}},"erp_code_iexact":{"name":"erp_code_iexact","in":"query","description":"Filter by exact ERP code (case-insensitive)","required":false,"schema":{"type":"string"}},"erp_code__in":{"name":"erp_code__in","in":"query","description":"Filter by multiple ERP codes (comma-separated list)","required":false,"schema":{"type":"array","items":{"type":"string"}}},"township":{"name":"township_id","in":"query","required":false,"description":"Filter by Township ID","schema":{"type":"integer","minimum":1}},"country":{"name":"country_id","in":"query","required":false,"description":"Filter by County ID","schema":{"type":"integer","minimum":1}},"city":{"name":"city_id","in":"query","required":false,"description":"Filter by City ID","schema":{"type":"integer","minimum":1}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"kapida_enabled":{"name":"kapida_enabled","in":"query","description":"Filter by kapıda enabled status.","required":false,"schema":{"type":"boolean"}},"fast_delivery":{"name":"fast_delivery","in":"query","description":"Filter by fast delivery availability.","required":false,"schema":{"type":"boolean"}},"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"]}},"related_retail_store_excluded":{"name":"related_retail_store_excluded","in":"query","description":"Exclude the specified store and all stores related to it.","schema":{"type":"integer"}},"retail_store_excluded":{"name":"retail_store_excluded","in":"query","description":"Exclude the specified store and all stores for which it is a related store.","schema":{"type":"integer"}},"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}}},"schemas":{"SalesChannelRetailStoreSerializer":{"$ref":"#/components/schemas/RetailStoreSerializer"},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"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."}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/retail_stores/":{"get":{"summary":"List retail stores","description":"Returns a list of all retail stores.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/click_and_collect"},{"$ref":"#/components/parameters/erp_code"},{"$ref":"#/components/parameters/erp_code_iexact"},{"$ref":"#/components/parameters/erp_code__in"},{"$ref":"#/components/parameters/township"},{"$ref":"#/components/parameters/country"},{"$ref":"#/components/parameters/city"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/kapida_enabled"},{"$ref":"#/components/parameters/fast_delivery"},{"$ref":"#/components/parameters/mapping__integration_type"},{"$ref":"#/components/parameters/related_retail_store_excluded"},{"$ref":"#/components/parameters/retail_store_excluded"},{"$ref":"#/components/parameters/hyper"}],"responses":{"200":{"description":"A list of retail stores.","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of items"},"next":{"type":"string","nullable":true,"description":"URL for next page"},"previous":{"type":"string","nullable":true,"description":"URL for previous page"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannelRetailStoreSerializer"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Create a new retail store > Create a new retail store associated with a specific sales 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":{"SalesChannelRetailStoreSerializer":{"$ref":"#/components/schemas/RetailStoreSerializer"},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"403":{"description":"Forbidden"},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/retail_stores/":{"post":{"summary":"Create a new retail store","description":"Create a new retail store associated with a specific sales channel.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreSerializer"}}}},"responses":{"201":{"description":"Retail store created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelRetailStoreSerializer"}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## List detailed retail stores > Returns a list of all retail stores with detailed information. ```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"}},"click_and_collect":{"name":"click_and_collect","in":"query","description":"Filter by click-and-collect availability.","required":false,"schema":{"type":"boolean"}},"erp_code":{"name":"erp_code","in":"query","description":"Filter by ERP code (contains)","required":false,"schema":{"type":"string"}},"erp_code_iexact":{"name":"erp_code_iexact","in":"query","description":"Filter by exact ERP code (case-insensitive)","required":false,"schema":{"type":"string"}},"erp_code__in":{"name":"erp_code__in","in":"query","description":"Filter by multiple ERP codes (comma-separated list)","required":false,"schema":{"type":"array","items":{"type":"string"}}},"township":{"name":"township_id","in":"query","required":false,"description":"Filter by Township ID","schema":{"type":"integer","minimum":1}},"country":{"name":"country_id","in":"query","required":false,"description":"Filter by County ID","schema":{"type":"integer","minimum":1}},"city":{"name":"city_id","in":"query","required":false,"description":"Filter by City ID","schema":{"type":"integer","minimum":1}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"kapida_enabled":{"name":"kapida_enabled","in":"query","description":"Filter by kapıda enabled status.","required":false,"schema":{"type":"boolean"}},"fast_delivery":{"name":"fast_delivery","in":"query","description":"Filter by fast delivery availability.","required":false,"schema":{"type":"boolean"}},"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"]}},"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}}},"schemas":{"SalesChannelRetailStoreDetailedSerializer":{"$ref":"#/components/schemas/RetailStoreSerializerDetailed"},"RetailStoreSerializerDetailed":{"allOf":[{"$ref":"#/components/schemas/RetailStoreSerializer"}],"properties":{"township":{"$ref":"#/components/schemas/TownshipDetailed"},"district":{"$ref":"#/components/schemas/District"}}},"RetailStoreSerializer":{"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."},"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"}},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true}}},"TownshipDetailed":{"allOf":[{"$ref":"#/components/schemas/Township"}],"properties":{"city":{"$ref":"#/components/schemas/City"}}},"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."}}},"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"]},"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"]}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"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."}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/retail_stores/detailed/":{"get":{"summary":"List detailed retail stores","description":"Returns a list of all retail stores with detailed information.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/click_and_collect"},{"$ref":"#/components/parameters/erp_code"},{"$ref":"#/components/parameters/erp_code_iexact"},{"$ref":"#/components/parameters/erp_code__in"},{"$ref":"#/components/parameters/township"},{"$ref":"#/components/parameters/country"},{"$ref":"#/components/parameters/city"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/kapida_enabled"},{"$ref":"#/components/parameters/fast_delivery"},{"$ref":"#/components/parameters/mapping__integration_type"},{"$ref":"#/components/parameters/hyper"}],"responses":{"200":{"description":"A list of detailed retail stores.","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of items"},"next":{"type":"string","nullable":true,"description":"URL for next page"},"previous":{"type":"string","nullable":true,"description":"URL for previous page"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannelRetailStoreDetailedSerializer"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Bulk remove retail stores from store group > Removes all retail stores from a group asynchronously. ```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"}},"click_and_collect":{"name":"click_and_collect","in":"query","description":"Filter by click-and-collect availability.","required":false,"schema":{"type":"boolean"}},"erp_code":{"name":"erp_code","in":"query","description":"Filter by ERP code (contains)","required":false,"schema":{"type":"string"}},"erp_code_iexact":{"name":"erp_code_iexact","in":"query","description":"Filter by exact ERP code (case-insensitive)","required":false,"schema":{"type":"string"}},"erp_code__in":{"name":"erp_code__in","in":"query","description":"Filter by multiple ERP codes (comma-separated list)","required":false,"schema":{"type":"array","items":{"type":"string"}}},"township":{"name":"township_id","in":"query","required":false,"description":"Filter by Township ID","schema":{"type":"integer","minimum":1}},"country":{"name":"country_id","in":"query","required":false,"description":"Filter by County ID","schema":{"type":"integer","minimum":1}},"city":{"name":"city_id","in":"query","required":false,"description":"Filter by City ID","schema":{"type":"integer","minimum":1}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"kapida_enabled":{"name":"kapida_enabled","in":"query","description":"Filter by kapıda enabled status.","required":false,"schema":{"type":"boolean"}},"fast_delivery":{"name":"fast_delivery","in":"query","description":"Filter by fast delivery availability.","required":false,"schema":{"type":"boolean"}},"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"]}},"related_retail_store_excluded":{"name":"related_retail_store_excluded","in":"query","description":"Exclude the specified store and all stores related to it.","schema":{"type":"integer"}},"retail_store_group":{"name":"retail_store_group","in":"query","description":"Filter by store group ID.","required":false,"schema":{"type":"integer"}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"403":{"description":"Forbidden"},"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}/retail_stores/bulk_remove_store_group/":{"post":{"summary":"Bulk remove retail stores from store group","description":"Removes all retail stores from a group asynchronously.","tags":["SalesChannelRetailStore"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/click_and_collect"},{"$ref":"#/components/parameters/erp_code"},{"$ref":"#/components/parameters/erp_code_iexact"},{"$ref":"#/components/parameters/erp_code__in"},{"$ref":"#/components/parameters/township"},{"$ref":"#/components/parameters/country"},{"$ref":"#/components/parameters/city"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/kapida_enabled"},{"$ref":"#/components/parameters/fast_delivery"},{"$ref":"#/components/parameters/mapping__integration_type"},{"$ref":"#/components/parameters/related_retail_store_excluded"},{"$ref":"#/components/parameters/retail_store_group"}],"responses":{"200":{"description":"Successfully removed all retail stores from the group.","content":{"application/json":{"schema":{"type":"object","properties":{"cache_key":{"type":"string","description":"Cache key for the operation."}}}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://apidocs.akinon.com/omnitron-openapis/saleschannelretailstore.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.