Retrieve a theme by ID
get
/ccadmin/v1/themes/{id}
Returns a particular theme by the ID specified.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the theme.
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : getTheme_response
Type:
Show Source
object
-
associatedSites(optional):
string
Lists the sites which have this as their configured theme.
-
clone_parent_id(optional):
string
Clone parent id of the theme.
-
clone_parent_name(optional):
string
Clone parent name of the theme.
-
compilationStatuses(optional):
string
Indicates status of recent theme compilations for this theme.
-
id(optional):
string
The ID of the theme.
-
is_active(optional):
boolean
Whether theme is active.
-
is_custom(optional):
boolean
Whether theme is custom or not.
-
is_default(optional):
boolean
Indicates if this is the default theme. Only one will have this set to true. By default this will be Cloud Lake Theme.
-
isAgentTheme(optional):
boolean
Indicates if this is the theme used in the Agent UI. There is only one Agent theme on the system.
-
name(optional):
string
Theme name.
-
notes(optional):
string
Notes of the theme.
-
repositoryId(optional):
string
Repository ID of the theme.
-
theme_additional_fonts(optional):
string
Lists additional fonts configured for the theme.
-
theme_styles_color(optional):
object theme_styles_color
Color information of theme styles.
-
theme_styles_general(optional):
object theme_styles_general
General information of theme styles.
-
theme_styles_typography(optional):
object theme_styles_typography
Typography information of theme styles.
-
thumbnail(optional):
string
Optional thumbnail image of the theme.
-
usingCodeView(optional):
boolean
Indicates if Code View has been used to configure the theme.
Nested Schema : theme_styles_color
Type:
object
Color information of theme styles.
Show Source
-
@ButtonPrimaryBackgroundColor(optional):
string
Button Primary Background Color
-
@ButtonPrimaryBorderRadius(optional):
string
Button Primary Border Radius
-
@ButtonPrimaryFontFamily(optional):
string
Button Primary Font Family
-
@ButtonPrimaryFontStyle(optional):
string
Button Primary Font Style
-
@ButtonPrimaryFontWeight(optional):
string
Button Primary Font Weight
-
@ButtonPrimarySize(optional):
string
Button Primary Size
-
@ButtonPrimaryTextColor(optional):
string
-
@ButtonPrimaryTextDecoration(optional):
string
Button Primary Text Decoration
-
@ButtonPrimaryUseGradient(optional):
string
Button Primary Use Gradient
-
@ButtonSecondaryBackgroundColor(optional):
string
Button Secondary Background Color
-
@ButtonSecondaryBorderRadius(optional):
string
Button Secondary Border Radius
-
@ButtonSecondaryFontFamily(optional):
string
Button Secondary Font Family
-
@ButtonSecondaryFontStyle(optional):
string
Button Secondary Font Style
-
@ButtonSecondaryFontWeight(optional):
string
Button Secondary Font Weight
-
@ButtonSecondarySize(optional):
string
Button Secondary Size
-
@ButtonSecondaryTextColor(optional):
string
Button Secondary Text Color
-
@ButtonSecondaryTextDecoration(optional):
string
Button Secondary Text Decoration
-
@ButtonSecondaryUseGradient(optional):
string
Button Secondary Use Gradient
-
@LinkColor(optional):
string
Link Color
-
@LinkHoverColor(optional):
string
Link Hover Color
-
@LinkVisitedColor(optional):
string
Link Visited Color
- @mobileNavBarButtonColor(optional): string
- @NavbarBackgroundColor(optional): string
- @NavbarBackgroundHoverColor(optional): string
- @NavbarLinkColor(optional): string
- @NavbarLinkHoverColor(optional): string
- @NavbarTextColor(optional): string
- @SubNavigationBackgroundColor(optional): string
- @SubNavigationBackgroundHoverColor(optional): string
- @SubNavigationLinkColor(optional): string
- @SubNavigationLinkHoverColor(optional): string
- @SubNavigationTextColor(optional): string
-
@TextColor(optional):
string
Text Color
Nested Schema : theme_styles_general
Type:
object
General information of theme styles.
Show Source
- @FooterBackgroundColor(optional): string
- @FooterBackgroundColorBottom(optional): string
- @FooterBackgroundColorTop(optional): string
- @FooterBackgroundImageAttachment(optional): string
- @FooterBackgroundImagePosition(optional): string
- @FooterBackgroundImageRepeat(optional): string
- @FooterBackgroundImageURL(optional): string
- @FooterBackgroundUseGradient(optional): string
- @FooterBorderTopColor(optional): string
-
@HeaderBackgroundColor(optional):
string
Header Background Color
-
@HeaderBackgroundColorBottom(optional):
string
Header Background Color Bottom
-
@HeaderBackgroundColorTop(optional):
string
Header Background Color Top
-
@HeaderBackgroundImageAttachment(optional):
string
Header Background Image Attachment
-
@HeaderBackgroundImagePosition(optional):
string
Header Background Image Position
-
@HeaderBackgroundImageRepeat(optional):
string
Header Background Image Repeat
-
@HeaderBackgroundImageURL(optional):
string
Header Background Image URL
-
@HeaderBackgroundUseGradient(optional):
string
Header Background Use Gradient
-
@HeaderTopBackgroundColor(optional):
string
Header Top Background Color
-
@HeaderTopBackgroundColorBottom(optional):
string
Header Top Background Color Bottom
-
@HeaderTopBackgroundColorTop(optional):
string
Header Top Background Color Top
-
@HeaderTopBackgroundImageAttachment(optional):
string
Header Top Background Image Attachment
-
@HeaderTopBackgroundImagePosition(optional):
string
Header Top Background Image Position
-
@HeaderTopBackgroundImageRepeat(optional):
string
Header Top Background Image Repeat
-
@HeaderTopBackgroundImageURL(optional):
string
Header Top Background Image URL
-
@HeaderTopBackgroundUseGradient(optional):
string
Header Top Background Use Gradient
-
@HeaderTopBorderBottomColor(optional):
string
Header Top Border Bottom Color
-
@HeaderTopPaddingTop(optional):
string
Header Top Padding Top
-
@SiteBackgroundColor(optional):
string
Site Background Color
-
@SiteBackgroundColorBottom(optional):
string
Site Background Color Bottom
-
@SiteBackgroundColorTop(optional):
string
Site Background Color Top
-
@SiteBackgroundImageAttachment(optional):
string
Site Background Image Attachment
-
@SiteBackgroundImagePosition(optional):
string
Site Background Image Position
-
@SiteBackgroundImageRepeat(optional):
string
Site Background Image Repeat
-
@SiteBackgroundImageURL(optional):
string
Site Background Image URL
-
@SiteBackgroundUseGradient(optional):
string
Site Background Use Gradient
-
@SitePageBackgroundColor(optional):
string
Site Page Background Color
Nested Schema : theme_styles_typography
Type:
object
Typography information of theme styles.
Show Source
-
@H1FontFamily(optional):
string
Heading 1 Font Family
-
@H1FontSize(optional):
string
Heading 1 Font Size
-
@H1FontStyle(optional):
string
Heading 1 Font Style
-
@H1FontWeight(optional):
string
Heading 1 Font Weight
-
@H1LineHeight(optional):
string
Heading 1 Line Height
-
@H1TextAlign(optional):
string
Heading 1 Text Align
-
@H1TextColor(optional):
string
Heading 1 Text Color
-
@H1TextDecoration(optional):
string
Heading 1 Text Decoration
-
@H2FontFamily(optional):
string
Heading 2 Font Family
-
@H2FontSize(optional):
string
Heading 2 Font Size
-
@H2FontStyle(optional):
string
Heading 2 Font Style
-
@H2FontWeight(optional):
string
Heading 2 Font Weight
-
@H2LineHeight(optional):
string
Heading 2 Line Height
-
@H2TextAlign(optional):
string
Heading 2 Text Align
-
@H2TextColor(optional):
string
Heading 2 Text Color
-
@H2TextDecoration(optional):
string
Heading 2 Text Decoration
-
@H3FontFamily(optional):
string
Heading 3 Font Family
-
@H3FontSize(optional):
string
Heading 3 Font Size
-
@H3FontStyle(optional):
string
Heading 3 Font Style
-
@H3FontWeight(optional):
string
Heading 3 Font Weight
-
@H3LineHeight(optional):
string
Heading 3 Line Height
-
@H3TextAlign(optional):
string
Heading 3 Text Align
-
@H3TextColor(optional):
string
Heading 3 Text Color
-
@H3TextDecoration(optional):
string
Heading 3 Text Decoration
-
@H4FontFamily(optional):
string
Heading 4 Font Family
-
@H4FontSize(optional):
string
Heading 4 Font Size
-
@H4FontStyle(optional):
string
Heading 4 Font Style
-
@H4FontWeight(optional):
string
Heading 4 Font Weight
-
@H4LineHeight(optional):
string
Heading 4 Line Height
-
@H4TextAlign(optional):
string
Heading 4 Text Align
-
@H4TextColor(optional):
string
Heading 4 Text Color
-
@H4TextDecoration(optional):
string
Heading 4 Text Decoration
-
@H5FontFamily(optional):
string
Heading 5 Font Family
-
@H5FontSize(optional):
string
Heading 5 Font Size
-
@H5FontStyle(optional):
string
Heading 5 Font Style
-
@H5FontWeight(optional):
string
Heading 5 Font Weight
-
@H5LineHeight(optional):
string
Heading 5 Line Height
-
@H5TextAlign(optional):
string
Heading 5 Text Align
-
@H5TextColor(optional):
string
Heading 5 Text Color
-
@H5TextDecoration(optional):
string
Heading 5 Text Decoration
-
@H6FontFamily(optional):
string
Heading 6 Font Family
-
@H6FontSize(optional):
string
Heading 6 Font Size
-
@H6FontStyle(optional):
string
Heading 6 Font Style
-
@H6FontWeight(optional):
string
Heading 6 Font Weight
-
@H6LineHeight(optional):
string
Heading 6 Line Height
-
@H6TextAlign(optional):
string
Heading 6 Text Align
-
@H6TextColor(optional):
string
Heading 6 Text Color
-
@H6TextDecoration(optional):
string
Heading 6 Text Decoration
-
@ParagraphFontFamily(optional):
string
Paragraph Font Family
-
@ParagraphFontSize(optional):
string
Paragraph Font Size
-
@ParagraphFontStyle(optional):
string
Paragraph Font Style
-
@ParagraphFontWeight(optional):
string
Paragraph Font Weight
-
@ParagraphLineHeight(optional):
string
Paragraph Line Height
-
@ParagraphTextAlign(optional):
string
Paragraph Text Align
-
@ParagraphTextColor(optional):
string
Paragraph Text Color
-
@ParagraphTextDecoration(optional):
string
Paragraph Text Decoration
-
@SiteFontFamily(optional):
string
Site Font Family
-
@SiteFontSize(optional):
string
Site Font Size
-
@SiteFontStyle(optional):
string
Site Font Style
-
@SiteFontWeight(optional):
string
Site Font Weight
-
@SiteLineHeight(optional):
string
Site Line Height
-
@SiteTextAlign(optional):
string
Site Text Align
-
@SiteTextColor(optional):
string
Site Text Color
-
@SiteTextDecoration(optional):
string
Site Text Decoration
Example Response (application/json)
{
"isAgentTheme":"false",
"thumbnail":"/img/cloudlake.jpg",
"theme_additional_fonts":{
},
"is_active":true,
"theme_styles_color":{
"@ButtonPrimaryTextColor":"#fff",
"@ButtonPrimaryBackgroundColorTop":"#08C",
"@SubNavigationTextColor":"#fff",
"@ButtonPrimaryFontStyle":"normal",
"@ButtonPrimaryFontWeight":"normal",
"@SubNavigationLinkHoverColor":"#fff\n ",
"@NavigationLinkShadowColor":"#000",
"@NavigationLinkColor":"#DFDFDF",
"@LinkColor":"#0088cc",
"@NavigationLinkColorHover":"#FFF",
"@ButtonPrimaryBackgroundColor":"#08C",
"@NavigationBorderColor":"#3D3F44",
"@SubNavigationLinkColor":"#fff",
"@NavigationBackgroundColor":"#4f5158",
"@ButtonPrimaryBackgroundColorBottom":"#04C",
"@ButtonPrimaryFontFamily":"@sansFontFamily",
"@ButtonPrimaryTextDecoration":"none",
"@ButtonPrimaryBorderColor":"#04C",
"@SubNavigationBackgroundColor":"#fff",
"@NavigationBackgroundColorBottom":"#34363a",
"@NavigationBackgroundColorTop":"#676a74",
"@ButtonPrimaryBorderRadius":"4px",
"@LinkHoverColor":"#FFD303",
"@SubNavigationBackgroundHoverColor":"#fff",
"@TextColor":"#333"
},
"notes":"This is the Cloud Lake Theme.",
"usingCodeView":false,
"is_default":false,
"associatedSites":[
],
"theme_styles_typography":{
"@H6LineHeight":"20px",
"@H5FontFamily":"@sansFontFamily",
"@H3FontFamily":"@sansFontFamily",
"@H4FontWeight":"bold",
"@ParagraphFontFamily":"@sansFontFamily",
"@H1FontFamily":"@sansFontFamily",
"@H2TextColor":"#333",
"@SiteLineHeight":"20px",
"@H1LineHeight":"40px",
"@H6FontSize":"11.9px",
"@SiteFontFamily":"@sansFontFamily",
"@ParagraphFontWeight":"normal",
"@H5FontSize":"14px",
"@H4TextColor":"#333",
"@H1TextColor":"#333",
"@H4FontSize":"17.5px",
"@H3LineHeight":"40px",
"@H2FontWeight":"bold",
"@H3FontSize":"24.5px",
"@ParagraphLineHeight":"20px\n ",
"@H3TextColor":"#333",
"@H3FontWeight":"bold",
"@H4FontFamily":"@sansFontFamily",
"@SiteFontSize":"14px",
"@H2FontFamily":"@sansFontFamily",
"@H5FontWeight":"normal",
"@H6FontFamily":"@sansFontFamily",
"@SiteFontWeight":"normal",
"@H1FontSize":"38.5px",
"@H5LineHeight":"20px",
"@H2FontSize":"31.5px",
"@H6TextColor":"#333",
"@ParagraphTextColor":"#333",
"@H2LineHeight":"40px",
"@H6FontWeight":"normal",
"@H5TextColor":"#333",
"@H4LineHeight":"20px",
"@H1FontWeight":"bold",
"@ParagraphFontSize":"14px"
},
"clone_parent_name":null,
"name":"Cloud Lake Theme",
"repositoryId":"100001",
"is_custom":false,
"id":"100001",
"theme_styles_general":{
"@FooterBorderTopColor":"#bcd7e6\n ",
"@SiteBackgroundImageAttachment":"scroll",
"@FooterBackgroundImageAttachment":"scroll",
"@SiteBackgroundImageURL":"none",
"@SiteBackgroundColorBottom":"transparent",
"@FooterBackgroundColorBottom":"transparent",
"@HeaderTopPaddingTop":"25px",
"@HeaderBackgroundColorTop":"transparent",
"@HeaderTopBackgroundColor":"#e2f5ff",
"@ContentBackgroundColor":"#FFF",
"@HeaderBackgroundImageAttachment":"scroll",
"@FooterBackgroundImageURL":"none",
"@FooterBackgroundImageRepeat":"repeat-x",
"@HeaderBackgroundImageRepeat":"repeat-x",
"@SiteBackgroundImagePosition":"topleft",
"@SiteBackgroundImageRepeat":"no-repeat",
"@SiteBackgroundColorTop":"transparent",
"@HeaderBackgroundColorBottom":"transparent",
"@HeaderBackgroundImagePosition":"topleft",
"@HeaderTopBackgroundImageURL":"'/img/header-wrap.png'",
"@FooterBackgroundColorTop":"transparent",
"@HeaderTopBorderBottomColor":"#bcd7e6",
"@HeaderBackgroundColor":"#FFF",
"@HeaderBackgroundImageURL":"none",
"@FooterBackgroundColor":"#e2f5ff",
"@SiteBackgroundColor":"#FFF",
"@FooterBackgroundImagePosition":"topleft"
},
"clone_parent_id":null,
"compilationStatuses":[
]
}
Default Response
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
The error response:
Error Code | Description | Possible Fix |
---|---|---|
70004 | The specified theme does not exist on system. | Ensure you have specified a valid theme ID. |
70021 | Internal error retrieving theme. | See returned error messages for more information. |
The error response:
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code