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

getSites

get

/ccadmin/v1/sites

Get Sites. Get the list of available sites.

Request

Supported Media Types
Query Parameters
  • Specify whether an expanded response must be served
  • The historical sites flag, if you want historicalSites then make it true
  • If this flag is set to true, sites will be returned from production DB. It's default value is false
  • The search query string in SCIM format. Results will be filtered based on this query.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getSites_response
Type: object
Show Source
Nested Schema : items
Type: array
The list of available sites
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalLocaleIds
Type: array
IDs of additional locales.
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 : defaultCatalog
Type: object
The default catalog for the site.
Show Source
Nested Schema : inventoryLocations
Type: array
The "inventoryLocations" field, defined as an array, enables users to link multiple inventory locations to a site. If the "inventoryLocations" array includes at least one element, the "inventoryLocationId" field is not considered.
Show Source
Nested Schema : loyaltyPrograms
Type: array
List of loyalty programs associated with site.
Show Source
Nested Schema : priceListGroupList
Type: array
List of priceListGroups to be associated with site.
Show Source
Nested Schema : siteTypes
Type: array
The list of site types.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "endingIndex":250,
    "totalResultsParam":true,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/sites"
        }
    ],
    "sort":{
        "collator":null,
        "numDirectives":1,
        "empty":false
    },
    "items":[
        {
            "priceListGroupList":[
                {
                    "repositoryId":"defaultPriceGroup",
                    "id":"defaultPriceGroup"
                }
            ],
            "recommendationsHost":"recs.atgsvcs.example.com",
            "productionURL":"wakko:9080",
            "favicon":null,
            "useDefaultSiteLocale":false,
            "timezone":"europe_london",
            "noimage":null,
            "defaultCatalog":{
                "repositoryId":"cloudLakeCatalog"
            },
            "defaultBillingCountryId":"AR",
            "defaultShippingCountryId":null,
            "siteTypes":[
                "commerce"
            ],
            "recommendationsPort":"8080",
            "defaultLocaleId":"1",
            "repositoryId":"site2",
            "name":"Commerce Cloud Site",
            "additionalProductionURLs":[
                "example.com"
            ],
            "id":"site2",
            "additionalLocaleIds":[
                "3",
                "4",
                "5"
            ]
        },
        {
            "priceListGroupList":[
                {
                    "repositoryId":"defaultPriceGroup",
                    "id":"defaultPriceGroup"
                }
            ],
            "recommendationsHost":"recs.atgsvcs.example.com",
            "productionURL":"wakko:9080",
            "favicon":null,
            "useDefaultSiteLocale":false,
            "timezone":"america_newyork",
            "allowAlternateCurrency":true,
            "noimage":null,
            "secondaryCurrency":"USD",
            "defaultCatalog":{
                "repositoryId":"cloudLakeCatalog"
            },
            "payShippingInSecondaryCurrency":true,
            "defaultBillingCountryId":"AR",
            "defaultShippingCountryId":null,
            "siteTypes":[
                "commerce"
            ],
            "payTaxInSecondaryCurrency":true,
            "recommendationsPort":"8080",
            "defaultLocaleId":"1",
            "repositoryId":"siteUS",
            "name":"Commerce Cloud Site",
            "additionalProductionURLs":[
                "othersite.example.com"
            ],
            "id":"siteUS",
            "additionalLocaleIds":[
                "3",
                "4",
                "5"
            ]
        }
    ]
}

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