Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getSharingSite_response

Type: object

Show Source

• items(optional): array items
  The list of available sites
• startingIndex(optional): integer
  The starting index
• totalNumberOfItems(optional): integer
  The total number of items.

{
    "properties":{
        "items":{
            "description":"The list of available sites",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "productionURL":{
                        "description":"The production URL (without the scheme) of the server. Currently, only hostnames are support.",
                        "type":"string"
                    },
                    "name":{
                        "description":"The name of the site.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The repository ID of the site.",
                        "type":"string"
                    },
                    "enabled":{
                        "description":"Indicates whether the site is enabled.",
                        "type":"boolean"
                    }
                }
            }
        },
        "startingIndex":{
            "description":"The starting index",
            "type":"integer"
        },
        "totalNumberOfItems":{
            "description":"The total number of items.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

The list of available sites

Show Source

• Array of: object items

{
    "description":"The list of available sites",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "productionURL":{
                "description":"The production URL (without the scheme) of the server. Currently, only hostnames are support.",
                "type":"string"
            },
            "name":{
                "description":"The name of the site.",
                "type":"string"
            },
            "id":{
                "description":"The repository ID of the site.",
                "type":"string"
            },
            "enabled":{
                "description":"Indicates whether the site is enabled.",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "productionURL":{
            "description":"The production URL (without the scheme) of the server. Currently, only hostnames are support.",
            "type":"string"
        },
        "name":{
            "description":"The name of the site.",
            "type":"string"
        },
        "id":{
            "description":"The repository ID of the site.",
            "type":"string"
        },
        "enabled":{
            "description":"Indicates whether the site is enabled.",
            "type":"boolean"
        }
    }
}

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

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