Retrieve current version
get
/ccadmin/v1/jsframeworkadmin
Gets the version information for the storefront JavaScript framework. This endpoint can be used to check if a rollback or version upgrade is possible for the version of the storefront JavaScript framework currently in use.
Note: This endpoint is not supported in OSF.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : getCurrentVersionDetails_response
Type:
Show Source
object
-
currentVersion(optional):
string
The current version being run on the storefront.
-
previousVersion(optional):
string
The previous version
-
storefrontVersion(optional):
string
The storefront version.
Example Response (application/json)
{
"storefrontVersion":[
"string",
"The latest available version of the storefront JavaScript framework."
],
"success":[
"boolean",
"Whether the rollback was successful."
],
"previousVersion":[
"string",
"Optional value. The previous storefront JavaScript framework version, if there is one."
],
"currentVersion":[
"string",
"The storefront JavaScript framework version currently in use."
]
}
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 |
---|---|---|
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