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
-
activeTheme(optional):
string
The activeTheme for the site.
-
additionalLocaleIds(optional):
array additionalLocaleIds
Additional Country ids.
-
additionalProductionURLs(optional):
array additionalProductionURLs
A list of additional production URLs (without schema). Currently, only plain hostnames are supported.
-
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.
-
defaultBillingCountryId(optional):
string
Default Billing Country ID.
-
defaultCatalog(optional):
object defaultCatalog
The default catalog for the site.
-
defaultLocaleId(optional):
string
The default locale ID.
-
defaultPriceListGroup(optional):
object defaultPriceListGroup
The default PLG for the site.
-
defaultShippingCountryId(optional):
string
Default Shipping Country ID.
-
defaultSite(optional):
string
Whether this is the default site
-
description(optional):
string
Site description.
-
enabled(optional):
boolean
Whether the site is enabled
-
favicon(optional):
string
The favorite icon URL.
-
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.
-
loyaltyPrograms(optional):
array loyaltyPrograms
List of loyalty programs associated with site.
-
name(optional):
string
Site name.
-
noimage(optional):
string
The no image icon URL.
-
paymentOption(optional):
integer
The payment option for the site
-
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
-
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.
-
requireGDPRCookieConsent(optional):
boolean
Require consent to track cookies for personalization per Global Data Protection Regulation (GDPR).
-
requireGDPRP13nConsent(optional):
boolean
Require consent to track personal information per Global Data Protection Regulation (GDPR).
-
secondaryCurrency(optional):
string
Currency used for calculating shipping and tax for loyalty.
-
shipFromAddress(optional):
object shipFromAddress
The ship from address used for tax calculations.
-
siteTypes(optional):
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).
-
timeToLive(optional):
integer
The hold price time value in milliseconds.
-
timezone(optional):
string
The time zone associated with this specific site.
-
type(optional):
string
Type of site, being a store (storeConfiguration) or a website (siteConfiguration).
-
useDefaultSiteLocale(optional):
boolean
Property to decide whether the site to render in default site locale or not.
Nested Schema : additionalProductionURLs
Type:
array
A list of additional production URLs (without schema). Currently, only plain hostnames are supported.
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 for the site.
Show Source
-
displayName(optional):
string
The display name of the default catalog for the site.
-
id(optional):
string
The ID of the default catalog for the site.
-
repositoryId(optional):
string
The ID of the default catalog for the site.
Nested Schema : defaultPriceListGroup
Type:
object
The default PLG for the site.
Show Source
-
active(optional):
boolean
Whether the PLG is active
-
deleted(optional):
boolean
Whether the PLG is deleted
-
id(optional):
string
The priceListGroup id associated with the site.
-
repositoryId(optional):
string
The priceListGroup id associated with the site.
Nested Schema : loyaltyPrograms
Type:
array
List of loyalty programs associated with site.
Show Source
Nested Schema : priceListGroupList
Type:
array
List of Price List Groups associated with the site including default Price List Group
Show Source
Nested Schema : shipFromAddress
Type:
object
The ship from address used for tax calculations.
Show Source
-
addressLine1(optional):
string
Ship from address line 1
-
addressLine2(optional):
string
Ship from address line 2
-
addressLine3(optional):
string
Ship from address line 3
-
city(optional):
string
Ship from city
-
country(optional):
string
Ship from country
-
postalCode(optional):
string
Ship from postal code
-
region(optional):
string
Ship from region
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).
Show Source
Nested Schema : items
Type:
Show Source
object
-
associationDate(optional):
string
Association date of loyalty program to site.
-
programId(optional):
string
Loyalty Program Id.
-
programName(optional):
string
Name for loyalty program.
-
repositoryId(optional):
string
The loyalty program id associated with the site.
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
true if priceListGroup is active otherwise false
-
deleted(optional):
boolean
true if priceListGroup is deleted otherwise false
-
id(optional):
string
The priceListGroup id associated with site.
-
repositoryId(optional):
string
The priceListGroup id associated with the site.
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