1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Store
  4. Sites

listSites

get

/ccstore/v1/sites

List Sites. Get the list of available sites.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listSites_response
Type: object
Show Source
Nested Schema : items
Type: array
The list of available sites
Show Source
Nested Schema : listingRequest
Type: object
The listing request
Show Source
Nested Schema : sort
Type: object
The sort parameters
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalLocaleIds
Type: array
Additional Country ids.
Show Source
Nested Schema : additionalProductionURLs
Type: array
The array of additional production URLs
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 : billingCountries
Type: array
The list of billing countries
Show Source
Nested Schema : defaultCatalog
Type: object
The default catalog associated with the site
Show Source
Nested Schema : defaultListPriceList
Type: object
The default list price list
Show Source
Nested Schema : defaultPriceListGroup
Type: object
The default price list group
Show Source
Nested Schema : defaultSalePriceList
Type: object
The default sale price list
Show Source
Nested Schema : defaultShippingSurchargePriceList
Type: object
The default shipping surcharge price list
Show Source
Nested Schema : masterCatalog
Type: object
The master catalog for the site
Show Source
Nested Schema : pageTags
Type: object
The page tags embedded in various sections of this site's HTML. This property only appears if there are enabled page tags in at least one section.
Show Source
  • bodyEnd
    The array of page tags embedded at the end of the body section of this site's HTML. This item only appears if there are enabled page in this section.
  • bodyStart
    The array of page tags embedded at the start of the body section of this site's HTML. This item only appears if there are enabled page tags in this section.
  • head
    The array of page tags embedded in the head section of this site's HTML. This item only appears if there are enabled page tags in this section.
Nested Schema : paymentGateways
Type: array
The array of the payment gateway names
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 : profileContextList
Type: object
The list of profile contexts
Show Source
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)
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : allRootCategories
Type: array
The array of all root categories
Show Source
Nested Schema : rootCategories
Type: array
The root categories of the default catalog
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : categoryIdPaths
Type: array
The ids of the paths associated with the category
Show Source
Nested Schema : categoryImages
Type: array
The array of image URLs associated with the category
Show Source
Nested Schema : categoryPaths
Type: array
The category paths of the category
Show Source
Nested Schema : childCategories
Type: array
The array of child categories
Show Source
Nested Schema : fixedParentCategories
Type: array
The array of the fixed parent categories.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
The currency of the price list group
Show Source
Nested Schema : allRootCategories
Type: array
The array of all root categories
Show Source
Nested Schema : rootCategories
Type: array
The root categories of the default catalog
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : categoryIdPaths
Type: array
The ids of the paths associated with the category
Show Source
Nested Schema : categoryImages
Type: array
The array of image URLs associated with the category
Show Source
Nested Schema : categoryPaths
Type: array
The category paths of the category
Show Source
Nested Schema : childCategories
Type: array
The array of child categories
Show Source
Nested Schema : fixedParentCategories
Type: array
The array of the fixed parent categories
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : bodyEnd
Type: array
The array of page tags embedded at the end of the body section of this site's HTML. This item only appears if there are enabled page in this section.
Show Source
Nested Schema : bodyStart
Type: array
The array of page tags embedded at the start of the body section of this site's HTML. This item only appears if there are enabled page tags in this section.
Show Source
Nested Schema : head
Type: array
The array of page tags embedded in the head section of this site's HTML. This item only appears if there are enabled page tags in this section.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
The currency of the price list group
Show Source
Nested Schema : filterProperties
Type: array
The array of filter property strings
Show Source
Nested Schema : queryOptions
Type: object
The query options
Show Source
Nested Schema : sort
Type: object
The sort parameters
Show Source
Nested Schema : precachedPropertyNames
Type: array
The pre-cached property names array
Show Source
Nested Schema : sortDirectives
Type: object
The sort directives
Show Source
Example Response (application/json)
{
    "totalResults":1,
    "endingIndex":250,
    "offset":0,
    "totalResultsParam":true,
    "count":1,
    "limit":250,
    "sort":{
        "collator":null,
        "localeSensitiveSorting":false,
        "numDirectives":1,
        "empty":false
    },
    "items":[
        {
            "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,
            "useDefaultSiteLocale":false,
            "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":[
                ]
            },
            "type":"siteConfiguration",
            "defaultBillingCountryId":null,
            "requireGDPRCookieConsent":false,
            "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":[
            ],
            "additionalProductionURLs":[
            ],
            "id":"siteUS",
            "defaultSalePriceList":{
                "repositoryId":"salePrices"
            },
            "additionalLocaleIds":[
            ],
            "siteDownURL":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"
            },
            "payShippingInSecondaryCurrency":true,
            "recommendationsPort":"8080",
            "profileContextList":{
                "repositoryId":"siteUS-catalogAndPriceGroups"
            },
            "name":"Commerce Cloud Site",
            "longDescription":null,
            "inventoryLocationId":"SiteUS-GlenAllen187",
            "description":"Commerce Cloud Site",
            "secondaryCurrency":"USD",
            "defaultAccessLevel":"FULL",
            "enabled":true,
            "defaultShippingCountryId":null,
            "payTaxInSecondaryCurrency":true,
            "endecaSiteId":null,
            "cartSharingId":null,
            "siteIcon":null,
            "defaultListPriceList":{
                "repositoryId":"listPrices"
            },
            "realmId":null,
            "recommendationsHost":"recs.atgsvcs.example.com",
            "favicon":null,
            "allowAlternateCurrency":true,
            "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"
            ],
            "repositoryId":"siteUS"
        }
    ],
    "listingRequest":{
        "endingIndex":250,
        "queryOptions":{
            "precachedPropertyNames":null,
            "doNotCacheQuery":false,
            "sortDirectives":{
                "collator":null,
                "localeSensitiveSorting":false,
                "numDirectives":1,
                "empty":false
            },
            "endingIndex":250,
            "ignoreDuplicates":false,
            "nthIndex":1,
            "uncachedItems":false,
            "uncachedItemsSet":false,
            "startingIndex":0
        },
        "rqlString":null,
        "sort":{
            "collator":null,
            "localeSensitiveSorting":false,
            "numDirectives":1,
            "empty":false
        },
        "startingIndex":0,
        "filterProperties":[
        ],
        "includeRqlInQueryGeneration":true,
        "rqlStatement":null,
        "expanded":false,
        "limit":250,
        "siteId":"siteUS",
        "after":null,
        "calculateTotalAvailable":true
    },
    "startingIndex":0,
    "totalNumberOfItems":1
}

Default Response

The error response
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