Jump to

• Request
• Response

createSiteGroup

post

/ccadmin/v1/siteGroups

Create a site group based on the specified properties. Member sites must exist before the group is created. Any unspecified properties will be set to default values. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types

• application/json

Query Parameters

• showTranslations: 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(required): string
  The asset language of the request

Body ()

Root Schema : createSiteGroup_request

Type: object

Show Source

• displayName: string
  Name of the site group.
• id: string
  The optional ID of the site group. If no ID is specified, than an autogenerated ID will be used.
• sharedCart: boolean
  True if the member sites can share the shopping cart. False allows the group to be used for purposes other than cart sharing. The default is false.
• sites: array sites
  List of sites that are members of the group. The sites must already exist.

{
    "properties":{
        "displayName":{
            "description":"Name of the site group.",
            "type":"string"
        },
        "sharedCart":{
            "description":"True if the member sites can share the shopping cart. False allows the group to be used for purposes other than cart sharing. The default is false.",
            "type":"boolean"
        },
        "sites":{
            "description":"List of sites that are members of the group. The sites must already exist.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The site ID.",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"The optional ID of the site group. If no ID is specified, than an autogenerated ID will be used.",
            "type":"string"
        }
    },
    "example":{
        "displayName":"Cart sharing group for US sites",
        "sharedCart":true,
        "sites":[
            {
                "id":"siteUSEast"
            },
            {
                "id":"siteUSCentral"
            },
            {
                "id":"siteUSWest"
            }
        ],
        "id":"cartGroupUS"
    }
}

Example:

{
    "displayName":"Cart sharing group for US sites",
    "sharedCart":true,
    "sites":[
        {
            "id":"siteUSEast"
        },
        {
            "id":"siteUSCentral"
        },
        {
            "id":"siteUSWest"
        }
    ],
    "id":"cartGroupUS"
}

Nested Schema : sites

Type: array

List of sites that are members of the group. The sites must already exist.

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

• id: string
  The site ID.

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

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: string
  Site group name.
• id: string
  ID of the site group.
• sharedCart: boolean
  True if the member sites can share the shopping cart.
• sites: 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: string
  The site ID.
• name: 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| |------------------|------------------| |30305|CREATE_SITE_GROUP_FAILED|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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