getSite

get

/ccstore/v1/sites/{id}

Get Site. Get a site by id.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getSite_response
Type: object
Show Source
Nested Schema : additionalLocaleIds
Type: array
Additional Country ids.
Show Source
Nested Schema : additionalProductionURLs
Type: array
A list of additional production URLs (without schema). Currently, only plain hostnames are supported.
Show Source
Nested Schema : allowedOriginMethods
Type: object
Additional Properties Allowed
Show Source
Map of hostname (key) and the allowed http methods (values) for that host.
Nested Schema : defaultCatalog
Type: object
The default catalog for the site.
Show Source
Nested Schema : defaultPriceListGroup
Type: object
The default PLG for the site.
Show Source
Nested Schema : loyaltyPrograms
Type: array
List of loyalty programs associated with site.
Show Source
Nested Schema : priceListGroupList
Type: array
List of Price List Groups associated with the site including default Price List Group
Show Source
Nested Schema : shipFromAddress
Type: object
The ship from address used for tax calculations.
Show Source
Nested Schema : siteTypes
Type: array
List of site types supported by this site. Each site type has has to be one of the allowed siteType options (case sensitive).
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (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"
        }
    ],
    "inventoryLocationId":"SiteUS-GlenAllen187",
    "productionURL":null,
    "description":"Commerce Cloud Site",
    "secondaryCurrency":"USD",
    "requireGDPRP13nConsent":false,
    "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,
    "requireGDPRCookieConsent":false,
    "payTaxInSecondaryCurrency":true,
    "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"
        }
    ],
    "exchangeRate":0.6,
    "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,
    "payShippingInSecondaryCurrency":true,
    "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
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top