Retrieving sites
GET {{baseUrl}}/site/{{tenant}}/sites?totalCount=false&includeInactive=false&sort=sin&pageNumber=1&pageSize=16&expand=mixin:*,payment:all,shipping:active,tax:none
Retrieves a list of site configurations.
Required scopes
site.site_manage
Note: The site.site_manage scope is only required if you want to retrieve inactive sites.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
totalCount | boolean | If set to true, a total number of sites is returned in a response header. | |
includeInactive | boolean | ||
| --- | --- | ||
true | Retrieves both the active and inactive sites. | ||
false | Retrieves only the active sites. | ||
sort | string | List of properties used to sort the results, separated by commas. |
Possible values:
{fieldName}{fieldName}.asc{fieldName}.desc
Note: If you want to sort the results by localized properties, the possible values are:
{fieldName}.{language}{fieldName}.{language}.asc{fieldName}.{language}.desc
By default, the fields are sorted in ascending order.
|
| pageNumber | number | | Page number to be retrieved. The number of the first page is 1.
Note: If the pageNumber parameter is passed, size of the pages must be specified in the pageSize parameter.
|
| pageSize | number | | Number of products to be retrieved per page.
|
| expand | string | | |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"code":"main","name":"Default configuration for {tenant}","active":true,"defaultLanguage":"en","languages":["en"],"currency":"EUR","homeBase":{"address":{"zipCode":"unknown","country":"DE"}},"shipToCountries":["DE"],"metadata":{"mixins":{"customerSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/customerSettingsSiteMixIn.v3","storeIconImageKey":"https://res.cloudinary.com/saas-ag/raw/upload/hybriscommerce/storeLogoImageKey-v1.json","orderProcessSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/orderProcessSettingsSiteMixIn.v7","merchantInfo":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/merchantAddressMixin.v10","storeLogoImageKey":"https://res.cloudinary.com/saas-ag/raw/upload/hybriscommerce/storeLogoImageKey-v1.json","productSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/productSettingsSiteMixIn.v1","generalShopSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/generalShopSettingsSiteMixIn.v10","siteUrls":"https://res.cloudinary.com/saas-ag/raw/upload/hybriscommerce/site-urls-1.0.0","mapsApiKey":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/mapsApiKey.v1","merchantAddress":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/merchantAddressMixin.v4","couponSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/couponSettingsSiteMixIn.v4","feeService":"https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/siteFeeService.json","deliveryProcessSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/deliveryProcessSettingsSiteMixIn.v1","linkablePages":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/linkablePages.v2","imageSize":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/imageSize.v6","debitSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/debitSettingsSiteMixIn.v3","pickupSettings":"https://res.cloudinary.com/saas-ag/raw/upload/schemata/pickupSettingsSiteMixin.json","templateSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/templateSettings.v1"},"version":1},"default":true},{"code":"example","name":"Example Site","active":true,"defaultLanguage":"en","languages":["en"],"currency":"EUR","homeBase":{"address":{"zipCode":"unknown","country":"DE"}},"shipToCountries":["DE"],"metadata":{"mixins":{"customerSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/customerSettingsSiteMixIn.v3","storeIconImageKey":"https://res.cloudinary.com/saas-ag/raw/upload/hybriscommerce/storeLogoImageKey-v1.json","orderProcessSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/orderProcessSettingsSiteMixIn.v7","merchantInfo":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/merchantAddressMixin.v10","storeLogoImageKey":"https://res.cloudinary.com/saas-ag/raw/upload/hybriscommerce/storeLogoImageKey-v1.json","productSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/productSettingsSiteMixIn.v1","generalShopSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/generalShopSettingsSiteMixIn.v10","siteUrls":"https://res.cloudinary.com/saas-ag/raw/upload/hybriscommerce/site-urls-1.0.0","mapsApiKey":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/mapsApiKey.v1","merchantAddress":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/merchantAddressMixin.v4","couponSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/couponSettingsSiteMixIn.v4","feeService":"https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/siteFeeService.json","deliveryProcessSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/deliveryProcessSettingsSiteMixIn.v1","linkablePages":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/linkablePages.v2","imageSize":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/imageSize.v6","debitSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/debitSettingsSiteMixIn.v3","pickupSettings":"https://res.cloudinary.com/saas-ag/raw/upload/schemata/pickupSettingsSiteMixin.json","templateSettings":"https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/templateSettings.v1"},"version":0},"default":false}]