> ## Documentation Index > Fetch the complete documentation index at: https://help.experro.com/llms.txt > Use this file to discover all available pages before exploring further. # Published UI Version Details > Fetch detailed configuration and settings for the published UI version of the plug-and-play service. This endpoint returns UI version settings, templates, CSS/JS configurations, and metadata needed to render the storefront interface. Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See [Authentication & Base URLs](/api-reference/authbaseurl). ## OpenAPI ````yaml GET /api/ui-customization/public/v1/versions/published openapi: 3.1.0 info: title: OpenAPI Plant Store description: >- A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification license: name: MIT version: 1.0.0 servers: - url: https://apis.experro.app description: Admin Server - url: https://{base-address} description: Custom Server variables: base-address: default: '' description: Enter your custom domain or server address. security: - bearerAuth: [] paths: /api/ui-customization/public/v1/versions/published: get: summary: Retrieve Published UI Version Details description: >- Fetch detailed configuration and settings for the published UI version of the plug-and-play service. This endpoint returns UI version settings, templates, CSS/JS configurations, and metadata needed to render the storefront interface. parameters: - $ref: '#/components/parameters/LocaleQryPrm' - $ref: '#/components/parameters/FieldsQryPrm' responses: '200': description: Successfully retrieved published UI version details. content: application/json: schema: type: object properties: status: type: string description: Indicates the overall request outcome. data: type: object description: Published UI version data object. properties: id: type: string description: Unique identifier for the UI version. channel_id: type: string description: Channel identifier associated with this UI version. language: type: string description: Language/locale code for this UI version. version_number: type: string description: Semantic version number of the UI version. version_name: type: string description: Human-readable name of the UI version. ui_version_settings: $ref: '#/components/schemas/UI_version_settings_obj' ui_version_storefront_settings: type: object description: Storefront-specific configuration settings. additionalProperties: true is_default: type: boolean description: Whether this is the default UI version. is_published: type: boolean description: Whether this UI version is published and active. created_at: type: string format: date-time description: Timestamp when the UI version was created. created_by: type: string description: >- Email or identifier of the user who created this version. modified_at: type: string format: date-time description: Timestamp when the UI version was last modified. modified_by: type: string description: >- Email or identifier of the user who last modified this version. is_current_ui_version: type: boolean description: Whether this is the currently active UI version. meta: type: object description: >- Additional metadata including templates and translations. properties: templates: type: array description: Array of template objects used in this UI version. items: type: object properties: id: type: string description: Template identifier. name: type: string description: Human-readable template name. version: type: string description: Template version number. translations: type: object description: Localized text translations for UI elements. additionalProperties: type: string additionalProperties: true '401': description: Unauthorized – authentication credentials are missing or invalid. content: application/json: schema: type: object properties: Status: type: string example: failure Data: $ref: '#/components/schemas/Error401' '404': description: Not Found – the requested resource could not be found. content: application/json: schema: type: object properties: Status: type: string example: failure Data: $ref: '#/components/schemas/Error404' '500': description: Internal Server Error – an unexpected error on the server. content: application/json: schema: type: object properties: Status: type: string example: failure Data: $ref: '#/components/schemas/Error500' security: [] servers: - url: https://{base-address} description: Custom Server variables: base-address: default: '' description: Enter your custom domain or server address. components: parameters: LocaleQryPrm: name: locale in: query description: Specifies the language or region for the response data required: true schema: type: string FieldsQryPrm: name: fields in: query description: Comma-separated list of fields to include in the response schema: type: string required: true schemas: UI_version_settings_obj: type: object description: Complete UI configuration settings. additionalProperties: true properties: host_settings: type: object description: Host and endpoint configuration settings. properties: core: type: object description: Core configuration parameters. properties: x_tenant_id: type: string description: Tenant identifier. x_workspace_id: type: string description: Workspace identifier. x_env_id: type: string description: Environment identifier. x_channel_id: type: string description: Channel identifier. x_channel_locale: type: string description: Channel locale setting. base_url: type: string description: Base URL for the service. store_id: type: string description: Store identifier. endpoints: type: object description: API endpoint configurations. properties: analytics_url: type: string description: Analytics service endpoint. search_url: type: string description: Search service endpoint. autocomplete: type: string description: Autocomplete service endpoint. facets: type: string description: Facets service endpoint. ui_version: type: string description: UI version service endpoint. ui_version_list: type: string description: UI version list service endpoint. content_search: type: string description: Content search service endpoint. recommendation: type: string description: Recommendation service endpoint. banners: type: string description: Banners service endpoint. additionalProperties: type: string ecommerce_variables: type: object description: eCommerce platform variables and templates. additionalProperties: true ecommerce_provider: type: string description: eCommerce platform provider (e.g., shopify, magento). selector: type: object description: CSS selector configurations for different views. properties: desktop_view: type: object description: Desktop view selector configurations. properties: autocomplete_input: type: string description: CSS selector for autocomplete input field. autocomplete_result: type: string description: CSS selector for autocomplete results container. search_page: type: string description: CSS selector for search page container. additionalProperties: type: string mobile_view: type: object description: Mobile view selector configurations. properties: autocomplete_input: type: string description: CSS selector for autocomplete input field. autocomplete_result: type: string description: CSS selector for autocomplete results container. search_page: type: string description: CSS selector for search page container. additionalProperties: type: string additionalProperties: true global_assets: type: string description: Global asset configurations. global_css: type: string description: Global CSS configurations. breakpoints: type: object description: Responsive breakpoint configurations. properties: desktop_view: type: object description: Desktop view breakpoint settings. properties: min: type: integer description: Minimum width for desktop view in pixels. max: type: integer description: Maximum width for desktop view in pixels. mobile_view: type: object description: Mobile view breakpoint settings. properties: min: type: integer description: Minimum width for mobile view in pixels. max: type: integer description: Maximum width for mobile view in pixels. additionalProperties: true theme: type: object description: Theme configuration settings. properties: selected_theme: type: string description: Identifier of the currently selected theme. themes: type: array description: Array of available theme configurations. items: type: object additionalProperties: true layout: type: object description: Layout configuration settings. additionalProperties: true search_results: type: object description: Search results configuration settings. additionalProperties: true properties: desktop_view: type: object description: Desktop view layout configuration settings. properties: is_page_layout_enabled: type: boolean description: Whether page layout customization is enabled. page_layout_meta: type: object description: Page layout metadata and configuration. properties: facets_position: type: array description: Available facet position options. items: type: object properties: name: type: string description: >- Position name (e.g., left, right, top, none, custom). image: type: string description: URL to the position preview image. selected_facets_position: type: string description: Currently selected facets position. is_product_grid_layout_enabled: type: boolean description: Whether product grid layout customization is enabled. product_grid_layout_meta: type: object description: Product grid layout configuration. properties: default_product_listing_view: type: array description: Available product listing view options. items: type: object properties: name: type: string description: View type name (e.g., grid_view, list_view). image: type: string description: URL to the view preview image. selected_default_product_listing_view: type: string description: Currently selected product listing view. number_of_products_per_grid_row: type: array description: Available options for products per grid row. items: type: object properties: name: type: string description: Number of products per row. image: type: string description: URL to the grid layout preview image. selected_number_of_products_per_grid_row: type: string description: Currently selected number of products per grid row. pagination_style: type: object description: Pagination style configuration. properties: selected_pagination_style: type: string description: Selected pagination style. infinite_scroll_meta: type: object description: Infinite scroll configuration. properties: selected_scroll_nature: type: string description: Selected scroll behavior. scroll_nature: type: array description: Available scroll behavior options. items: type: object properties: name: type: string description: Scroll behavior name. number_of_products_per_page: type: object description: Range for products per page. properties: min: type: integer description: Minimum products per page. max: type: integer description: Maximum products per page. selected_number_of_products_per_page: type: integer description: Currently selected number of products per page. is_show_product_count_enabled: type: boolean description: Whether to show product count. is_product_card_layout_enabled: type: boolean description: Whether product card layout customization is enabled. product_card_layout_meta: type: object description: Product card layout configuration. properties: product_card_template: type: string description: Product card template type. default_product_thumbnail_image: type: object description: Default product thumbnail image configuration. properties: item: type: string description: URL to the default product image. relative_path: type: string description: Relative path to the image file. file_meta_data: type: object description: File metadata information. properties: name: type: string description: File name. size: type: integer description: File size in bytes. is_require_sign_to_view_enabled: type: boolean description: Whether sign-in is required to view products. possible_product_attributes_to_show_dt: type: array description: Available product attributes that can be displayed. items: type: object properties: name: type: string description: Attribute name. label: type: string description: Attribute display label. product_attributes_to_show_dt: type: array description: Currently configured product attributes to display. items: type: object properties: id: type: string description: Attribute configuration ID. position: type: string description: Display position of the attribute. name: type: string description: Attribute name. is_disabled: type: boolean description: Whether the attribute is disabled. is_fixed: type: boolean description: Whether the attribute position is fixed. config_action_buttons_dt: type: object description: Action buttons configuration for product cards. additionalProperties: true badges_on_product_card_dt: type: object description: Badge configuration for product cards. additionalProperties: true template_editor_ct: type: string description: Custom template editor content. is_sort_options_enabled: type: boolean description: Whether sort options customization is enabled. sort_options_meta: type: object description: Sort options configuration. additionalProperties: true search_result_setting: type: object description: Search result page settings. properties: is_show_search_box_enabled: type: boolean description: Whether to show search box on results page. is_show_content_pages_enabled: type: boolean description: Whether to show content pages in results. search_result_page_url: type: string description: URL for the search results page. no_search_result_setting: type: object description: No search results page settings. properties: no_result_message: type: string description: Message to display when no results are found. is_recommended_fallback_product_enabled: type: boolean description: Whether to show recommended fallback products. recommended_fallback_product_meta: type: object description: Recommended fallback product configuration. additionalProperties: true additionalProperties: true mobile_view: type: object description: Desktop view layout configuration settings. properties: is_page_layout_enabled: type: boolean description: Whether page layout customization is enabled. page_layout_meta: type: object description: Page layout metadata and configuration. properties: facets_position: type: array description: Available facet position options. items: type: object properties: name: type: string description: >- Position name (e.g., left, right, top, none, custom). image: type: string description: URL to the position preview image. selected_facets_position: type: string description: Currently selected facets position. is_product_grid_layout_enabled: type: boolean description: Whether product grid layout customization is enabled. product_grid_layout_meta: type: object description: Product grid layout configuration. properties: default_product_listing_view: type: array description: Available product listing view options. items: type: object properties: name: type: string description: View type name (e.g., grid_view, list_view). image: type: string description: URL to the view preview image. selected_default_product_listing_view: type: string description: Currently selected product listing view. number_of_products_per_grid_row: type: array description: Available options for products per grid row. items: type: object properties: name: type: string description: Number of products per row. image: type: string description: URL to the grid layout preview image. selected_number_of_products_per_grid_row: type: string description: Currently selected number of products per grid row. pagination_style: type: object description: Pagination style configuration. properties: selected_pagination_style: type: string description: Selected pagination style. infinite_scroll_meta: type: object description: Infinite scroll configuration. properties: selected_scroll_nature: type: string description: Selected scroll behavior. scroll_nature: type: array description: Available scroll behavior options. items: type: object properties: name: type: string description: Scroll behavior name. number_of_products_per_page: type: object description: Range for products per page. properties: min: type: integer description: Minimum products per page. max: type: integer description: Maximum products per page. selected_number_of_products_per_page: type: integer description: Currently selected number of products per page. is_show_product_count_enabled: type: boolean description: Whether to show product count. is_product_card_layout_enabled: type: boolean description: Whether product card layout customization is enabled. product_card_layout_meta: type: object description: Product card layout configuration. properties: product_card_template: type: string description: Product card template type. default_product_thumbnail_image: type: object description: Default product thumbnail image configuration. properties: item: type: string description: URL to the default product image. relative_path: type: string description: Relative path to the image file. file_meta_data: type: object description: File metadata information. properties: name: type: string description: File name. size: type: integer description: File size in bytes. is_require_sign_to_view_enabled: type: boolean description: Whether sign-in is required to view products. possible_product_attributes_to_show_dt: type: array description: Available product attributes that can be displayed. items: type: object properties: name: type: string description: Attribute name. label: type: string description: Attribute display label. product_attributes_to_show_dt: type: array description: Currently configured product attributes to display. items: type: object properties: id: type: string description: Attribute configuration ID. position: type: string description: Display position of the attribute. name: type: string description: Attribute name. is_disabled: type: boolean description: Whether the attribute is disabled. is_fixed: type: boolean description: Whether the attribute position is fixed. config_action_buttons_dt: type: object description: Action buttons configuration for product cards. additionalProperties: true badges_on_product_card_dt: type: object description: Badge configuration for product cards. additionalProperties: true template_editor_ct: type: string description: Custom template editor content. is_sort_options_enabled: type: boolean description: Whether sort options customization is enabled. sort_options_meta: type: object description: Sort options configuration. additionalProperties: true search_result_setting: type: object description: Search result page settings. properties: is_show_search_box_enabled: type: boolean description: Whether to show search box on results page. is_show_content_pages_enabled: type: boolean description: Whether to show content pages in results. search_result_page_url: type: string description: URL for the search results page. no_search_result_setting: type: object description: No search results page settings. properties: no_result_message: type: string description: Message to display when no results are found. is_recommended_fallback_product_enabled: type: boolean description: Whether to show recommended fallback products. recommended_fallback_product_meta: type: object description: Recommended fallback product configuration. additionalProperties: true additionalProperties: true autocomplete: type: object description: Autocomplete configuration settings. additionalProperties: true properties: desktop_view: type: object description: Desktop view layout configuration settings. properties: is_page_layout_enabled: type: boolean description: Whether page layout customization is enabled. page_layout_meta: type: object description: Page layout metadata and configuration. properties: facets_position: type: array description: Available facet position options. items: type: object properties: name: type: string description: >- Position name (e.g., left, right, top, none, custom). image: type: string description: URL to the position preview image. selected_facets_position: type: string description: Currently selected facets position. is_product_grid_layout_enabled: type: boolean description: Whether product grid layout customization is enabled. product_grid_layout_meta: type: object description: Product grid layout configuration. properties: default_product_listing_view: type: array description: Available product listing view options. items: type: object properties: name: type: string description: View type name (e.g., grid_view, list_view). image: type: string description: URL to the view preview image. selected_default_product_listing_view: type: string description: Currently selected product listing view. number_of_products_per_grid_row: type: array description: Available options for products per grid row. items: type: object properties: name: type: string description: Number of products per row. image: type: string description: URL to the grid layout preview image. selected_number_of_products_per_grid_row: type: string description: Currently selected number of products per grid row. pagination_style: type: object description: Pagination style configuration. properties: selected_pagination_style: type: string description: Selected pagination style. infinite_scroll_meta: type: object description: Infinite scroll configuration. properties: selected_scroll_nature: type: string description: Selected scroll behavior. scroll_nature: type: array description: Available scroll behavior options. items: type: object properties: name: type: string description: Scroll behavior name. number_of_products_per_page: type: object description: Range for products per page. properties: min: type: integer description: Minimum products per page. max: type: integer description: Maximum products per page. selected_number_of_products_per_page: type: integer description: Currently selected number of products per page. is_show_product_count_enabled: type: boolean description: Whether to show product count. is_product_card_layout_enabled: type: boolean description: Whether product card layout customization is enabled. product_card_layout_meta: type: object description: Product card layout configuration. properties: product_card_template: type: string description: Product card template type. default_product_thumbnail_image: type: object description: Default product thumbnail image configuration. properties: item: type: string description: URL to the default product image. relative_path: type: string description: Relative path to the image file. file_meta_data: type: object description: File metadata information. properties: name: type: string description: File name. size: type: integer description: File size in bytes. is_require_sign_to_view_enabled: type: boolean description: Whether sign-in is required to view products. possible_product_attributes_to_show_dt: type: array description: Available product attributes that can be displayed. items: type: object properties: name: type: string description: Attribute name. label: type: string description: Attribute display label. product_attributes_to_show_dt: type: array description: Currently configured product attributes to display. items: type: object properties: id: type: string description: Attribute configuration ID. position: type: string description: Display position of the attribute. name: type: string description: Attribute name. is_disabled: type: boolean description: Whether the attribute is disabled. is_fixed: type: boolean description: Whether the attribute position is fixed. config_action_buttons_dt: type: object description: Action buttons configuration for product cards. additionalProperties: true badges_on_product_card_dt: type: object description: Badge configuration for product cards. additionalProperties: true template_editor_ct: type: string description: Custom template editor content. is_sort_options_enabled: type: boolean description: Whether sort options customization is enabled. sort_options_meta: type: object description: Sort options configuration. additionalProperties: true search_result_setting: type: object description: Search result page settings. properties: is_show_search_box_enabled: type: boolean description: Whether to show search box on results page. is_show_content_pages_enabled: type: boolean description: Whether to show content pages in results. search_result_page_url: type: string description: URL for the search results page. no_search_result_setting: type: object description: No search results page settings. properties: no_result_message: type: string description: Message to display when no results are found. is_recommended_fallback_product_enabled: type: boolean description: Whether to show recommended fallback products. recommended_fallback_product_meta: type: object description: Recommended fallback product configuration. additionalProperties: true additionalProperties: true mobile_view: type: object description: Desktop view layout configuration settings. properties: is_page_layout_enabled: type: boolean description: Whether page layout customization is enabled. page_layout_meta: type: object description: Page layout metadata and configuration. properties: facets_position: type: array description: Available facet position options. items: type: object properties: name: type: string description: >- Position name (e.g., left, right, top, none, custom). image: type: string description: URL to the position preview image. selected_facets_position: type: string description: Currently selected facets position. is_product_grid_layout_enabled: type: boolean description: Whether product grid layout customization is enabled. product_grid_layout_meta: type: object description: Product grid layout configuration. properties: default_product_listing_view: type: array description: Available product listing view options. items: type: object properties: name: type: string description: View type name (e.g., grid_view, list_view). image: type: string description: URL to the view preview image. selected_default_product_listing_view: type: string description: Currently selected product listing view. number_of_products_per_grid_row: type: array description: Available options for products per grid row. items: type: object properties: name: type: string description: Number of products per row. image: type: string description: URL to the grid layout preview image. selected_number_of_products_per_grid_row: type: string description: Currently selected number of products per grid row. pagination_style: type: object description: Pagination style configuration. properties: selected_pagination_style: type: string description: Selected pagination style. infinite_scroll_meta: type: object description: Infinite scroll configuration. properties: selected_scroll_nature: type: string description: Selected scroll behavior. scroll_nature: type: array description: Available scroll behavior options. items: type: object properties: name: type: string description: Scroll behavior name. number_of_products_per_page: type: object description: Range for products per page. properties: min: type: integer description: Minimum products per page. max: type: integer description: Maximum products per page. selected_number_of_products_per_page: type: integer description: Currently selected number of products per page. is_show_product_count_enabled: type: boolean description: Whether to show product count. is_product_card_layout_enabled: type: boolean description: Whether product card layout customization is enabled. product_card_layout_meta: type: object description: Product card layout configuration. properties: product_card_template: type: string description: Product card template type. default_product_thumbnail_image: type: object description: Default product thumbnail image configuration. properties: item: type: string description: URL to the default product image. relative_path: type: string description: Relative path to the image file. file_meta_data: type: object description: File metadata information. properties: name: type: string description: File name. size: type: integer description: File size in bytes. is_require_sign_to_view_enabled: type: boolean description: Whether sign-in is required to view products. possible_product_attributes_to_show_dt: type: array description: Available product attributes that can be displayed. items: type: object properties: name: type: string description: Attribute name. label: type: string description: Attribute display label. product_attributes_to_show_dt: type: array description: Currently configured product attributes to display. items: type: object properties: id: type: string description: Attribute configuration ID. position: type: string description: Display position of the attribute. name: type: string description: Attribute name. is_disabled: type: boolean description: Whether the attribute is disabled. is_fixed: type: boolean description: Whether the attribute position is fixed. config_action_buttons_dt: type: object description: Action buttons configuration for product cards. additionalProperties: true badges_on_product_card_dt: type: object description: Badge configuration for product cards. additionalProperties: true template_editor_ct: type: string description: Custom template editor content. is_sort_options_enabled: type: boolean description: Whether sort options customization is enabled. sort_options_meta: type: object description: Sort options configuration. additionalProperties: true search_result_setting: type: object description: Search result page settings. properties: is_show_search_box_enabled: type: boolean description: Whether to show search box on results page. is_show_content_pages_enabled: type: boolean description: Whether to show content pages in results. search_result_page_url: type: string description: URL for the search results page. no_search_result_setting: type: object description: No search results page settings. properties: no_result_message: type: string description: Message to display when no results are found. is_recommended_fallback_product_enabled: type: boolean description: Whether to show recommended fallback products. recommended_fallback_product_meta: type: object description: Recommended fallback product configuration. additionalProperties: true additionalProperties: true css_and_js: type: object description: CSS and JavaScript configuration settings. properties: css: type: string description: Custom CSS code for styling the UI components. js: type: string description: Custom JavaScript code for UI behavior and configuration. additionalProperties: true translations: type: object description: Translation configuration settings. properties: system_defined: type: array description: Array of system-defined translation keys. items: type: string theme_defined: type: array description: Array of theme-defined translation keys. items: type: string user_defined: type: array description: Array of user-defined translation keys. items: type: string translations_mapping: type: object description: Mapping of translation keys to their localized values. additionalProperties: type: string additionalProperties: true global_js: type: string description: Global JavaScript configurations. templates: type: object description: Template configuration settings. additionalProperties: true Error401: type: object properties: Status: type: string example: failure Error: type: object properties: message: type: string name: type: string code: type: string required: - message - name required: - Status - Error Error404: type: object properties: Status: type: string example: failure Error: type: object properties: message: type: string name: type: string code: type: string required: - message - name required: - Status - Error Error500: type: object properties: Status: type: string example: failure Error: type: object properties: message: type: string name: type: string code: type: string required: - message - name required: - Status - Error securitySchemes: bearerAuth: type: http scheme: bearer ````