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

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
Path Parameters
  • 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
  • Properties listed here will be excluded in the response payload. Multiple properties can be excluded by listing them separated by comma (,)
  • If this flag is set to true, site information will be returned from production DB. It's default value is false
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getSite_response
Type: object
Show Source
Nested Schema : additionalLocaleIds
Type: array
Additional locale IDs.
Show Source
Nested Schema : inventoryLocations
Type: array
The "inventoryLocations" field, defined as an array, enables users to link multiple inventory locations to a site. If the "inventoryLocations" array includes at least one element, the "inventoryLocationId" field is not considered.
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 : 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: object
Show Source
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",
    "inventoryLocations":[
        "SiteUS-GlenAllen187",
        "SiteUS-GlenAllen188"
    ],
    "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.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top