1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Sites

createSite

post

/ccadmin/v1/sites

Create Site. 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. The id can be specified, but it cannot be the ID of an existing site or the "defaultSite" pseudo ID. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types
  • application/json
Header Parameters
X-CCAsset-Language
Type: string
Required: true
The asset language of the request
Body Parameter
Root Schema : createSite_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 : defaultPriceListGroup
Type: object
Default priceListGroup to be associated with site.
Nested Schema : loyaltyPrograms
Type: array
List of loyalty programs associated with site.
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
Nested Schema : items
Type: object

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : createSite_response
Nested Schema : additionalLocaleIds
Type: array
Additional Country ids.
Nested Schema : additionalProductionURLs
Type: array
A list of additional production URLs (without schema). Currently, only plain hostnames are supported.
Nested Schema : allowedOriginMethods
Type: object
Map of hostname (key) and the allowed http methods (values) for that host.
Nested Schema : defaultCatalog
Type: object
The default catalog id.
Nested Schema : defaultPriceListGroup
Type: object
The default PLG for the site.
Nested Schema : loyaltyPrograms
Type: array
List of loyalty programs associated with site.
Nested Schema : priceListGroupList
Type: array
List of Price List Groups associated with the site including default Price List Group
Nested Schema : shipFromAddress
Type: object
The ship from address used for tax calculations.
Nested Schema : siteTypes
Type: array
List of site types supported by this site
Nested Schema : items
Type: object
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"
        }
    ],
    "favicon":null,
    "timezone":"europe_london",
    "allowedOriginMethods":{
        "https://somemoresecurehost":"GET",
        "https://someHost:9080":"GET,PUT,DELETE,POST,OPTIONS"
    },
    "noimage":null,
    "secondaryCurrency":"USD",
    "defaultBillingCountryId":"US",
    "defaultShippingCountryId":"US",
    "siteTypes":[
        "b2bCommerce"
    ],
    "timeToLive":5000,
    "defaultLocaleId":"1",
    "shipFromAddress":{
        "country":"US",
        "city":"Cambridge",
        "postalCode":"02142",
        "addressLine1":"1 Main Street",
        "addressLine2":"Foo",
        "addressLine3":"Bar",
        "region":"MA"
    },
    "loyaltyPrograms":[
        {
            "programName":"Movie rewards",
            "repositoryId":"siteUS_LP0001",
            "associationDate":"2017-07-05T14:15:37.000Z",
            "programId":"LP0001"
        }
    ],
    "name":"CloudLake US Site",
    "repositoryId":"siteUS",
    "id":"siteUS",
    "additionalLocaleIds":[
        "1"
    ]
}
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| |100092|The value ''{0}'' for parameter ''{1}'' is not among the {2,number,integer} valid options. Showing the first {3,number,integer} valid options: {4}
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"}
  ],
  "timeToLive": 5000,
  "timezone": "europe_london",
  "name": "CloudLake US Site test",
  "allowedOriginMethods": {
    "https://somemoresecurehost": "GET",
    "https://someHost:9080": "GET,PUT,DELETE,POST,OPTIONS"
  },
  "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"
    }
  ],
  "favicon": null,
  "timezone": "europe_london",
  "allowedOriginMethods": {
    "https://somemoresecurehost": "GET",
    "https://someHost:9080": "GET,PUT,DELETE,POST,OPTIONS"
  },
  "noimage": null,
  "secondaryCurrency": "USD",
  "defaultBillingCountryId": "US",
  "defaultShippingCountryId": "US",
  "siteTypes": ["b2bCommerce"],
  "timeToLive": 5000,
  "defaultLocaleId": "1",
  "shipFromAddress": {
    "country": "US",
    "city": "Cambridge",
    "postalCode": "02142",
    "addressLine1": "1 Main Street",
    "addressLine2": "Foo",
    "addressLine3": "Bar",
    "region": "MA"
  },
  "loyaltyPrograms": [{
    "programName": "Movie rewards",
    "repositoryId": "siteUS_LP0001",
    "associationDate": "2017-07-05T14:15:37.000Z",
    "programId": "LP0001"
  }],
  "name": "CloudLake US Site",
  "repositoryId": "siteUS",
  "id": "siteUS",
  "additionalLocaleIds": ["1"]
}