Jump to

• Request
• Response

getSiteGroup

get

/ccadmin/v1/siteGroups/{id}

Get a site group by ID. 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 to get.

Query Parameters

• production(optional): boolean
  If this flag is set to true, site group information will be returned from the production DB. The default value is false
• 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(optional): string
  The asset language of the request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : siteGroup_response

Type: object

Show Source

• displayName(optional): string
  Site group name.
• id(optional): string
  ID of the site group.
• sharedCart(optional): boolean
  True if the member sites can share the shopping cart.
• sites(optional): array sites
  List of sites that are members of the group.

{
    "properties":{
        "displayName":{
            "description":"Site group name.",
            "type":"string"
        },
        "sharedCart":{
            "description":"True if the member sites can share the shopping cart.",
            "type":"boolean"
        },
        "sites":{
            "description":"List of sites that are members of the group.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"The site name.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The site ID.",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"ID of the site group.",
            "type":"string"
        }
    }
}

Nested Schema : sites

Type: array

List of sites that are members of the group.

Show Source

• Array of: object items

{
    "description":"List of sites that are members of the group.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"The site name.",
                "type":"string"
            },
            "id":{
                "description":"The site ID.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  The site ID.
• name(optional): string
  The site name.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"The site name.",
            "type":"string"
        },
        "id":{
            "description":"The site ID.",
            "type":"string"
        }
    }
}

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| |------------------|------------------| |30311|Site group id does not exist.| |30301|A site group id is required to update a site group.| |30312|Could not get site group.|

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