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

getSite

get

/ccstore/v1/sites/{id}

Get Site. Get a site by id.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The id of the site.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getSite_response
Nested Schema : additionalLocaleIds
Type: array
Additional Country ids.
Nested Schema : additionalProductionURLs
Type: array
The array of additional production URLs
Nested Schema : allowedOriginMethods
Type: object
Map of hostname (key) and the allowed http methods (values) for that host.
Nested Schema : billingCountries
Type: array
The list of billing countries
Nested Schema : defaultCatalog
Type: object
The default catalog associated with the site
Nested Schema : defaultListPriceList
Type: object
The default list price list
Nested Schema : defaultPriceListGroup
Type: object
The default price list group
Nested Schema : defaultSalePriceList
Type: object
The default sale price list
Nested Schema : defaultShippingSurchargePriceList
Type: object
The default shipping surcharge price list
Nested Schema : masterCatalog
Type: object
The master catalog for the site
Nested Schema : paymentGateways
Type: array
The array of the payment gateway names
Nested Schema : priceListGroupList
Type: array
List of Price List Groups associated with the site including default Price List Group
Nested Schema : profileContextList
Type: object
The list of profile contexts
Nested Schema : siteTypes
Type: array
List of site types supported by this site. Each site type has to be one of the allowed siteType options (case sensitive)
Nested Schema : items
Type: object
Nested Schema : allRootCategories
Type: array
The array of all root categories
Nested Schema : rootCategories
Type: array
The root categories of the default catalog
Nested Schema : items
Type: object
Nested Schema : categoryIdPaths
Type: array
The ids of the paths associated with the category
Nested Schema : categoryImages
Type: array
The array of image URLs associated with the category
Nested Schema : categoryPaths
Type: array
The category paths of the category
Nested Schema : childCategories
Type: array
The array of child categories
Nested Schema : fixedParentCategories
Type: array
The array of the fixed parent categories.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : currency
Type: object
The currency of the price list group
Nested Schema : allRootCategories
Type: array
The array of all root categories
Nested Schema : rootCategories
Type: array
The root categories of the default catalog
Nested Schema : items
Type: object
Nested Schema : categoryIdPaths
Type: array
The ids of the paths associated with the category
Nested Schema : categoryImages
Type: array
The array of image URLs associated with the category
Nested Schema : categoryPaths
Type: array
The category paths of the category
Nested Schema : childCategories
Type: array
The array of child categories
Nested Schema : fixedParentCategories
Type: array
The array of the fixed parent categories
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : currency
Type: object
The currency of the price list group
Example application/json

{
    "longDescription":null,
    "priceListGroupList":[
        {
            "deleted":false,
            "displayName":"Default Price Group",
            "repositoryId":"defaultPriceGroup",
            "active":true,
            "currency":{
                "symbol":"$",
                "displayName":"US Dollar",
                "repositoryId":"en_US",
                "fractionalDigits":2,
                "currencyCode":"USD",
                "numericCode":"840"
            },
            "id":"defaultPriceGroup",
            "locale":"en_US"
        }
    ],
    "productionURL":null,
    "description":"Commerce Cloud Site",
    "secondaryCurrency":"USD",
    "defaultCatalog":{
        "repositoryId":"cloudLakeCatalog",
        "rootCategories":[
            {
                "longDescription":"Cloud Commerce Non-Navigable",
                "categoryImages":[
                ],
                "displayName":"Non-Navigable",
                "categoryPaths":[
                    "/Non-Navigable"
                ],
                "active":false,
                "description":null,
                "categoryIdPaths":[
                    "nonNavigableCategory"
                ],
                "childCategories":null,
                "fixedParentCategories":[
                ],
                "creationDate":"2017-03-31T05:19:46.000Z",
                "route":"/non-navigable/category/nonNavigableCategory",
                "repositoryId":"nonNavigableCategory",
                "id":"nonNavigableCategory"
            },
            {
                "longDescription":"Commerce Cloud Root Category",
                "categoryImages":[
                ],
                "displayName":"Storefront Navigation",
                "categoryPaths":[
                    "/Storefront Navigation"
                ],
                "active":false,
                "description":null,
                "categoryIdPaths":[
                    "rootCategory"
                ],
                "childCategories":[
                    {
                        "repositoryId":"cat40013"
                    },
                    {
                        "repositoryId":"cat60023"
                    },
                    {
                        "repositoryId":"catOutdoor"
                    },
                    {
                        "repositoryId":"clearanceCat"
                    },
                    {
                        "repositoryId":"topLeaf"
                    },
                    {
                        "repositoryId":"cameracat"
                    },
                    {
                        "repositoryId":"AllProdPagination"
                    },
                    {
                        "repositoryId":"giftCards"
                    }
                ],
                "fixedParentCategories":[
                ],
                "creationDate":"2017-03-31T05:19:28.000Z",
                "route":"/storefront-navigation/category/rootCategory",
                "repositoryId":"rootCategory",
                "id":"rootCategory"
            }
        ],
        "allRootCategories":[
        ]
    },
    "defaultAccessLevel":"FULL",
    "type":"siteConfiguration",
    "defaultBillingCountryId":null,
    "enabled":true,
    "defaultShippingCountryId":null,
    "endecaSiteId":null,
    "timeToLive":null,
    "defaultLocaleId":"1",
    "emailAddress":"CloudCommerce@example.com",
    "billingCountries":[
        {
            "countryCode":"DE",
            "displayName":"Germany",
            "repositoryId":"DE"
        },
        {
            "countryCode":"LK",
            "displayName":"Sri Lanka",
            "repositoryId":"LK"
        },
        {
            "countryCode":"CA",
            "displayName":"Canada",
            "repositoryId":"CA"
        },
        {
            "countryCode":"US",
            "displayName":"United States",
            "repositoryId":"US"
        },
        {
            "countryCode":"CL",
            "displayName":"Chile",
            "repositoryId":"CL"
        },
        {
            "countryCode":"FO",
            "displayName":"Faroe Islands",
            "repositoryId":"FO"
        },
        {
            "countryCode":"BD",
            "displayName":"Bangladesh",
            "repositoryId":"BD"
        },
        {
            "countryCode":"AR",
            "displayName":"Argentina",
            "repositoryId":"AR"
        },
        {
            "countryCode":"PA",
            "displayName":"Panama",
            "repositoryId":"PA"
        },
        {
            "countryCode":"BR",
            "displayName":"Brazil",
            "repositoryId":"BR"
        },
        {
            "countryCode":"CO",
            "displayName":"Colombia",
            "repositoryId":"CO"
        },
        {
            "countryCode":"MX",
            "displayName":"Mexico",
            "repositoryId":"MX"
        },
        {
            "countryCode":"MC",
            "displayName":"Monaco",
            "repositoryId":"MC"
        },
        {
            "countryCode":"PE",
            "displayName":"Peru",
            "repositoryId":"PE"
        },
        {
            "countryCode":"AU",
            "displayName":"Australia",
            "repositoryId":"AU"
        }
    ],
    "maxCouponsPerOrder":null,
    "siteTemplate":"cloudSiteTemplate",
    "paymentGateways":[
    ],
    "siteIcon":null,
    "additionalProductionURLs":[
    ],
    "id":"siteUS",
    "defaultSalePriceList":{
        "repositoryId":"salePrices"
    },
    "additionalLocaleIds":[
    ],
    "siteDownURL":null,
    "defaultListPriceList":{
        "repositoryId":"listPrices"
    },
    "realmId":null,
    "recommendationsHost":"pt-recs-app1.us.oracle.com",
    "favicon":null,
    "sfVersion":null,
    "allowedOriginMethods":{
    },
    "defaultShippingSurchargePriceList":{
        "repositoryId":"shippingSurchargePrices"
    },
    "defaultPriceListGroup":{
        "deleted":false,
        "displayName":"Default Price Group",
        "repositoryId":"defaultPriceGroup",
        "active":true,
        "currency":{
            "symbol":"$",
            "displayName":"US Dollar",
            "repositoryId":"en_US",
            "fractionalDigits":2,
            "currencyCode":"USD",
            "numericCode":"840"
        },
        "id":"defaultPriceGroup",
        "locale":"en_US"
    },
    "contextRoot":null,
    "masterCatalog":{
        "repositoryId":"cloudLakeCatalog",
        "rootCategories":[
            {
                "longDescription":"Cloud Commerce Non-Navigable",
                "categoryImages":[
                ],
                "displayName":"Non-Navigable",
                "categoryPaths":[
                    "/Non-Navigable"
                ],
                "active":false,
                "description":null,
                "categoryIdPaths":[
                    "nonNavigableCategory"
                ],
                "childCategories":null,
                "fixedParentCategories":[
                ],
                "creationDate":"2017-03-31T05:19:46.000Z",
                "route":"/non-navigable/category/nonNavigableCategory",
                "repositoryId":"nonNavigableCategory",
                "id":"nonNavigableCategory"
            },
            {
                "longDescription":"Commerce Cloud Root Category",
                "categoryImages":[
                ],
                "displayName":"Storefront Navigation",
                "categoryPaths":[
                    "/Storefront Navigation"
                ],
                "active":false,
                "description":null,
                "categoryIdPaths":[
                    "rootCategory"
                ],
                "childCategories":[
                    {
                        "repositoryId":"cat40013"
                    },
                    {
                        "repositoryId":"cat60023"
                    },
                    {
                        "repositoryId":"catOutdoor"
                    },
                    {
                        "repositoryId":"clearanceCat"
                    },
                    {
                        "repositoryId":"topLeaf"
                    },
                    {
                        "repositoryId":"cameracat"
                    },
                    {
                        "repositoryId":"AllProdPagination"
                    },
                    {
                        "repositoryId":"giftCards"
                    }
                ],
                "fixedParentCategories":[
                ],
                "creationDate":"2017-03-31T05:19:28.000Z",
                "route":"/storefront-navigation/category/rootCategory",
                "repositoryId":"rootCategory",
                "id":"rootCategory"
            }
        ],
        "allRootCategories":[
        ]
    },
    "siteTypes":[
        "commerce"
    ],
    "recommendationsPort":"8080",
    "repositoryId":"siteUS",
    "profileContextList":{
        "repositoryId":"siteUS-catalogAndPriceGroups"
    },
    "name":"Commerce Cloud Site"
}
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| |------------------|------------------| |30012|Not able to fetch the site.| |30011|Invalid site id.| |30010|Site id is null.|
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 Response Payload returned by endpoint:

{
  "longDescription": null,
  "priceListGroupList": [{
    "deleted": false,
    "displayName": "Default Price Group",
    "repositoryId": "defaultPriceGroup",
    "active": true,
    "currency": {
      "symbol": "$",
      "displayName": "US Dollar",
      "repositoryId": "en_US",
      "fractionalDigits": 2,
      "currencyCode": "USD",
      "numericCode": "840"
    },
    "id": "defaultPriceGroup",
    "locale": "en_US"
  }],
  "productionURL": null,
  "description": "Commerce Cloud Site",
  "secondaryCurrency": "USD",
  "defaultCatalog": {
    "repositoryId": "cloudLakeCatalog",
    "rootCategories": [
      {
        "longDescription": "Cloud Commerce Non-Navigable",
        "categoryImages": [],
        "displayName": "Non-Navigable",
        "categoryPaths": ["/Non-Navigable"],
        "active": false,
        "description": null,
        "categoryIdPaths": ["nonNavigableCategory"],
        "childCategories": null,
        "fixedParentCategories": [],
        "creationDate": "2017-03-31T05:19:46.000Z",
        "route": "/non-navigable/category/nonNavigableCategory",
        "repositoryId": "nonNavigableCategory",
        "id": "nonNavigableCategory"
      },
      {
        "longDescription": "Commerce Cloud Root Category",
        "categoryImages": [],
        "displayName": "Storefront Navigation",
        "categoryPaths": ["/Storefront Navigation"],
        "active": false,
        "description": null,
        "categoryIdPaths": ["rootCategory"],
        "childCategories": [
          {"repositoryId": "cat40013"},
          {"repositoryId": "cat60023"},
          {"repositoryId": "catOutdoor"},
          {"repositoryId": "clearanceCat"},
          {"repositoryId": "topLeaf"},
          {"repositoryId": "cameracat"},
          {"repositoryId": "AllProdPagination"},
          {"repositoryId": "giftCards"}
        ],
        "fixedParentCategories": [],
        "creationDate": "2017-03-31T05:19:28.000Z",
        "route": "/storefront-navigation/category/rootCategory",
        "repositoryId": "rootCategory",
        "id": "rootCategory"
      }
    ],
    "allRootCategories": []
  },
  "defaultAccessLevel": "FULL",
  "type": "siteConfiguration",
  "defaultBillingCountryId": null,
  "enabled": true,
  "defaultShippingCountryId": null,
  "endecaSiteId": null,
  "timeToLive": null,
  "defaultLocaleId": "1",
  "emailAddress": "CloudCommerce@example.com",
  "billingCountries": [
    {
      "countryCode": "DE",
      "displayName": "Germany",
      "repositoryId": "DE"
    },
    {
      "countryCode": "LK",
      "displayName": "Sri Lanka",
      "repositoryId": "LK"
    },
    {
      "countryCode": "CA",
      "displayName": "Canada",
      "repositoryId": "CA"
    },
    {
      "countryCode": "US",
      "displayName": "United States",
      "repositoryId": "US"
    },
    {
      "countryCode": "CL",
      "displayName": "Chile",
      "repositoryId": "CL"
    },
    {
      "countryCode": "FO",
      "displayName": "Faroe Islands",
      "repositoryId": "FO"
    },
    {
      "countryCode": "BD",
      "displayName": "Bangladesh",
      "repositoryId": "BD"
    },
    {
      "countryCode": "AR",
      "displayName": "Argentina",
      "repositoryId": "AR"
    },
    {
      "countryCode": "PA",
      "displayName": "Panama",
      "repositoryId": "PA"
    },
    {
      "countryCode": "BR",
      "displayName": "Brazil",
      "repositoryId": "BR"
    },
    {
      "countryCode": "CO",
      "displayName": "Colombia",
      "repositoryId": "CO"
    },
    {
      "countryCode": "MX",
      "displayName": "Mexico",
      "repositoryId": "MX"
    },
    {
      "countryCode": "MC",
      "displayName": "Monaco",
      "repositoryId": "MC"
    },
    {
      "countryCode": "PE",
      "displayName": "Peru",
      "repositoryId": "PE"
    },
    {
      "countryCode": "AU",
      "displayName": "Australia",
      "repositoryId": "AU"
    }
  ],
  "maxCouponsPerOrder": null,
  "siteTemplate": "cloudSiteTemplate",
  "paymentGateways": [],
  "siteIcon": null,
  "additionalProductionURLs": [],
  "id": "siteUS",
  "defaultSalePriceList": {"repositoryId": "salePrices"},
  "additionalLocaleIds": [],
  "siteDownURL": null,
  "defaultListPriceList": {"repositoryId": "listPrices"},
  "realmId": null,
  "recommendationsHost": "pt-recs-app1.us.oracle.com",
  "favicon": null,
  "sfVersion": null,
  "allowedOriginMethods": {},
  "defaultShippingSurchargePriceList": {"repositoryId": "shippingSurchargePrices"},
  "defaultPriceListGroup": {
    "deleted": false,
    "displayName": "Default Price Group",
    "repositoryId": "defaultPriceGroup",
    "active": true,
    "currency": {
      "symbol": "$",
      "displayName": "US Dollar",
      "repositoryId": "en_US",
      "fractionalDigits": 2,
      "currencyCode": "USD",
      "numericCode": "840"
    },
    "id": "defaultPriceGroup",
    "locale": "en_US"
  },
  "contextRoot": null,
  "masterCatalog": {
    "repositoryId": "cloudLakeCatalog",
    "rootCategories": [
      {
        "longDescription": "Cloud Commerce Non-Navigable",
        "categoryImages": [],
        "displayName": "Non-Navigable",
        "categoryPaths": ["/Non-Navigable"],
        "active": false,
        "description": null,
        "categoryIdPaths": ["nonNavigableCategory"],
        "childCategories": null,
        "fixedParentCategories": [],
        "creationDate": "2017-03-31T05:19:46.000Z",
        "route": "/non-navigable/category/nonNavigableCategory",
        "repositoryId": "nonNavigableCategory",
        "id": "nonNavigableCategory"
      },
      {
        "longDescription": "Commerce Cloud Root Category",
        "categoryImages": [],
        "displayName": "Storefront Navigation",
        "categoryPaths": ["/Storefront Navigation"],
        "active": false,
        "description": null,
        "categoryIdPaths": ["rootCategory"],
        "childCategories": [
          {"repositoryId": "cat40013"},
          {"repositoryId": "cat60023"},
          {"repositoryId": "catOutdoor"},
          {"repositoryId": "clearanceCat"},
          {"repositoryId": "topLeaf"},
          {"repositoryId": "cameracat"},
          {"repositoryId": "AllProdPagination"},
          {"repositoryId": "giftCards"}
        ],
        "fixedParentCategories": [],
        "creationDate": "2017-03-31T05:19:28.000Z",
        "route": "/storefront-navigation/category/rootCategory",
        "repositoryId": "rootCategory",
        "id": "rootCategory"
      }
    ],
    "allRootCategories": []
  },
  "siteTypes": ["commerce"],
  "recommendationsPort": "8080",
  "repositoryId": "siteUS",
  "profileContextList": {"repositoryId": "siteUS-catalogAndPriceGroups"},
  "name": "Commerce Cloud Site"
}