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

getSites

get

/ccadmin/v1/sites

Get Sites. Get the list of available sites.

Request

Supported Media Types
  • application/json
Query Parameters
expand
Type: boolean
Specify whether an expanded response must be served
includeHistorical
Type: boolean
The historical sites flag, if you want historicalSites then make it true
q
Type: string
The search query string in SCIM format. Results will be filtered based on this query.
Header Parameters
X-CCAsset-Language
Type: string
The asset language of the request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getSites_response
Nested Schema : items
Type: array
The list of available sites
Nested Schema : items
Type: object
Nested Schema : additionalLocaleIds
Type: array
IDs of additional locales.
Nested Schema : additionalProductionURLs
Type: array
A list of additional production URLs (without schema). Currently, only plain hostnames are supported.
Nested Schema : defaultCatalog
Type: object
The default catalog for the 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
The list of site types.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example 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":"pt-recs-app1.us.oracle.com",
            "productionURL":"wakko:9080",
            "favicon":null,
            "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":[
                "mysite.com"
            ],
            "id":"site2",
            "additionalLocaleIds":[
                "3",
                "4",
                "5"
            ]
        },
        {
            "priceListGroupList":[
                {
                    "repositoryId":"defaultPriceGroup",
                    "id":"defaultPriceGroup"
                }
            ],
            "recommendationsHost":"pt-recs-app1.us.oracle.com",
            "productionURL":"wakko:9080",
            "favicon":null,
            "timezone":"america_newyork",
            "noimage":null,
            "secondaryCurrency":"USD",
            "defaultCatalog":{
                "repositoryId":"cloudLakeCatalog"
            },
            "defaultBillingCountryId":"AR",
            "defaultShippingCountryId":null,
            "siteTypes":[
                "commerce"
            ],
            "recommendationsPort":"8080",
            "defaultLocaleId":"1",
            "repositoryId":"siteUS",
            "name":"Commerce Cloud Site",
            "additionalProductionURLs":[
                "othersite.com"
            ],
            "id":"siteUS",
            "additionalLocaleIds":[
                "3",
                "4",
                "5"
            ]
        }
    ]
}
Default Response
The error response
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:

{
  "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": "pt-recs-app1.us.oracle.com",
      "productionURL": "wakko:9080",
      "favicon": null,
      "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": ["mysite.com"],
      "id": "site2",
      "additionalLocaleIds": [
        "3",
        "4",
        "5"
      ]
    },
    {
      "priceListGroupList": [{
        "repositoryId": "defaultPriceGroup",
        "id": "defaultPriceGroup"
      }],
      "recommendationsHost": "pt-recs-app1.us.oracle.com",
      "productionURL": "wakko:9080",
      "favicon": null,
      "timezone": "america_newyork",
      "noimage": null,
      "secondaryCurrency": "USD",
      "defaultCatalog": {"repositoryId": "cloudLakeCatalog"},
      "defaultBillingCountryId": "AR",
      "defaultShippingCountryId": null,
      "siteTypes": ["commerce"],
      "recommendationsPort": "8080",
      "defaultLocaleId": "1",
      "repositoryId": "siteUS",
      "name": "Commerce Cloud Site",
      "additionalProductionURLs": ["othersite.com"],
      "id": "siteUS",
      "additionalLocaleIds": [
        "3",
        "4",
        "5"
      ]
    }
  ]
}