Creating a site

POST {{baseUrl}}/site/{{tenant}}/sites

Creates a new site configuration.


Required scopes

  • site.site_manage

Request Body

{"Request example"=>{"value"=>{"code"=>"example", "name"=>"Example Site", "active"=>true, "default"=>false, "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}], "mixins"=>{"customerSettings"=>{"regExSettings"=>{"mail"=>"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\\\.[a-zA-Z0-9-.]+$", "phone"=>"^[0-9\\\\+][0-9]{7,}$", "password"=>".{6,}", "bic"=>"^((.{8})|(.{11}))$", "accountOwner"=>"^[a-zA-Z0-9':?,()\\\\-. +/ÄäÜüÖöß&]{0,70}$"}}, "feeService"=>{"serviceUrl"=>"https://saas-ag-prod.apigee.net/fee", "active"=>true}, "orderProcessSettings"=>{"checkoutSettings"=>{"minimumOrderValue"=>1, "lastPossibleOrderTime"=>8, "lastPossibleOrderTimeDateShift"=>-1, "minOrderAge"=>18, "minDeliveryTimeSpan"=>2, "checkoutElements"=>{"onPickup"=>{"showPackingOptions"=>false}, "onDelivery"=>{"showPackingOptions"=>true}}}, "deliveryTimeToMethodSettings"=>[nil, "1-2_hours_timeframe", "1-2_hours_timeframe", "3_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe", "4-more_hours_timeframe"], "paymentSettings"=>{"paymentByInvoice"=>true, "paymentByDebit"=>false, "paymentByCash"=>true, "paymentByCredit"=>false}, "pickup"=>false, "pickupTimeToMethodSettings"=>[nil, "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup", "pickup"], "paymentSettingsB2B"=>{"paymentByInvoice"=>true, "paymentByDebit"=>true, "paymentByCash"=>false, "paymentByCredit"=>false}, "paymentSettingsB2C"=>{"paymentByInvoice"=>true, "paymentByDebit"=>true, "paymentByCash"=>false, "paymentByCredit"=>false}}, "merchantInfo"=>{"merchantName"=>"{tenant}"}}, "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"}}}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: Created

{"Response example":{"value":{"id":"example","link":"http://site-settings.k8s-prod.emporix.io/{tenant}/sites/example"}}}