Site settings
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
If set to true, a total number of sites is returned in a response header.
false| Option | Description |
|---|---|
true |
Retrieves both the active and inactive sites. |
false |
Retrieves only the active sites. |
falseList of properties used to sort the results, separated by colons.
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.
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.
1Number of products to be retrieved per page.
16A standard query parameter used to search for specific values.
name:{productName}Used to expand the following site settings:
paymentshippingtaxmixin
Each of the settings (except mixin) can be set to one of the following values:
allactivenone
For retrieving mixin, use the following value:
*
payment:all,shipping:active,tax:none,mixin:*GET /site/{tenant}/sites HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"code": "main",
"name": "United States",
"active": true,
"defaultLanguage": "en",
"languages": [
"ar",
"en",
"fr",
"de"
],
"currency": "USD",
"availableCurrencies": [
"EUR",
"GBP",
"USD",
"THB",
"RUB",
"SAR"
],
"homeBase": {
"address": {
"street": "Broadway",
"streetNumber": "1500",
"zipCode": "10036",
"city": "New York",
"country": "US",
"state": "NY"
},
"location": {
"latitude": 40.7568658044745,
"longitude": -73.9858713458565
}
},
"shipToCountries": [
"US"
],
"assistedBuying": {
"storefrontUrl": ""
},
"metadata": {
"mixins": {
"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",
"customerSettings": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/customerSettingsSiteMixIn.v3",
"orderProcessSettings": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/orderProcessSettingsSiteMixIn.v7",
"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",
"imageSize": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/imageSize.v6",
"merchantInfo": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/merchantAddressMixin.v10"
},
"version": 14
},
"default": true
}
]Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
Information about the site.
Site's unique identifier.
Site name.
Flag indicating whether the site is active.
Flag indicating whether the site is the tenant's default site.
Indicates whether prices for the site should be returned in gross (when includesTax=true) or net (when includesTax=false).
Site's default language, compliant with the ISO 639-1 standard.
^[a-z]{2}Languages supported by the site.
Note: The languages must be compliant with the ISO 639-1 standard.
Currency used by the site, compliant with the ISO 4217 standard.
^[A-Z]{3}List of the currencies supported by the site
Codes of countries to which the site ships products.
Note: The country codes must be compliant with the ISO 3166-1 alpha-2 standard.
Specifies whether tax calculation is based on customer billing address or shipping address. Default value is BILLING_ADDRESS.
Number of decimal points used in the cart calculation. Must be zero or a positive value.
2POST /site/{tenant}/sites HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 244
{
"code": "test2",
"name": "postmanTestSiteName",
"active": false,
"default": false,
"defaultLanguage": "en",
"languages": [
"en"
],
"currency": "GBP",
"homeBase": {
"address": {
"country": "GB",
"zipCode": "12345"
}
},
"shipToCountries": [
"GB"
],
"mixins": {},
"metadata": {}
}{
"Response example": {
"value": {
"id": "test"
}
}
}Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
Site code, defined when a site is created.
Used to expand the following site settings:
paymentshippingtaxmixin
Each of the settings (except mixin) can be set to one of the following values:
allactivenone
For retrieving mixin, use the following value:
*
payment:all,shipping:active,tax:none,mixin:*GET /site/{tenant}/sites/{siteCode} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"code": "test2",
"name": "postmanTestSiteName",
"active": false,
"defaultLanguage": "en",
"languages": [
"en"
],
"currency": "GBP",
"homeBase": {
"address": {
"zipCode": "12345",
"country": "GB"
}
},
"shipToCountries": [
"GB"
],
"metadata": {
"mixins": {},
"version": 0
},
"default": true
}Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
Site code, defined when a site is created.
Used to expand the following site settings:
paymentshippingtaxmixin
Each of the settings (except mixin) can be set to one of the following values:
allactivenone
For retrieving mixin, use the following value:
*
payment:all,shipping:active,tax:none,mixin:*Information about the site.
Site's unique identifier.
Site name.
Flag indicating whether the site is active.
Flag indicating whether the site is the tenant's default site.
Indicates whether prices for the site should be returned in gross (when includesTax=true) or net (when includesTax=false).
Site's default language, compliant with the ISO 639-1 standard.
^[a-z]{2}Languages supported by the site.
Note: The languages must be compliant with the ISO 639-1 standard.
Currency used by the site, compliant with the ISO 4217 standard.
^[A-Z]{3}List of the currencies supported by the site
Codes of countries to which the site ships products.
Note: The country codes must be compliant with the ISO 3166-1 alpha-2 standard.
Specifies whether tax calculation is based on customer billing address or shipping address. Default value is BILLING_ADDRESS.
Number of decimal points used in the cart calculation. Must be zero or a positive value.
2PUT /site/{tenant}/sites/{siteCode} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 218
{
"name": "test",
"active": true,
"default": false,
"defaultLanguage": "de",
"languages": [
"en",
"de"
],
"currency": "EUR",
"homeBase": {
"address": {
"country": "GB",
"zipCode": "12345"
}
},
"shipToCountries": [
"GB"
],
"mixins": {},
"metadata": {}
}No content
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
Site code, defined when a site is created.
DELETE /site/{tenant}/sites/{siteCode} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
Site code, defined when a site is created.
Information about the site.
Site's unique identifier.
Site name.
Flag indicating whether the site is active.
Flag indicating whether the site is the tenant's default site.
Indicates whether prices for the site should be returned in gross (when includesTax=true) or net (when includesTax=false).
Site's default language, compliant with the ISO 639-1 standard.
^[a-z]{2}Languages supported by the site.
Note: The languages must be compliant with the ISO 639-1 standard.
Currency used by the site, compliant with the ISO 4217 standard.
^[A-Z]{3}List of the currencies supported by the site
Codes of countries to which the site ships products.
Note: The country codes must be compliant with the ISO 3166-1 alpha-2 standard.
Specifies whether tax calculation is based on customer billing address or shipping address. Default value is BILLING_ADDRESS.
Number of decimal points used in the cart calculation. Must be zero or a positive value.
2PATCH /site/{tenant}/sites/{siteCode} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"defaultLanguage": "en"
}No content
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
| Option | Description |
|---|---|
true |
Retrieves both the active and inactive sites. |
false |
Retrieves only the active sites. |
falsePage 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.
1Number of products to be retrieved per page.
16List of properties used to sort the results, separated by colons.
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.
A standard query parameter used to search for specific values.
name:{productName}If set to true, a total number of sites is returned in a response header.
falseUsed to expand specific site settings.
| Setting | Possible values |
|---|---|
payment shipping tax |
all active none |
mixins |
{mixinName} * |
payment:all,shipping:active,tax:none,mixin:customerSettingsGET /site/{tenant}/siteslist HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
"UK",
"FR",
"main",
"DE",
"US"
]Was this helpful?