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.
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.
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : upgradeCurrentVersion_response
Type:
Show Source
object
-
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.
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:
The error response:
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:
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