getCartSharingSites
get
/ccagent/v1/sites/{id}/cartSharingSites
Get all sites that belong to the same site group as the input site ID.
There are couple of query parameters - includeGivenSite and includeInactiveSites to control
whether the input site should be returned in the response and
whether the inactive sites should be returned in the response.
By default includeGiveSite is false while includeInactiveSites is true.
Optionally takes the x-ccasset-language header to get translated content in another language.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the site for which sharing sites should be retrieved.
Query Parameters
-
includeGivenSite(optional): boolean
Boolean indicating if the given site should be included in the response. The default value is false.
-
includeInactiveSites(optional): boolean
Boolean indicating if Inactive sites should be included in the response. The default value is true.
-
showTranslations(optional): boolean
Boolean indicating if the translations property should be returned for each item in the response. The default value is false.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getSharingSite_response
Type:
Show Source
object
-
items(optional):
array items
The list of available sites
-
startingIndex(optional):
integer
The starting index
-
totalNumberOfItems(optional):
integer
The total number of items.
Nested Schema : items
Type:
Show Source
object
-
enabled(optional):
boolean
Indicates whether the site is enabled.
-
id(optional):
string
The repository ID of the site.
-
name(optional):
string
The name of the site.
-
productionURL(optional):
string
The production URL (without the scheme) of the server. Currently, only hostnames are support.
Example Response (application/json)
{
"items":[
{
"productionURL":"localhost:8080",
"name":"Site Agent",
"id":"SiteA",
"enabled":true
},
{
"productionURL":"localhostSiteUS:8080",
"name":"Commerce Cloud Site",
"id":"siteUS",
"enabled":true
}
],
"startingIndex":0,
"totalNumberOfItems":2
}
Default Response
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