updateSiteGroup
put
/ccadmin/v1/siteGroups/{id}
Update a site group based on ID and request parameters. **Requires the x-ccasset-language header so translated content can be set for a specific language.**
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the site group to update.
Query Parameters
-
showTranslations(optional): boolean
Boolean indicating if the translations property should be returned for each item in the response. The default value is false.
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request
Root Schema : updateSiteGroup_request
Type:
Show Source
object
-
displayName(optional):
string
Name of the site group.
- sharedCart(optional): boolean
-
sites(optional):
array sites
List of sites that are members of the group. The sites must already exist.
Example:
{
"displayName":"Cart sharing group for US sites including Alaska and Hawaii",
"sites":[
{
"id":"siteUSEast"
},
{
"id":"siteUSCentral"
},
{
"id":"siteUSWest"
},
{
"id":"siteAlaska"
},
{
"id":"siteHawaii"
}
]
}
Nested Schema : sites
Type:
array
List of sites that are members of the group. The sites must already exist.
Show Source
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : siteGroup_response
Type:
Show Source
object
-
displayName(optional):
string
Site group name.
-
id(optional):
string
ID of the site group.
- sharedCart(optional): boolean
-
sites(optional):
array sites
List of sites that are members of the group.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The site ID.
-
name(optional):
string
The site name.
Example Response (application/json)
{
"displayName":"Cart sharing group for US sites",
"sharedCart":true,
"sites":[
{
"name":"East site",
"id":"siteUSEast"
},
{
"name":"Central site",
"id":"siteUSCentral"
},
{
"name":"West site",
"id":"siteUSWest"
}
],
"id":"cartGroupUS"
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|30303|UPDATE_SITE_GROUP_FAILED
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