getSite
get
/ccadmin/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: string
The ID (repositoryId) of the site to get. There is a pseudo-ID of "defaultSite" that can be used to get the current default site.
Query Parameters
-
exclude(optional): string
Properties listed here will be excluded in the response payload. Multiple properties can be excluded by listing them separated by comma (,)
-
production(optional): boolean
If this flag is set to true, site information will be returned from production DB. It's default value is false
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getSite_response
Type:
Show Source
object
-
additionalLocaleIds(optional):
array additionalLocaleIds
Additional Country ids.
-
additionalProductionURLs(optional):
array additionalProductionURLs
The array of additional production URLs
-
allowAlternateCurrency(optional):
boolean
Allows the order to be paid in mixed currencies
-
allowedOriginMethods(optional):
object allowedOriginMethods
Additional Properties Allowed: additionalPropertiesMap of hostname (key) and the allowed http methods (values) for that host.
-
billingCountries(optional):
array billingCountries
The list of billing countries
-
cartSharingId(optional):
string
ID of a site group if this site can share carts with other sites. The value will be null if this site cannot share carts.
-
contextRoot(optional):
string
The context root of the site
-
defaultAccessLevel(optional):
string
The default access level of the site
-
defaultBillingCountryId(optional):
string
Default Billing Country ID.
-
defaultCatalog(optional):
object defaultCatalog
The default catalog associated with the site
-
defaultListPriceList(optional):
object defaultListPriceList
The default list price list
-
defaultLocaleId(optional):
string
The default locale ID.
-
defaultPriceListGroup(optional):
object defaultPriceListGroup
The default price list group
-
defaultSalePriceList(optional):
object defaultSalePriceList
The default sale price list
-
defaultShippingCountryId(optional):
string
Default Shipping Country ID.
-
defaultShippingSurchargePriceList(optional):
object defaultShippingSurchargePriceList
The default shipping surcharge price list
-
description(optional):
string
Site description.
-
emailAddress(optional):
string
The email address of the author
-
enabled(optional):
boolean
Is the site currently enabled
-
endecaSiteId(optional):
string
The endeca site associated with this site
-
exchangeRate(optional):
number
Exchange rate between the selected priceListGroup's currency code and the site currency code
-
favicon(optional):
string
The URL of the favicon
-
id(optional):
string
Id of the site.
-
inventoryLocationId(optional):
string
Defines which inventory this site should use by default.
-
longDescription(optional):
string
Long site description.
-
masterCatalog(optional):
object masterCatalog
The master catalog for the site
-
maxCouponsPerOrder(optional):
integer
Maximum coupons allowed per order (null if not applicable)
-
name(optional):
string
Site name.
-
paymentGateways(optional):
array paymentGateways
The array of the payment gateway names
-
payShippingInSecondaryCurrency(optional):
boolean
Pay shipping charges in secondary currency
-
payTaxInSecondaryCurrency(optional):
boolean
Pay tax in secondary currency
-
priceListGroupList(optional):
array priceListGroupList
List of Price List Groups associated with the site including default Price List Group
-
productionURL(optional):
string
The production base url for storefront. If set, this base url will be used for any absolute generated links e.g. sitemap urls
-
profileContextList(optional):
object profileContextList
The list of profile contexts
-
realmId(optional):
string
The realm id
-
recommendationsHost(optional):
string
The host name of the recommendations server.
-
recommendationsPort(optional):
string
The port of the recommendations server
-
repositoryId(optional):
string
Repository ID of the site.
-
secondaryCurrency(optional):
string
Currency used for calculating shipping and tax for loyalty.
-
sfVersion(optional):
string
The storefront version
-
siteDownURL(optional):
string
The site down URL
-
siteIcon(optional):
string
The URL of the site icon
-
siteTemplate(optional):
string
The site template name
-
siteTypes(optional):
array siteTypes
List of site types supported by this site. Each site type has to be one of the allowed siteType options (case sensitive)
-
timeToLive(optional):
integer
The hold price time value in milliseconds.
-
type(optional):
string
The site type
-
useDefaultSiteLocale(optional):
boolean
Property to decide whether the site to render in default site locale or not.
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 : defaultCatalog
Type:
object
The default catalog associated with the site
Show Source
-
allRootCategories(optional):
array allRootCategories
The array of all root categories
-
repositoryId(optional):
string
The repository id of the catalog
-
rootCategories(optional):
array rootCategories
The root categories of the default catalog
Nested Schema : defaultListPriceList
Type:
object
The default list price list
Show Source
-
repositoryId(optional):
string
Repository id of the default sale price list
Nested Schema : defaultPriceListGroup
Type:
object
The default price list group
Show Source
-
active(optional):
boolean
true if priceListGroup is active otherwise false
-
currency(optional):
object currency
The currency of the price list group
-
deleted(optional):
boolean
true if priceListGroup is deleted otherwise false
-
displayName(optional):
string
The display name of the price list group
-
id(optional):
string
The priceListGroup id associated with site.
-
locale(optional):
string
The locale associated with the price list group
-
repositoryId(optional):
string
The priceListGroup id associated with the site.
Nested Schema : defaultSalePriceList
Type:
object
The default sale price list
Show Source
-
repositoryId(optional):
string
Repository id of the default sale price list
Nested Schema : defaultShippingSurchargePriceList
Type:
object
The default shipping surcharge price list
Show Source
-
repositoryId(optional):
string
Repository id of the default sale price list
Nested Schema : masterCatalog
Type:
object
The master catalog for the site
Show Source
-
allRootCategories(optional):
array allRootCategories
The array of all root categories
-
repositoryId(optional):
string
The repository id of the catalog
-
rootCategories(optional):
array rootCategories
The root categories of the default catalog
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
-
repositoryId(optional):
string
The repository id of the profile context
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:
Show Source
object
-
countryCode(optional):
string
The country code
-
displayName(optional):
string
The display name of the country
-
repositoryId(optional):
string
The repository id of the country
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
Whether the category is active
-
categoryIdPaths(optional):
array categoryIdPaths
The ids of the paths associated with the category
-
categoryImages(optional):
array categoryImages
The array of image URLs associated with the category
-
categoryPaths(optional):
array categoryPaths
The category paths of the category
-
childCategories(optional):
array childCategories
The array of child categories
-
creationDate(optional):
string
The ISO 8601 date representing the creation date of the category
-
description(optional):
string
The description of the category
-
displayName(optional):
string
The display name of the category
-
fixedParentCategories(optional):
array fixedParentCategories
The array of the fixed parent categories.
-
id(optional):
string
The id of the category
-
longDescription(optional):
string
The long description of the category
-
repositoryId(optional):
string
The repository id of the category
-
route(optional):
string
The route of the category
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 : fixedParentCategories
Type:
array
The array of the fixed parent categories.
Show Source
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
The repository id of the child categories
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
The repository id of the child categories
Nested Schema : currency
Type:
object
The currency of the price list group
Show Source
-
currencyCode(optional):
string
The currency code
-
displayName(optional):
string
The display name of the currency
-
fractionalDigits(optional):
integer
The fractional digits allowed in the currency
-
numericCode(optional):
string
The numeric code representing the currency
-
repositoryId(optional):
string
The repository id of the currency
-
symbol(optional):
string
The symbol of the currency
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
Whether the category is active
-
categoryIdPaths(optional):
array categoryIdPaths
The ids of the paths associated with the category
-
categoryImages(optional):
array categoryImages
The array of image URLs associated with the category
-
categoryPaths(optional):
array categoryPaths
The category paths of the category
-
childCategories(optional):
array childCategories
The array of child categories
-
creationDate(optional):
string
The ISO 8601 date representing the creation date of the category
-
description(optional):
string
The description of the category
-
displayName(optional):
string
The display name of the category
-
fixedParentCategories(optional):
array fixedParentCategories
The array of the fixed parent categories
-
id(optional):
string
The id of the category
-
longDescription(optional):
string
The long description of the category
-
repositoryId(optional):
string
The repository id of the category
-
route(optional):
string
The route of the category
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 : fixedParentCategories
Type:
array
The array of the fixed parent categories
Show Source
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
The repository id of the child categories
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
The repository id of the child categories
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
true if priceListGroup is active otherwise false
-
currency(optional):
object currency
The currency of the price list group
-
deleted(optional):
boolean
true if priceListGroup is deleted otherwise false
-
displayName(optional):
string
The display name of the price list group
-
id(optional):
string
The priceListGroup id associated with site.
-
locale(optional):
string
The locale associated with the price list group
-
repositoryId(optional):
string
The priceListGroup id associated with the site.
Nested Schema : currency
Type:
object
The currency of the price list group
Show Source
-
currencyCode(optional):
string
The currency code
-
displayName(optional):
string
The display name of the currency
-
fractionalDigits(optional):
integer
The fractional digits allowed in the currency
-
numericCode(optional):
string
The numeric code representing the currency
-
repositoryId(optional):
string
The repository id of the currency
-
symbol(optional):
string
The symbol of the currency
Example Response (application/json)
{
"priceListGroupList":[
{
"deleted":false,
"repositoryId":"defaultPriceGroup",
"active":false,
"id":"defaultPriceGroup"
},
{
"deleted":false,
"repositoryId":"EURO",
"active":false,
"id":"EURO"
}
],
"inventoryLocationId":"SiteUS-GlenAllen187",
"productionURL":"https://www.example.com",
"useDefaultSiteLocale":false,
"timezone":"europe_london",
"secondaryCurrency":"USD",
"requireGDPRP13nConsent":false,
"type":"siteConfiguration",
"defaultBillingCountryId":"US",
"defaultShippingCountryId":"US",
"enabled":true,
"payTaxInSecondaryCurrency":true,
"requireGDPRCookieConsent":false,
"timeToLive":null,
"defaultLocaleId":"1",
"loyaltyPrograms":[
{
"programName":"Movie rewards",
"repositoryId":"siteUS_LP0001",
"associationDate":"2017-07-05T14:15:37.000Z",
"programId":"LP0001"
}
],
"id":"siteUS",
"additionalLocaleIds":[
"1"
],
"favicon":null,
"allowAlternateCurrency":true,
"allowedOriginMethods":{
"https://somemoresecurehost":"GET",
"https://someHost:9080":"GET,PUT,DELETE,POST,OPTIONS"
},
"noimage":null,
"payShippingInSecondaryCurrency":true,
"siteTypes":[
"b2bCommerce"
],
"shipFromAddress":{
"country":"US",
"city":"Cambridge",
"postalCode":"02142",
"addressLine1":"1 Main Street",
"addressLine2":"Foo",
"addressLine3":"Bar",
"region":"MA"
},
"name":"CloudLake US Site",
"repositoryId":"siteUS"
}
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|
|30010|A site id is required to update a site|
|30016|Site internal error.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code