1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Themes

Update a theme by its ID

put

/ccadmin/v1/themes/{id}/

Updates a particular theme's information by its ID. Returns all themes, including the agent theme.

Include any fields to be updated in the request payload, as shown in below example. name and notes are always required in the payload. theme_styles_general, theme_styles_typography, theme_styles_color and theme_additional_fonts are required if the theme is of type custom.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : updateTheme_request
Type: object
Show Source
Example:
{
    "theme_additional_fonts":{
    },
    "notes":"test note",
    "theme_styles_color":{
        "@ButtonPrimarySize":"medium",
        "@ButtonSecondaryTextDecoration":"none",
        "@ButtonPrimaryTextColor":"#ffa403",
        "@SubNavigationTextColor":"#ffa403",
        "@ButtonPrimaryUseGradient":"false",
        "@ButtonPrimaryFontStyle":"normal",
        "@ButtonSecondaryFontFamily":"@sansFontFamily",
        "@ButtonPrimaryFontWeight":"bold",
        "@NavbarLinkColor":"#000000",
        "@NavbarLinkHoverColor":"#000000",
        "@NavbarTextColor":"#ffa403",
        "@mobileNavBarButtonColor":"#333333",
        "@SubNavigationLinkHoverColor":"#000000",
        "@NavbarBackgroundHoverColor":"#ffffff",
        "@ButtonSecondaryUseGradient":"false",
        "@LinkVisitedColor":"#000000",
        "@LinkColor":"#000000",
        "@ButtonPrimaryBackgroundColor":"#000000",
        "@NavbarBackgroundColor":"#ffffff",
        "@SubNavigationLinkColor":"#ffa403",
        "@ButtonPrimaryFontFamily":"@sansFontFamily",
        "@ButtonPrimaryTextDecoration":"none",
        "@ButtonSecondaryBorderRadius":"0px",
        "@ButtonSecondaryFontStyle":"normal",
        "@ButtonSecondaryTextColor":"#000000",
        "@SubNavigationBackgroundColor":"#000000",
        "@ButtonSecondaryFontWeight":"bold",
        "@ButtonSecondaryBackgroundColor":"#eeeeee",
        "@ButtonPrimaryBorderRadius":"0px",
        "@LinkHoverColor":"#ffa403",
        "@ButtonSecondarySize":"medium",
        "@SubNavigationBackgroundHoverColor":"#000000",
        "@TextColor":"#000000"
    },
    "theme_styles_typography":{
        "@H6LineHeight":"150%",
        "@H5TextDecoration":"inherit",
        "@H3FontFamily":"inherit",
        "@H5FontStyle":"inherit",
        "@H2FontStyle":"inherit",
        "@H2TextColor":"inherit",
        "@SiteLineHeight":"150%",
        "@SiteFontFamily":"@sansFontFamily",
        "@H1TextAlign":"inherit",
        "@ParagraphFontWeight":"normal",
        "@H5FontSize":"1.00rem",
        "@H4TextAlign":"inherit",
        "@H1TextDecoration":"inherit",
        "@H3LineHeight":"150%",
        "@H2FontWeight":"bold",
        "@H3FontSize":"1.75rem",
        "@ParagraphLineHeight":"150%",
        "@H3TextColor":"inherit",
        "@H3TextAlign":"inherit",
        "@H4FontFamily":"inherit",
        "@SiteFontSize":"14px",
        "@SiteTextAlign":"left",
        "@H5FontWeight":"normal",
        "@H6FontFamily":"inherit",
        "@H1FontSize":"2.75rem",
        "@H6FontStyle":"inherit",
        "@H6TextDecoration":"inherit",
        "@H2TextDecoration":"inherit",
        "@ParagraphTextColor":"inherit",
        "@H1FontStyle":"inherit",
        "@ParagraphTextAlign":"inherit",
        "@H4LineHeight":"150%",
        "@H1FontWeight":"bold",
        "@SiteTextColor":"#000000",
        "@ParagraphFontSize":"1.00rem",
        "@H5FontFamily":"inherit",
        "@H4FontWeight":"bold",
        "@ParagraphFontFamily":"inherit",
        "@H1FontFamily":"inherit",
        "@H2TextAlign":"inherit",
        "@H1LineHeight":"150%",
        "@H6FontSize":"0.85rem",
        "@H3TextDecoration":"inherit",
        "@H4TextColor":"inherit",
        "@ParagraphFontStyle":"inherit",
        "@ParagraphTextDecoration":"inherit",
        "@H1TextColor":"inherit",
        "@SiteTextDecoration":"none",
        "@H4FontSize":"1.25rem",
        "@SiteFontStyle":"normal",
        "@H3FontWeight":"bold",
        "@H6TextAlign":"inherit",
        "@H4TextDecoration":"inherit",
        "@H2FontFamily":"inherit",
        "@H3FontStyle":"inherit",
        "@SiteFontWeight":"normal",
        "@H5LineHeight":"150%",
        "@H2FontSize":"2.25rem",
        "@H6TextColor":"inherit",
        "@H4FontStyle":"inherit",
        "@H2LineHeight":"150%",
        "@H5TextColor":"inherit",
        "@H5TextAlign":"inherit",
        "@H6FontWeight":"normal"
    },
    "name":"testDarkThemeUpdate",
    "theme_styles_general":{
        "@SiteBackgroundImageAttachment":"scroll",
        "@FooterBackgroundImageAttachment":"scroll",
        "@FooterBorderTopColor":"#ffffff",
        "@SBackgroundImageURL":"url(/file/media/odpfkokopfsd)",
        "@SiteBackgroundImageURL":"url(/file/media/odpfkokopfsd)",
        "@HeaderBackgroundUseGradient":"false",
        "@SiteBackgroundColorBottom":"#000000",
        "@HeaderTopBackgroundImageAttachment":"scroll",
        "@HeaderTopBackgroundImagePosition":"top left",
        "@HeaderTopBackgroundImageRepeat":"repeat-x",
        "@HeaderTopPaddingTop":"25px",
        "@FooterBackgroundColorBottom":"#ffffff",
        "@HeaderTopBackgroundColorTop":"#ffffff",
        "@HeaderBackgroundColorTop":"#ffffff",
        "@HeaderTopBackgroundColor":"#ffffff",
        "@HeaderBackgroundImageAttachment":"scroll",
        "@FooterBackgroundImageURL":"none",
        "@FooterBackgroundImageRepeat":"repeat-x",
        "@SiteBackgroundImagePosition":"top left",
        "@HeaderBackgroundImageRepeat":"repeat-x",
        "@SiteBackgroundImageRepeat":"no-repeat",
        "@FooterBackgroundUseGradient":"false",
        "@HeaderTopBackgroundUseGradient":"false",
        "@SiteBackgroundColorTop":"#000000",
        "@HeaderBackgroundColorBottom":"#ffffff",
        "@HeaderTopBackgroundColorBottom":"#ffffff",
        "@HeaderBackgroundImagePosition":"top left",
        "@SitePageBackgroundColor":"#ffffff",
        "@HeaderTopBackgroundImageURL":"none",
        "@HeaderTopBorderBottomColor":"#ffffff",
        "@FooterBackgroundColorTop":"#ffffff",
        "@HeaderBackgroundColor":"#ffffff",
        "@HeaderBackgroundImageURL":"none",
        "@SiteBackgroundColor":"#000000",
        "@FooterBackgroundColor":"#ffffff",
        "@SiteBackgroundUseGradient":"false",
        "@FooterBackgroundImagePosition":"top left"
    }
}
Nested Schema : theme_additional_fonts
Type: object
A map of additional fonts of the theme.
Show Source
Nested Schema : theme_styles_color
Type: object
A map of color styles of the theme.
Show Source
Nested Schema : theme_styles_general
Type: object
A map of general styles of the theme.
Show Source
Nested Schema : theme_styles_typography
Type: object
A map of typography styles of the theme.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds. Includes all themes.
Body ()
Root Schema : updateTheme_response
Type: object
Show Source
Nested Schema : theme_styles_color
Type: object
Color information of theme styles.
Show Source
Nested Schema : theme_styles_general
Type: object
General information of theme styles.
Show Source
Nested Schema : theme_styles_typography
Type: object
Typography information of theme styles.
Show Source
Example Response (application/json)
[
    {
        "isAgentTheme":false,
        "thumbnail":null,
        "theme_additional_fonts":{
        },
        "notes":"",
        "is_active":false,
        "usingCodeView":false,
        "is_default":false,
        "associatedSites":[
        ],
        "clone_parent_name":"Dark Theme",
        "repositoryId":"100001",
        "name":"testClone",
        "is_custom":true,
        "id":"100001",
        "clone_parent_id":"darkTheme",
        "compilationStatuses":[
        ]
    },
    {
        "isAgentTheme":true,
        "thumbnail":null,
        "theme_additional_fonts":{
        },
        "notes":"This is the Agent Theme.",
        "is_active":false,
        "usingCodeView":false,
        "is_default":false,
        "associatedSites":[
        ],
        "clone_parent_name":"Cloud Lake Theme",
        "repositoryId":"AgentTheme",
        "name":"Agent Theme",
        "is_custom":true,
        "id":"AgentTheme",
        "clone_parent_id":"100001",
        "compilationStatuses":[
            {
                "occurredAt":"2020-04-07T15:20:27.000Z",
                "repositoryId":"100002",
                "siteId":null,
                "details":null,
                "id":"100002",
                "status":101
            }
        ]
    },
    {
        "isAgentTheme":false,
        "thumbnail":"/img/cloudlake.jpg",
        "theme_additional_fonts":{
        },
        "notes":"test",
        "is_active":false,
        "usingCodeView":false,
        "is_default":false,
        "associatedSites":[
        ],
        "clone_parent_name":null,
        "repositoryId":"cloudLakeTheme",
        "name":"Cloud Lake Theme",
        "is_custom":false,
        "id":"cloudLakeTheme",
        "clone_parent_id":null,
        "compilationStatuses":[
        ]
    },
    {
        "isAgentTheme":false,
        "thumbnail":null,
        "theme_additional_fonts":{
        },
        "notes":"test note",
        "is_active":true,
        "usingCodeView":false,
        "is_default":true,
        "associatedSites":[
            {
                "repositoryId":"siteUS",
                "name":"Commerce Cloud Site"
            }
        ],
        "clone_parent_name":"Cloud Lake Theme",
        "repositoryId":"darkTheme",
        "name":"testDarkThemeUpdate",
        "is_custom":true,
        "id":"darkTheme",
        "clone_parent_id":"100001",
        "compilationStatuses":[
            {
                "occurredAt":"2020-05-26T14:39:54.956Z",
                "repositoryId":"200001",
                "siteId":"siteUS",
                "details":"",
                "id":"200001",
                "status":101
            }
        ]
    },
    {
        "isAgentTheme":false,
        "thumbnail":null,
        "theme_additional_fonts":{
        },
        "notes":null,
        "is_active":false,
        "usingCodeView":false,
        "is_default":false,
        "associatedSites":[
        ],
        "clone_parent_name":"Cloud Lake Theme",
        "repositoryId":"monoTheme",
        "name":"Mono Theme",
        "is_custom":true,
        "id":"monoTheme",
        "clone_parent_id":"100001",
        "compilationStatuses":[
        ]
    }
]

412 Response

ETag mismatch. Asset has been updated by another user.

Default Response

The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
Error CodeDescriptionPossible Fix
70004Specified theme does not exist.Ensure you have specified a valid theme ID.
70008Attempted to assign theme a non-unique name.Ensure the new theme name is not in use.
70009Internal error whilst updating theme.See returned error messages for further information.

The error response:
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top