Skip to main content
GET
/
api
/
ui-customization
/
public
/
v1
/
versions
/
published
Retrieve Published UI Version Details
curl --request GET \
  --url https://{base-address}/api/ui-customization/public/v1/versions/published
{
  "status": "<string>",
  "data": {
    "id": "<string>",
    "channel_id": "<string>",
    "language": "<string>",
    "version_number": "<string>",
    "version_name": "<string>",
    "ui_version_settings": {
      "host_settings": {
        "core": {
          "x_tenant_id": "<string>",
          "x_workspace_id": "<string>",
          "x_env_id": "<string>",
          "x_channel_id": "<string>",
          "x_channel_locale": "<string>",
          "base_url": "<string>",
          "store_id": "<string>"
        },
        "endpoints": {
          "analytics_url": "<string>",
          "search_url": "<string>",
          "autocomplete": "<string>",
          "facets": "<string>",
          "ui_version": "<string>",
          "ui_version_list": "<string>",
          "content_search": "<string>",
          "recommendation": "<string>",
          "banners": "<string>"
        }
      },
      "ecommerce_variables": {},
      "ecommerce_provider": "<string>",
      "selector": {
        "desktop_view": {
          "autocomplete_input": "<string>",
          "autocomplete_result": "<string>",
          "search_page": "<string>"
        },
        "mobile_view": {
          "autocomplete_input": "<string>",
          "autocomplete_result": "<string>",
          "search_page": "<string>"
        }
      },
      "global_assets": "<string>",
      "global_css": "<string>",
      "breakpoints": {
        "desktop_view": {
          "min": 123,
          "max": 123
        },
        "mobile_view": {
          "min": 123,
          "max": 123
        }
      },
      "theme": {
        "selected_theme": "<string>",
        "themes": [
          {}
        ]
      },
      "layout": {},
      "search_results": {
        "desktop_view": {
          "is_page_layout_enabled": true,
          "page_layout_meta": {
            "facets_position": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_facets_position": "<string>"
          },
          "is_product_grid_layout_enabled": true,
          "product_grid_layout_meta": {
            "default_product_listing_view": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_default_product_listing_view": "<string>",
            "number_of_products_per_grid_row": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_number_of_products_per_grid_row": "<string>",
            "pagination_style": {
              "selected_pagination_style": "<string>",
              "infinite_scroll_meta": {
                "selected_scroll_nature": "<string>",
                "scroll_nature": [
                  {
                    "name": "<string>"
                  }
                ]
              }
            },
            "number_of_products_per_page": {
              "min": 123,
              "max": 123
            },
            "selected_number_of_products_per_page": 123,
            "is_show_product_count_enabled": true
          },
          "is_product_card_layout_enabled": true,
          "product_card_layout_meta": {
            "product_card_template": "<string>",
            "default_product_thumbnail_image": {
              "item": "<string>",
              "relative_path": "<string>",
              "file_meta_data": {
                "name": "<string>",
                "size": 123
              }
            },
            "is_require_sign_to_view_enabled": true,
            "possible_product_attributes_to_show_dt": [
              {
                "name": "<string>",
                "label": "<string>"
              }
            ],
            "product_attributes_to_show_dt": [
              {
                "id": "<string>",
                "position": "<string>",
                "name": "<string>",
                "is_disabled": true,
                "is_fixed": true
              }
            ],
            "config_action_buttons_dt": {},
            "badges_on_product_card_dt": {},
            "template_editor_ct": "<string>"
          },
          "is_sort_options_enabled": true,
          "sort_options_meta": {},
          "search_result_setting": {
            "is_show_search_box_enabled": true,
            "is_show_content_pages_enabled": true,
            "search_result_page_url": "<string>"
          },
          "no_search_result_setting": {
            "no_result_message": "<string>",
            "is_recommended_fallback_product_enabled": true,
            "recommended_fallback_product_meta": {}
          }
        },
        "mobile_view": {
          "is_page_layout_enabled": true,
          "page_layout_meta": {
            "facets_position": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_facets_position": "<string>"
          },
          "is_product_grid_layout_enabled": true,
          "product_grid_layout_meta": {
            "default_product_listing_view": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_default_product_listing_view": "<string>",
            "number_of_products_per_grid_row": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_number_of_products_per_grid_row": "<string>",
            "pagination_style": {
              "selected_pagination_style": "<string>",
              "infinite_scroll_meta": {
                "selected_scroll_nature": "<string>",
                "scroll_nature": [
                  {
                    "name": "<string>"
                  }
                ]
              }
            },
            "number_of_products_per_page": {
              "min": 123,
              "max": 123
            },
            "selected_number_of_products_per_page": 123,
            "is_show_product_count_enabled": true
          },
          "is_product_card_layout_enabled": true,
          "product_card_layout_meta": {
            "product_card_template": "<string>",
            "default_product_thumbnail_image": {
              "item": "<string>",
              "relative_path": "<string>",
              "file_meta_data": {
                "name": "<string>",
                "size": 123
              }
            },
            "is_require_sign_to_view_enabled": true,
            "possible_product_attributes_to_show_dt": [
              {
                "name": "<string>",
                "label": "<string>"
              }
            ],
            "product_attributes_to_show_dt": [
              {
                "id": "<string>",
                "position": "<string>",
                "name": "<string>",
                "is_disabled": true,
                "is_fixed": true
              }
            ],
            "config_action_buttons_dt": {},
            "badges_on_product_card_dt": {},
            "template_editor_ct": "<string>"
          },
          "is_sort_options_enabled": true,
          "sort_options_meta": {},
          "search_result_setting": {
            "is_show_search_box_enabled": true,
            "is_show_content_pages_enabled": true,
            "search_result_page_url": "<string>"
          },
          "no_search_result_setting": {
            "no_result_message": "<string>",
            "is_recommended_fallback_product_enabled": true,
            "recommended_fallback_product_meta": {}
          }
        }
      },
      "autocomplete": {
        "desktop_view": {
          "is_page_layout_enabled": true,
          "page_layout_meta": {
            "facets_position": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_facets_position": "<string>"
          },
          "is_product_grid_layout_enabled": true,
          "product_grid_layout_meta": {
            "default_product_listing_view": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_default_product_listing_view": "<string>",
            "number_of_products_per_grid_row": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_number_of_products_per_grid_row": "<string>",
            "pagination_style": {
              "selected_pagination_style": "<string>",
              "infinite_scroll_meta": {
                "selected_scroll_nature": "<string>",
                "scroll_nature": [
                  {
                    "name": "<string>"
                  }
                ]
              }
            },
            "number_of_products_per_page": {
              "min": 123,
              "max": 123
            },
            "selected_number_of_products_per_page": 123,
            "is_show_product_count_enabled": true
          },
          "is_product_card_layout_enabled": true,
          "product_card_layout_meta": {
            "product_card_template": "<string>",
            "default_product_thumbnail_image": {
              "item": "<string>",
              "relative_path": "<string>",
              "file_meta_data": {
                "name": "<string>",
                "size": 123
              }
            },
            "is_require_sign_to_view_enabled": true,
            "possible_product_attributes_to_show_dt": [
              {
                "name": "<string>",
                "label": "<string>"
              }
            ],
            "product_attributes_to_show_dt": [
              {
                "id": "<string>",
                "position": "<string>",
                "name": "<string>",
                "is_disabled": true,
                "is_fixed": true
              }
            ],
            "config_action_buttons_dt": {},
            "badges_on_product_card_dt": {},
            "template_editor_ct": "<string>"
          },
          "is_sort_options_enabled": true,
          "sort_options_meta": {},
          "search_result_setting": {
            "is_show_search_box_enabled": true,
            "is_show_content_pages_enabled": true,
            "search_result_page_url": "<string>"
          },
          "no_search_result_setting": {
            "no_result_message": "<string>",
            "is_recommended_fallback_product_enabled": true,
            "recommended_fallback_product_meta": {}
          }
        },
        "mobile_view": {
          "is_page_layout_enabled": true,
          "page_layout_meta": {
            "facets_position": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_facets_position": "<string>"
          },
          "is_product_grid_layout_enabled": true,
          "product_grid_layout_meta": {
            "default_product_listing_view": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_default_product_listing_view": "<string>",
            "number_of_products_per_grid_row": [
              {
                "name": "<string>",
                "image": "<string>"
              }
            ],
            "selected_number_of_products_per_grid_row": "<string>",
            "pagination_style": {
              "selected_pagination_style": "<string>",
              "infinite_scroll_meta": {
                "selected_scroll_nature": "<string>",
                "scroll_nature": [
                  {
                    "name": "<string>"
                  }
                ]
              }
            },
            "number_of_products_per_page": {
              "min": 123,
              "max": 123
            },
            "selected_number_of_products_per_page": 123,
            "is_show_product_count_enabled": true
          },
          "is_product_card_layout_enabled": true,
          "product_card_layout_meta": {
            "product_card_template": "<string>",
            "default_product_thumbnail_image": {
              "item": "<string>",
              "relative_path": "<string>",
              "file_meta_data": {
                "name": "<string>",
                "size": 123
              }
            },
            "is_require_sign_to_view_enabled": true,
            "possible_product_attributes_to_show_dt": [
              {
                "name": "<string>",
                "label": "<string>"
              }
            ],
            "product_attributes_to_show_dt": [
              {
                "id": "<string>",
                "position": "<string>",
                "name": "<string>",
                "is_disabled": true,
                "is_fixed": true
              }
            ],
            "config_action_buttons_dt": {},
            "badges_on_product_card_dt": {},
            "template_editor_ct": "<string>"
          },
          "is_sort_options_enabled": true,
          "sort_options_meta": {},
          "search_result_setting": {
            "is_show_search_box_enabled": true,
            "is_show_content_pages_enabled": true,
            "search_result_page_url": "<string>"
          },
          "no_search_result_setting": {
            "no_result_message": "<string>",
            "is_recommended_fallback_product_enabled": true,
            "recommended_fallback_product_meta": {}
          }
        }
      },
      "css_and_js": {
        "css": "<string>",
        "js": "<string>"
      },
      "translations": {
        "system_defined": [
          "<string>"
        ],
        "theme_defined": [
          "<string>"
        ],
        "user_defined": [
          "<string>"
        ],
        "translations_mapping": {}
      },
      "global_js": "<string>",
      "templates": {}
    },
    "ui_version_storefront_settings": {},
    "is_default": true,
    "is_published": true,
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "modified_at": "2023-11-07T05:31:56Z",
    "modified_by": "<string>",
    "is_current_ui_version": true,
    "meta": {
      "templates": [
        {
          "id": "<string>",
          "name": "<string>",
          "version": "<string>"
        }
      ],
      "translations": {}
    }
  }
}
Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See Authentication & Base URLs.

Query Parameters

​
locale
string
required

Specifies the language or region for the response data

​
fields
string
required

Comma-separated list of fields to include in the response

Response

Successfully retrieved published UI version details.

​
status
string

Indicates the overall request outcome.

​
data
object

Published UI version data object.