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

getSite

get

/ccagent/v1/sites/{id}

Get Site. Get a site by ID. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the site.
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 : 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":[
        {
            "repositoryId":"defaultPriceGroup",
            "id":"defaultPriceGroup"
        }
    ],
    "productionURL":"localhostSiteUS:8080",
    "recommendationsHost":"pt-recs-app1.us.oracle.com",
    "noimage":"/file/v3496256495527410201/general/19417364_10155381677403926_746513040903355218_o.jpg",
    "description":"Commerce Cloud Site",
    "secondaryCurrency":"USD",
    "defaultPriceListGroup":{
        "repositoryId":"defaultPriceGroup",
        "id":"defaultPriceGroup"
    },
    "defaultCatalog":{
        "repositoryId":"cloudLakeCatalog"
    },
    "defaultBillingCountryId":null,
    "defaultShippingCountryId":null,
    "enabled":true,
    "siteTypes":[
        "commerce"
    ],
    "recommendationsPort":"8080",
    "defaultLocaleId":"1",
    "loyaltyPrograms":[
        {
            "programName":"Movie rewards",
            "repositoryId":"siteUS_LP0001",
            "associationDate":"2017-07-05T14:15:37.000Z",
            "programId":"LP0001"
        }
    ],
    "repositoryId":"siteUS",
    "name":"Commerce Cloud Site",
    "additionalProductionURLs":[
    ],
    "id":"siteUS",
    "defaultSite":true,
    "additionalLocaleIds":[
    ]
}
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|Could not get site for the id| |30011|Given Site id does not exist| |30016|Site internal error.|
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": [{
    "repositoryId": "defaultPriceGroup",
    "id": "defaultPriceGroup"
  }],
  "productionURL": "localhostSiteUS:8080",
  "recommendationsHost": "pt-recs-app1.us.oracle.com",
  "noimage": "/file/v3496256495527410201/general/19417364_10155381677403926_746513040903355218_o.jpg",
  "description": "Commerce Cloud Site",
  "secondaryCurrency": "USD",
  "defaultPriceListGroup": {
    "repositoryId": "defaultPriceGroup",
    "id": "defaultPriceGroup"
  },
  "defaultCatalog": {"repositoryId": "cloudLakeCatalog"},
  "defaultBillingCountryId": null,
  "defaultShippingCountryId": null,
  "enabled": true,
  "siteTypes": ["commerce"],
  "recommendationsPort": "8080",
  "defaultLocaleId": "1",
  "loyaltyPrograms": [{
    "programName": "Movie rewards",
    "repositoryId": "siteUS_LP0001",
    "associationDate": "2017-07-05T14:15:37.000Z",
    "programId": "LP0001"
  }],
  "repositoryId": "siteUS",
  "name": "Commerce Cloud Site",
  "additionalProductionURLs": [],
  "id": "siteUS",
  "defaultSite": true,
  "additionalLocaleIds": []
}