createSiteFromForm
post
/ccadmin/v1/siteCreateForms/{id}
Create Site From Form. Create a site based on the specified properties. Any unspecified properties will be inherited from the default site, except for id, productionURL, and additionalProductionURLs. Note that only a subset of properties can vary by site. **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
ID corresponding to the site to be used as a the source template for the new site. An empty ID will use the default site as a template.
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request
Root Schema : createSiteFromForm_request
Type:
Show Source
object
-
properties:
object properties
Object with updatable properties.
Example:
{
"properties":{
"priceListGroupList":[
{
"id":"EURO"
},
{
"id":"defaultPriceGroup"
}
],
"name":"CloudLake US Site test",
"siteTypes":[
"b2bCommerce"
]
}
}
Nested Schema : properties
Type:
object
Object with updatable properties.
Show Source
-
additionalLocaleIds(optional):
array additionalLocaleIds
Additional locale IDs.
-
additionalProductionURLs(optional):
array additionalProductionURLs
The additional production URLs.
-
defaultBillingCountryId(optional):
string
Default billing country ID.
-
defaultCatalog(optional):
object defaultCatalog
The default catalog.
-
defaultLocaleId(optional):
string
The default locale ID.
-
id(optional):
string
The optional repository ID of the site. If no ID is specified, than an autogenerated ID will be used.
-
inventoryLocationId(optional):
string
Defines which inventory this site should use by default.
-
name:
string
Name of the site.
-
priceListGroupList(optional):
array priceListGroupList
List of priceListGroups to be associated with site.
-
productionURL(optional):
string
The production URL.
-
recommendationsHost(optional):
string
The host name of the recommendations server.
-
recommendationsPort(optional):
string
The port of the recommendations server
-
repositoryId(optional):
string
The repository ID of the site.
-
siteTypes(optional):
array siteTypes
List of site types supported by this site
Nested Schema : defaultCatalog
Type:
object
The default catalog.
Show Source
-
repositoryId(optional):
string
The repository ID of the default catalog.
Nested Schema : priceListGroupList
Type:
array
List of priceListGroups to be associated with site.
Show Source
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createSiteFromForm_response
Type:
Show Source
object
-
additionalLocaleIds(optional):
array additionalLocaleIds
Additional Country ids.
-
defaultBillingCountryId(optional):
string
Default billing country ID.
-
defaultCatalog(optional):
object defaultCatalog
The default catalog for the site.
-
defaultLocaleId(optional):
string
Default locale ID.
-
defaultShippingCountryId(optional):
string
Default Shipping Country ID.
-
id(optional):
string
ID of the site.
-
inventoryLocationId(optional):
string
Defines which inventory this site should use by default.
-
name(optional):
string
Site name.
-
priceListGroupList(optional):
array priceListGroupList
List of Price List Groups associated with the site including default Price List Group
-
productionURL(optional):
string
The production base url for storefront. If set, this base url will be used for any absolute generated links e.g. sitemap urls
-
repositoryId(optional):
string
Repository ID of the site.
-
siteTypes(optional):
array siteTypes
List of site types supported by this site
Nested Schema : defaultCatalog
Type:
object
The default catalog for the site.
Show Source
-
repositoryId(optional):
string
The ID of the default catalog for the site.
Nested Schema : priceListGroupList
Type:
array
List of Price List Groups associated with the site including default Price List Group
Show Source
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
true if priceListGroup is active otherwise false
-
deleted(optional):
boolean
true if priceListGroup is deleted otherwise false
-
id(optional):
string
priceListGroup id associated to site
-
repositoryId(optional):
string
priceListGroup id associated to site
Example Response (application/json)
{
"priceListGroupList":[
{
"deleted":false,
"repositoryId":"defaultPriceGroup",
"active":false,
"id":"defaultPriceGroup"
},
{
"deleted":false,
"repositoryId":"EURO",
"active":false,
"id":"EURO"
}
],
"inventoryLocationId":"SiteUS-GlenAllen187",
"defaultLocaleId":"1",
"name":"CloudLake US Site",
"repositoryId":"siteUS",
"id":"siteUS",
"defaultBillingCountryId":"US",
"defaultShippingCountryId":"US",
"additionalLocaleIds":[
"1"
],
"siteTypes":[
"b2bCommerce"
]
}
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|
|------------------|------------------|
|30015|Invalid Site Base URL ''{0}'' specified.|
|30014|Could not update site. Allowed site types are {0}|
|25015|set Property RepositoryItem Internal Error|
|25014|convert Input Property Type Internal Error|
|30005|Create site 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