Jump to

• Request
• Response

Upgrade Agent current version

post

/ccadmin/v1/jsframeworkadmin/upgradeAgentVersion

Upgrades the current Agent storefront JavaScript framework to the latest version in order to make use of features from the newest release.

In order for this upgrade to take effect, you must publish said change after calling the endpoint.

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

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

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : upgradeAgentCurrentVersion_200_response

Type: object

Show Source

• agentVersion(optional): string
  The version of the Agent that is currently running.
• currentAgentVersion(optional): string
  The Agent version that is currently running.
• lastAgentUpdate(optional): string
  A timestamp indicating when Agent was last updated.
• overrideAgentVersion(optional): string
  The agent version that overrides the latest version.
• previousAgentVersion(optional): string
  The previous version, if there was one
• success(optional): boolean
  Determines if the attempt to retrieve the agent version was successful

{
    "properties":{
        "currentAgentVersion":{
            "description":"The Agent version that is currently running.",
            "type":"string"
        },
        "lastAgentUpdate":{
            "description":"A timestamp indicating when Agent was last updated.",
            "type":"string"
        },
        "previousAgentVersion":{
            "description":"The previous version, if there was one",
            "type":"string"
        },
        "success":{
            "description":"Determines if the attempt to retrieve the agent version was successful",
            "type":"boolean"
        },
        "agentVersion":{
            "description":"The version of the Agent that is currently running.",
            "type":"string"
        },
        "overrideAgentVersion":{
            "description":"The agent version that overrides the latest version.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "currentAgentVersion":"20.2.4",
    "lastAgentUpdate":"2020-05-21T10:56:31.349Z",
    "previousAgentVersion":"20.2.3",
    "success":true,
    "agentVersion":"20.2.4",
    "overrideAgentVersion":"",
    "links":[
        {
            "rel":"self",
            "href":"ccadminui/v1/jsframeworkadmin/upgradeAgentVersion"
        }
    ]
}

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.
30105	Site not found.	Ensure you specify a valid site ID.
96028	Failed to upgrade agent version.	Ensure there is a valid existing version.

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