Oracle Commerce Cloud October 2017

getSite

get

/ccstore/v1/sites/{id}

Get Site. Get a site by id.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The id of the site.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getSite_response

Properties

additionalLocaleIds: Type: array additionalLocaleIds

Additional locale IDs.
defaultBillingCountryId: Type: string

Default Billing Country ID.
defaultCatalog: Type: string

Default catalog id.
defaultLocaleId: Type: string

The default locale ID.
defaultPriceListGroup: Type: string

Default price list group id.
defaultShippingCountryId: Type: string

Default Shipping Country ID.
defaultSite: Type: boolean

Indicates if the site is a default site
description: Type: string

Site description.
enabled: Type: boolean

Indicates if the site is enabled
id: Type: string

ID of the site.
longDescription: Type: string

Long site description.
name: Type: string

Site name.
noimage: Type: string

Site specific no-image image
priceListGroupList: Type: array priceListGroupList

List of Price List Groups associated with the site including default Price List Group
productionURL: Type: string

The production base url for storefront. If set, this base url will be used for any absolute generated links e.g. sitemap urls
recommendationsHost: Type: string

The host name of the recommendations server.
recommendationsPort: Type: string

The port of the recommendations server
repositoryId: Type: string

Repository ID of the site.
secondaryCurrency: Type: string

Currency used for calculating shipping and tax for loyalty.
siteTypes: Type: array siteTypes

List of site types supported by this site. Each site type has has to be one of the allowed siteType options (case sensitive).

Nested Schema : additionalLocaleIds

Type: array

Additional locale IDs.

Items

Type: string

Nested Schema : priceListGroupList

Type: array

List of Price List Groups associated with the site including default Price List Group

Items

Type: object items

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).

Items

Type: string

Nested Schema : items

Type: object

Properties

id: Type: string

The priceListGroup id associated with site.
repositoryId: Type: string

The priceListGroup id associated with the site.

Example 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"
        }
    ],
    "productionURL":null,
    "description":"Commerce Cloud Site",
    "lastPublishedTime":-1,
    "secondaryCurrency":"USD",
    "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,
    "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"
        }
    ],
    "maxCouponsPerOrder":null,
    "siteTemplate":"cloudSiteTemplate",
    "paymentGateways":[
    ],
    "siteIcon":null,
    "additionalProductionURLs":[
    ],
    "id":"siteUS",
    "defaultSalePriceList":{
        "repositoryId":"salePrices"
    },
    "additionalLocaleIds":[
    ],
    "siteDownURL":null,
    "defaultListPriceList":{
        "repositoryId":"listPrices"
    },
    "realmId":null,
    "recommendationsHost":"some.machine.us.example.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,
    "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"
    ],
    "___etag___":"eyJ2ZXJzaW9uIjowLCJ1cmkiOiJzaXRlcy9zaXRlVVMiLCJoYXNoIjoiKzBuZCtBPT0ifQ==",
    "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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "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"
  }],
  "productionURL": null,
  "description": "Commerce Cloud Site",
  "lastPublishedTime": -1,
  "secondaryCurrency": "USD",
  "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,
  "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"
    }
  ],
  "maxCouponsPerOrder": null,
  "siteTemplate": "cloudSiteTemplate",
  "paymentGateways": [],
  "siteIcon": null,
  "additionalProductionURLs": [],
  "id": "siteUS",
  "defaultSalePriceList": {"repositoryId": "salePrices"},
  "additionalLocaleIds": [],
  "siteDownURL": null,
  "defaultListPriceList": {"repositoryId": "listPrices"},
  "realmId": null,
  "recommendationsHost": "some.recs.host.example.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,
  "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"],
  "___etag___": "eyJ2ZXJzaW9uIjowLCJ1cmkiOiJzaXRlcy9zaXRlVVMiLCJoYXNoIjoiKzBuZCtBPT0ifQ==",
  "recommendationsPort": "8080",
  "repositoryId": "siteUS",
  "profileContextList": {"repositoryId": "siteUS-catalogAndPriceGroups"},
  "name": "Commerce Cloud Site"
}