1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Site Create Forms

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
Type: string
Required: true
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
Type: string
Required: true
The asset language of the request
Body Parameter
Root Schema : createSiteFromForm_request
Nested Schema : properties
Type: object
Object with updatable properties.
Nested Schema : additionalLocaleIds
Type: array
Additional locale IDs.
Nested Schema : additionalProductionURLs
Type: array
The additional production URLs.
Nested Schema : defaultCatalog
Type: object
The default catalog.
Nested Schema : priceListGroupList
Type: array
List of priceListGroups to be associated with site.
Nested Schema : siteTypes
Type: array
List of site types supported by this site
Nested Schema : items
Type: object

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : createSiteFromForm_response
Nested Schema : additionalLocaleIds
Type: array
Additional Country ids.
Nested Schema : defaultCatalog
Type: object
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
Nested Schema : siteTypes
Type: array
List of site types supported by this site
Nested Schema : items
Type: object
Example application/json

{
    "priceListGroupList":[
        {
            "deleted":false,
            "repositoryId":"defaultPriceGroup",
            "active":false,
            "id":"defaultPriceGroup"
        },
        {
            "deleted":false,
            "repositoryId":"EURO",
            "active":false,
            "id":"EURO"
        }
    ],
    "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|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Request:

{"properties": {
  "priceListGroupList": [
    {"id": "EURO"},
    {"id": "defaultPriceGroup"}
  ],
  "name": "CloudLake US Site test",
  "siteTypes": ["b2bCommerce"]
}}

Sample Response Payload returned by endpoint:

{
  "priceListGroupList": [
    {
      "deleted": false,
      "repositoryId": "defaultPriceGroup",
      "active": false,
      "id": "defaultPriceGroup"
    },
    {
      "deleted": false,
      "repositoryId": "EURO",
      "active": false,
      "id": "EURO"
    }
  ],
  "defaultLocaleId": "1",
  "name": "CloudLake US Site",
  "repositoryId": "siteUS",
  "id": "siteUS",
  "defaultBillingCountryId": "US",
  "defaultShippingCountryId": "US",
  "additionalLocaleIds": ["1"],
  "siteTypes": ["b2bCommerce"]
}