Retrieving a site

GET {{baseUrl}}/site/{{tenant}}/sites/main?expand=payment:all,shipping:active,tax:none

Retrieves a specified site's configuration.


Required scopes

  • site.site_manage

Note: The site.site_manage scope is only required if you want to retrieve an inactive site.

Request Params

KeyDatatypeRequiredDescription
expandstringUsed to expand the following site settings:
  • payment
  • shipping
  • tax Each of the settings can be set to one of the following values:
  • all
  • active
  • none |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"Response example":{"value":{"code":"example","name":"Example Site","active":true,"defaultLanguage":"en","languages":["en"],"currency":"EUR","homeBase":{"address":{"zipCode":"unknown","country":"DE"}},"shipToCountries":["DE"],"shipping":[{"id":"default","serviceType":"urn:x-yaas:service:shipping","serviceUrl":"https://saas-ag-prod.apigee.net/caas-shipping","active":true}],"payment":[{"id":"stripe","name":"Stripe Payment Service","serviceType":"urn:x-yaas:service:payment","serviceUrl":"http://iban-validator","active":true}],"tax":[],"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}}}