getSites
get
/ccagent/v1/sites
Get Sites. Get the list of all sites.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getSites_response
Type:
Show Source
object
-
items(optional):
array items
The list of available sites
-
limit(optional):
integer
The limit
-
offset(optional):
integer
The offset
-
sort(optional):
array sort
Array having the order and property of sites.
-
total(optional):
integer
The total count
-
totalResults(optional):
integer
The total results count
Nested Schema : items
Type:
Show Source
object
-
activeTheme(optional):
string
The activeTheme for the site.
-
additionalLocaleIds(optional):
array additionalLocaleIds
IDs of additional locales.
-
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
The default billing country ID.
-
defaultCatalog(optional):
object defaultCatalog
The default catalog for the site.
-
defaultLocaleId(optional):
string
The ID for the default locale of the site.
-
defaultPriceListGroup(optional):
object defaultPriceListGroup
The default PLG for the site.
-
defaultShippingCountryId(optional):
string
The default shipping country ID.
-
defaultSite(optional):
string
Whether this is the default site
-
description(optional):
string
A description of the site.
-
enabled(optional):
boolean
Whether the site is enabled
-
favicon(optional):
string
The favorite icon URL.
-
id(optional):
string
The repository ID of the site.
-
inventoryLocationId(optional):
string
Defines which inventory this site should use by default.
-
longDescription(optional):
string
A long description of the site.
-
loyaltyPrograms(optional):
array loyaltyPrograms
List of loyalty programs associated with site.
-
name(optional):
string
The name of the site.
-
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 priceListGroups to be associated with site.
-
productionURL(optional):
string
The production URL (without the scheme) of the server. Currently, only hostnames are support.
-
recommendationsHost(optional):
string
The host name of the recommendations server.
-
recommendationsPort(optional):
string
The port of the recommendations server.
-
repositoryId(optional):
string
The repository ID of the site.
-
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
The list of site types.
-
timeToLive(optional):
integer
The timeToLive of the site
-
timezone(optional):
string
The time zone for this site.
-
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 priceListGroups to be associated with site.
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 : 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
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 : items
Type:
Show Source
object
-
order(optional):
string
The sort order: either asc or desc.
-
property(optional):
string
The property sorted on.
Example Response (application/json)
{
"endingIndex":250,
"totalResultsParam":true,
"sort":{
"collator":null,
"numDirectives":1,
"empty":false
},
"items":[
{
"longDescription":"Site to test agent flows",
"priceListGroupList":[
{
"repositoryId":"defaultPriceGroup",
"id":"defaultPriceGroup"
},
{
"repositoryId":"JPYSiteA",
"id":"JPYSiteA"
}
],
"inventoryLocationId":"SiteUS-GlenAllen187",
"productionURL":"localhost:8080",
"recommendationsHost":"recs.atgsvcs.example.com",
"noimage":null,
"description":"New Site A",
"defaultPriceListGroup":{
"repositoryId":"JPYSiteA",
"id":"JPYSiteA"
},
"defaultCatalog":{
"repositoryId":"SiteACatalog"
},
"defaultBillingCountryId":null,
"defaultShippingCountryId":null,
"enabled":true,
"siteTypes":[
"commerce"
],
"recommendationsPort":"8080",
"defaultLocaleId":"1",
"repositoryId":"SiteA",
"name":"Site Agent",
"additionalProductionURLs":[
],
"id":"SiteA",
"defaultSite":false,
"additionalLocaleIds":[
]
},
{
"longDescription":null,
"priceListGroupList":[
{
"repositoryId":"defaultPriceGroup",
"id":"defaultPriceGroup"
}
],
"productionURL":"localhostSiteUS:8080",
"recommendationsHost":"recs.atgsvcs.example.com",
"allowAlternateCurrency":true,
"noimage":"/file/v3496256495527410201/general/19417364_10155381677403926_746513040903355218_o.jpg",
"description":"Commerce Cloud Site",
"secondaryCurrency":"USD",
"defaultPriceListGroup":{
"repositoryId":"defaultPriceGroup",
"id":"defaultPriceGroup"
},
"defaultCatalog":{
"repositoryId":"cloudLakeCatalog"
},
"payShippingInSecondaryCurrency":true,
"defaultBillingCountryId":null,
"defaultShippingCountryId":null,
"enabled":true,
"siteTypes":[
"commerce"
],
"payTaxInSecondaryCurrency":true,
"recommendationsPort":"8080",
"defaultLocaleId":"1",
"repositoryId":"siteUS",
"name":"Commerce Cloud Site",
"additionalProductionURLs":[
],
"id":"siteUS",
"defaultSite":true,
"additionalLocaleIds":[
]
}
],
"startingIndex":0,
"totalNumberOfItems":2
}
Default Response
The error response
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