# Applications

## Retrieve Application

> Retrieve a specific Application 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":{"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"Application":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string","maxLength":100},"application_type":{"type":"string","enum":["oms","instore","commerce","zero","live-commerce","live-commerce-landing-page","omnitron-frontend","sales-channel","bi-tool","integrator","ui-protocol","invoicer","extension","seller_center_be","seller_center_fe","cargo_extension","b2b_extension","integration"],"description":"Enum value for the type of application"},"config":{"type":"object","description":"Configuration for the application in JSON format. Config contains various properties, including `visible_type` Used to set the application visibility as `fullpage`, `plugin`, or `empty`. This is relevant for `ui-protocol` applications. Default value is `empty` if not provided.","nullable":true,"additionalProperties":true},"is_active":{"type":"boolean","default":true},"remote_object_id":{"type":"integer","nullable":true},"created_by":{"type":"integer","nullable":true,"description":"ID of the user who created the application"},"is_visible":{"type":"boolean","description":"Default value is `False`. `is_visible` determines if the application should be visible on the user interface (Omnitron FE). The application will be visible if this flag is set to `True`.","default":false},"is_proxy_available":{"type":"boolean","description":"Specifies whether requests to the `api/v1/app_proxy/` endpoint should be forwarded to the related application via proxy. Default value is `False`. If set to `False`, no proxy forwarding is done, and users receive an HTTP 404. If `is_proxy_available=True`, requests are forwarded to the application's `web_url` in the config.","default":false},"related_application_id":{"type":"string","nullable":true,"maxLength":255,"description":"The `related_application_id` field stores the associated extension ID from ACC for the Omnitron application. It can be filtered using the `related_application_id__iexact` parameter, and it accepts up to 255 characters."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the application was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the application was last modified"}},"required":["name","application_type","is_active","is_visible","is_proxy_available"]}},"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/applications/{id}/":{"get":{"summary":"Retrieve Application","description":"Retrieve a specific Application by ID","tags":["Applications"],"parameters":[{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"Application retrieved successfully","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Application"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Update Application

> Update a specific Application 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":{"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"Application":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string","maxLength":100},"application_type":{"type":"string","enum":["oms","instore","commerce","zero","live-commerce","live-commerce-landing-page","omnitron-frontend","sales-channel","bi-tool","integrator","ui-protocol","invoicer","extension","seller_center_be","seller_center_fe","cargo_extension","b2b_extension","integration"],"description":"Enum value for the type of application"},"config":{"type":"object","description":"Configuration for the application in JSON format. Config contains various properties, including `visible_type` Used to set the application visibility as `fullpage`, `plugin`, or `empty`. This is relevant for `ui-protocol` applications. Default value is `empty` if not provided.","nullable":true,"additionalProperties":true},"is_active":{"type":"boolean","default":true},"remote_object_id":{"type":"integer","nullable":true},"created_by":{"type":"integer","nullable":true,"description":"ID of the user who created the application"},"is_visible":{"type":"boolean","description":"Default value is `False`. `is_visible` determines if the application should be visible on the user interface (Omnitron FE). The application will be visible if this flag is set to `True`.","default":false},"is_proxy_available":{"type":"boolean","description":"Specifies whether requests to the `api/v1/app_proxy/` endpoint should be forwarded to the related application via proxy. Default value is `False`. If set to `False`, no proxy forwarding is done, and users receive an HTTP 404. If `is_proxy_available=True`, requests are forwarded to the application's `web_url` in the config.","default":false},"related_application_id":{"type":"string","nullable":true,"maxLength":255,"description":"The `related_application_id` field stores the associated extension ID from ACC for the Omnitron application. It can be filtered using the `related_application_id__iexact` parameter, and it accepts up to 255 characters."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the application was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the application was last modified"}},"required":["name","application_type","is_active","is_visible","is_proxy_available"]}},"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/applications/{id}/":{"put":{"summary":"Update Application","description":"Update a specific Application by ID","tags":["Applications"],"parameters":[{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"responses":{"200":{"description":"Application updated successfully"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Soft Delete Application

> Soft delete a specific Application by setting is\_active=False instead of removing the record.

```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":{"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/applications/{id}/":{"delete":{"summary":"Soft Delete Application","description":"Soft delete a specific Application by setting is_active=False instead of removing the record.","tags":["Applications"],"parameters":[{"$ref":"#/components/parameters/id_path"}],"responses":{"204":{"description":"No Content - Application deactivated successfully"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Partial Update Application

> Partial update a specific Application 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":{"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"Application":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string","maxLength":100},"application_type":{"type":"string","enum":["oms","instore","commerce","zero","live-commerce","live-commerce-landing-page","omnitron-frontend","sales-channel","bi-tool","integrator","ui-protocol","invoicer","extension","seller_center_be","seller_center_fe","cargo_extension","b2b_extension","integration"],"description":"Enum value for the type of application"},"config":{"type":"object","description":"Configuration for the application in JSON format. Config contains various properties, including `visible_type` Used to set the application visibility as `fullpage`, `plugin`, or `empty`. This is relevant for `ui-protocol` applications. Default value is `empty` if not provided.","nullable":true,"additionalProperties":true},"is_active":{"type":"boolean","default":true},"remote_object_id":{"type":"integer","nullable":true},"created_by":{"type":"integer","nullable":true,"description":"ID of the user who created the application"},"is_visible":{"type":"boolean","description":"Default value is `False`. `is_visible` determines if the application should be visible on the user interface (Omnitron FE). The application will be visible if this flag is set to `True`.","default":false},"is_proxy_available":{"type":"boolean","description":"Specifies whether requests to the `api/v1/app_proxy/` endpoint should be forwarded to the related application via proxy. Default value is `False`. If set to `False`, no proxy forwarding is done, and users receive an HTTP 404. If `is_proxy_available=True`, requests are forwarded to the application's `web_url` in the config.","default":false},"related_application_id":{"type":"string","nullable":true,"maxLength":255,"description":"The `related_application_id` field stores the associated extension ID from ACC for the Omnitron application. It can be filtered using the `related_application_id__iexact` parameter, and it accepts up to 255 characters."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the application was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the application was last modified"}},"required":["name","application_type","is_active","is_visible","is_proxy_available"]}},"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/applications/{id}/":{"patch":{"summary":"Partial Update Application","description":"Partial update a specific Application by ID","tags":["Applications"],"parameters":[{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"responses":{"200":{"description":"Application partially updated successfully"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## List Applications

> List all Applications

```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":{"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}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"application_type":{"name":"application_type","in":"query","description":"Filter by application type","required":false,"schema":{"type":"string","enum":["oms","instore","commerce","zero","live-commerce","live-commerce-landing-page","omnitron-frontend","sales-channel","bi-tool","integrator","ui-protocol","invoicer","extension","seller_center_be","seller_center_fe","cargo_extension","b2b_extension","integration"]}},"is_active":{"name":"is_active","in":"query","description":"Filter by active status (True or False)","required":false,"schema":{"type":"boolean"}},"name__contains":{"name":"name__contains","in":"query","description":"Filter by name containing the given string","required":false,"schema":{"type":"string"}},"name__icontains":{"name":"name__icontains","in":"query","description":"Filter by name case-insensitive containing the given string","required":false,"schema":{"type":"string"}},"related_application_id__iexact":{"name":"related_application_id__iexact","in":"query","description":"Filter by related application ID (case-insensitive exact match)","required":false,"schema":{"type":"string"}}},"schemas":{"Application":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string","maxLength":100},"application_type":{"type":"string","enum":["oms","instore","commerce","zero","live-commerce","live-commerce-landing-page","omnitron-frontend","sales-channel","bi-tool","integrator","ui-protocol","invoicer","extension","seller_center_be","seller_center_fe","cargo_extension","b2b_extension","integration"],"description":"Enum value for the type of application"},"config":{"type":"object","description":"Configuration for the application in JSON format. Config contains various properties, including `visible_type` Used to set the application visibility as `fullpage`, `plugin`, or `empty`. This is relevant for `ui-protocol` applications. Default value is `empty` if not provided.","nullable":true,"additionalProperties":true},"is_active":{"type":"boolean","default":true},"remote_object_id":{"type":"integer","nullable":true},"created_by":{"type":"integer","nullable":true,"description":"ID of the user who created the application"},"is_visible":{"type":"boolean","description":"Default value is `False`. `is_visible` determines if the application should be visible on the user interface (Omnitron FE). The application will be visible if this flag is set to `True`.","default":false},"is_proxy_available":{"type":"boolean","description":"Specifies whether requests to the `api/v1/app_proxy/` endpoint should be forwarded to the related application via proxy. Default value is `False`. If set to `False`, no proxy forwarding is done, and users receive an HTTP 404. If `is_proxy_available=True`, requests are forwarded to the application's `web_url` in the config.","default":false},"related_application_id":{"type":"string","nullable":true,"maxLength":255,"description":"The `related_application_id` field stores the associated extension ID from ACC for the Omnitron application. It can be filtered using the `related_application_id__iexact` parameter, and it accepts up to 255 characters."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the application was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the application was last modified"}},"required":["name","application_type","is_active","is_visible","is_proxy_available"]}},"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."}}}}}},"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/applications/":{"get":{"summary":"List Applications","description":"List all Applications","tags":["Applications"],"parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/application_type"},{"$ref":"#/components/parameters/is_active"},{"$ref":"#/components/parameters/name__contains"},{"$ref":"#/components/parameters/name__icontains"},{"$ref":"#/components/parameters/related_application_id__iexact"}],"responses":{"200":{"description":"List of Applications","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Application"}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Create Application

> Creates a new Application object.

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Application":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string","maxLength":100},"application_type":{"type":"string","enum":["oms","instore","commerce","zero","live-commerce","live-commerce-landing-page","omnitron-frontend","sales-channel","bi-tool","integrator","ui-protocol","invoicer","extension","seller_center_be","seller_center_fe","cargo_extension","b2b_extension","integration"],"description":"Enum value for the type of application"},"config":{"type":"object","description":"Configuration for the application in JSON format. Config contains various properties, including `visible_type` Used to set the application visibility as `fullpage`, `plugin`, or `empty`. This is relevant for `ui-protocol` applications. Default value is `empty` if not provided.","nullable":true,"additionalProperties":true},"is_active":{"type":"boolean","default":true},"remote_object_id":{"type":"integer","nullable":true},"created_by":{"type":"integer","nullable":true,"description":"ID of the user who created the application"},"is_visible":{"type":"boolean","description":"Default value is `False`. `is_visible` determines if the application should be visible on the user interface (Omnitron FE). The application will be visible if this flag is set to `True`.","default":false},"is_proxy_available":{"type":"boolean","description":"Specifies whether requests to the `api/v1/app_proxy/` endpoint should be forwarded to the related application via proxy. Default value is `False`. If set to `False`, no proxy forwarding is done, and users receive an HTTP 404. If `is_proxy_available=True`, requests are forwarded to the application's `web_url` in the config.","default":false},"related_application_id":{"type":"string","nullable":true,"maxLength":255,"description":"The `related_application_id` field stores the associated extension ID from ACC for the Omnitron application. It can be filtered using the `related_application_id__iexact` parameter, and it accepts up to 255 characters."},"created_date":{"type":"string","format":"date-time","description":"The date and time when the application was created"},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the application was last modified"}},"required":["name","application_type","is_active","is_visible","is_proxy_available"]}},"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."}}}}}},"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/applications/":{"post":{"summary":"Create Application","description":"Creates a new Application object.","tags":["Applications"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"responses":{"201":{"description":"Country Created","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Application"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```