Jump to

• Request
• Response

Upgrade current version

post

/ccadmin/v1/jsframeworkadmin/upgradeVersion

Upgrades the current storefront JavaScript framework to the latest version for all active sites.

It takes an optional query parameter of siteId. If you include this parameter, only the site that you have specified by siteId will be upgraded. This endpoint is useful if you are running multiple sites. For more information about multisite environments, please view the multisite documentation.

This endpoint only is applicable if a newer version exists. In order to determine the current storefront framework status, the Retrieve Current Version endpoint should be used.

Note: This endpoint is not supported for use in the Open Storefront Framework.

Request

Supported Media Types

• application/json

Query Parameters

• siteId(optional): string
  The ID of the site that will be upgraded. If no site ID is provided, all active sites are upgraded.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : upgradeCurrentVersion_response

Type: object

Show Source

• currentVersion(optional): string
  The storefront JavaScript framework version currently running.
• previousVersion(optional): string
  The previous version of the storefront JavaScript framework.
• storefrontVersion(optional): string
  The latest available version of the storefront JavaScript framework.
• success(optional): boolean
  whether the rollback was successful.
• UpgradeMessage(optional): string
  Additional Info about the Upgrade. Usually indicates if the store is already on latest Version.

{
    "properties":{
        "storefrontVersion":{
            "description":"The latest available version of the storefront JavaScript framework.",
            "type":"string"
        },
        "success":{
            "description":"whether the rollback was successful.",
            "type":"boolean"
        },
        "previousVersion":{
            "description":"The previous version of the storefront JavaScript framework.",
            "type":"string"
        },
        "UpgradeMessage":{
            "description":"Additional Info about the Upgrade. Usually indicates if the store is already on latest Version.",
            "type":"string"
        },
        "currentVersion":{
            "description":"The storefront JavaScript framework version currently running.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "storefrontVersion":"17.1",
    "success":true,
    "previousVersion":"16.6",
    "UpgradeMessage":"SiteUs already in latest Version.",
    "links":[
        {
            "rel":"self",
            "href":"jsframeworkadmin/upgradeVersion"
        }
    ],
    "currentVersion":"17.1"
}

Default Response

The following internal error codes are thrown by this API when the request fails in Commerce:

Error Code	Description	Possible Fix
30102	Unable to upgrade.	See returned error messages for more information.
30105	Site not found.	Ensure you specify a valid site ID.

The error response:

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top