LogoLogo
CommunitySupport PortalYouTubeStart a free trial
  • Welcome
  • Commerce Engine
  • Orchestration Engine
  • API Documentation
  • Release Notes
  • Changelog
  • Emporix API
    • List of API Services
  • OpenAPI Generator
  • Standard Practices
    • General Info
    • Mixins
    • Query Parameter
    • Translations
    • Custom ID
    • Upsert
    • B2B Token
  • API Guides and References
    • Authorization
      • OAuth Service
        • API Reference
          • Customer Token
          • Anonymous Token
          • Service Access Token
          • Models
        • View Raw API Specification
    • Artificial Intelligence
      • AI Service
        • AI Tutorials
        • API Reference
          • Text Generation
          • AI Completions
          • Models
        • View Raw API Specification
    • Configuration
      • Configuration Service
        • Language Tutorials
        • API Reference
          • Tenant configurations
          • Client configurations
          • Global configurations
          • Models
        • View Raw API Specification
      • Country Service
        • Country Tutorial
        • API Reference
          • Countries
          • Regions
          • Models
        • View Raw API Specification
      • Currency Service
        • Currency Tutorial
        • API Reference
          • Currencies
          • Currency exchange
          • Models
        • View Raw API Specification
      • Unit Handling Service
        • Unit Handling Tutorial
        • API Reference
          • Unit management
          • Type management
          • Unit conversion
          • Models
        • View Raw API Specification
      • Site Settings Service
        • Site Settings Tutorial
        • API Reference
          • Mixins
          • Site settings
          • Models
        • View Raw API Specification
      • Indexing Service
        • Indexing Tutorial
        • API Reference
          • Configuration
          • Public Configuration
          • Reindex
          • Models
        • View Raw API Specification
    • Catalogs and Categories
      • Catalog Service
        • Catalog Tutorials
        • API Reference
          • List catalogs
          • Catalog management
          • Models
        • View Raw API Specification
      • Category Service
        • Category Tutorials
        • API Reference
          • Category Resources
          • Category Assignment Resources
          • Assignment Resources
          • Category Tree Resources
          • Models
        • View Raw API Specification
    • Products, Labels and Brands
      • Product Service
        • Product Tutorial
        • API Reference
          • Products
          • Product Templates
          • Models
        • View Raw API Specification
      • Label Service
        • Label Tutorial
        • API Reference
          • Label
          • Media
          • Models
        • View Raw API Specification
      • Brand Service
        • Brand Tutorial
        • API Reference
          • Brands
          • Media
          • Models
        • View Raw API Specification
    • Prices and Taxes
      • Price Service
        • Price Tutorials
        • API Reference
          • Price lists
          • Price matching
          • Price models
          • Prices
          • Prices assigned to price lists
          • Models
        • View Raw API Specification
      • Tax Service
        • Tax Tutorials
        • API Reference
          • Taxes
          • Tax calculation
          • Models
        • View Raw API Specification
    • Users and Permissions
      • IAM Service
        • IAM Tutorial
        • API Reference
          • Access Controls
          • Group Assignments
          • Groups
          • Permissions
          • Resources
          • Roles
          • Access Control Templates
          • Users
          • Management Dashboard Users
          • Models
        • View Raw API Specification
      • Session-context Service
        • Session-context Tutorial
        • API Reference
          • Session management
          • Session context modification
          • Own session management
          • Own session context modification
          • Models
        • View Raw API Specification
    • Companies and Customers
      • Customer Management
        • Customer Management Tutorial
        • API Reference
          • Locations
          • Contact Assignments
          • Legal Entities
          • Models
        • View Raw API Specification
      • Customer Service (Customer Managed)
        • API Reference
          • Addresses
          • Authentication and authorization
          • Account and profile
          • Double opt In
          • Credentials
          • Models
        • View Raw API Specification
      • Customer Service (Tenant Managed)
        • API Reference
          • Account and profile
          • Addresses
          • Models
        • View Raw API Specification
      • Customer Segments
        • Segments Tutorial
        • API Reference
          • Segments
          • Customers Assignments
          • Items Assignments
          • Models
        • View Raw API Specification
      • Approval Service
        • Approval Tutorials
        • API Reference
          • Approvals
          • Approval
          • Search
          • Models
        • View Raw API Specification
    • Delivery and Shipping
      • Shipping Service
        • Shipping Tutorial
        • API Reference
          • Customer Group Relations
          • Delivery Windows
          • Shipping Cost
          • Shipping Methods
          • Shipping Zones
          • Shipping Groups
          • Sites
          • Delivery Times Management
          • Delivery Times Slots Management
          • Delivery Cycles
          • Models
        • View Raw API Specification
      • Delivery Providers Service
        • API Reference
          • Delivery Orders
          • Delivery Plan
          • Models
        • View Raw API Specification
    • Rewards and Promotions
      • Coupon Service
        • Coupon Tutorial
        • API Reference
          • Coupon Management
          • Coupon Validation
          • Coupon Redemption
          • Referral Coupon Management
          • Models
        • View Raw API Specification
      • Reward-points Service
        • Reward-points Tutorial
        • API Reference
          • Redeem Options Management
          • Signed In Customer Reward Points
          • Reward Points Management
          • Models
        • View Raw API Specification
    • Quotes
      • Quote Service
        • Quote Tutorial
        • API Reference
          • Quote management
          • Quote history
          • Quote pdf
          • Quote reason
          • Models
        • View Raw API Specification
    • Checkout
      • Cart Service
        • Cart Tutorial
        • API Reference
          • Carts
          • Cart items
          • Discounts
          • Models
        • View Raw API Specification
      • Payment-gateway Service
        • Payment-gateway Tutorial
        • API Reference
          • Payment
          • Payment frontend
          • Payment mode
          • Transaction
          • Payment mode frontend
          • Models
        • View Raw API Specification
      • Checkout Service
        • Checkout Tutorial
        • API Reference
          • Checkouts
          • Models
        • View Raw API Specification
      • Fee Service
        • Fee Tutorial
        • API Reference
          • Fee management
          • Item Fee management
          • Product Fees management
          • Item Fee search
          • Models
        • View Raw API Specification
      • Shopping List
        • API Reference
          • Shopping Lists
          • Models
        • View Raw API Specification
    • Orders
      • Availability Service
        • Availability Tutorial
        • API Reference
          • Locations
          • Availabilities
          • Models
        • View Raw API Specification
      • Order Service
        • Order Tutorial
        • API Reference
          • Orders (tenant Managed)
          • Orders (customer Managed)
          • Models
        • View Raw API Specification
      • Pick-pack Service
        • API Reference
          • Orders
          • Assignees
          • Order cycles
          • Recalculations
          • Events
          • Models
        • View Raw API Specification
      • Invoice Service
        • Invoice Tutorial
        • API Reference
          • Invoice Jobs
          • Models
        • View Raw API Specification
      • Returns Service
        • Returns Tutorial
        • API Reference
          • Returns
          • Models
        • View Raw API Specification
      • SEPA Export Service
        • API Reference
          • Files
          • Jobs
          • Models
        • View Raw API Specification
    • Utilities
      • Schema Service
        • Schema Tutorial
        • API Reference
          • Schema
          • Type
          • Reference
          • Custom Schema Type
          • Custom Instance
          • Models
        • View Raw API Specification
      • Sequential-id Service
        • Sequential-id Tutorial
        • API Reference
          • Sequential IDs management
          • Models
        • View Raw API Specification
    • Media
      • Media Service
        • Media Tutorial
        • API Reference
          • Assets
          • Models
        • View Raw API Specification
    • Webhooks
      • Webhook Service
        • Webhooks Tutorial
        • API Reference
          • Config
          • Events
          • Svix Emporix Shared Account
          • Models
        • View Raw API Specification
      • Events-Availability
      • Events-Cart
      • Events-Catalog
      • Events-Category
      • Events-Client Management
      • Events-Customer
      • Events-Index
      • Events-Order
      • Events-Price
      • Events-Product
      • Events-Quote
      • Events-Product
    • Integrations
      • Identity Providers
        • Auth0
      • Workflow Automation
        • Emporix and Make
Powered by GitBook
LogoLogo

Resources

  • Emporix.com
  • Developer Policy
  • Terms of Use

Find us

  • LinkedIn

© 2025 Emporix. All Rights Reserved.

On this page

Was this helpful?

Export as PDF
  1. API Guides and References
  2. Configuration
  3. Site Settings Service
  4. API Reference

Mixins

PreviousAPI ReferenceNextSite settings

Was this helpful?

Retrieving a site mixin

get

Retrieves a specified site mixin.


Required scopes

  • site.site_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant name should always be provided in lowercase.

siteCodestringRequired

Site code, defined when a site is created.

mixinNamestringRequired

Mixin name, defined when the mixin is created.

Responses
200
OK
application/json
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
get
GET /site/{tenant}/sites/{siteCode}/mixins/{mixinName} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "Response example": {
    "value": {
      "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}$"
      },
      "metadata": {
        "schema": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/customerSettingsSiteMixIn.v3"
      }
    }
  }
}

Deleting a site mixin

delete

Deletes a specified site mixin.

Required scopes

  • site.site_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant name should always be provided in lowercase.

siteCodestringRequired

Site code, defined when a site is created.

mixinNamestringRequired

Mixin name, defined when the mixin is created.

Responses
204
No Content
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
delete
DELETE /site/{tenant}/sites/{siteCode}/mixins/{mixinName} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

  • GETRetrieving site mixins
  • POSTCreating a site mixin
  • GETRetrieving a site mixin
  • PUTFully updating a site mixin
  • DELETEDeleting a site mixin
  • PATCHPartially updating a site mixin

Retrieving site mixins

get

Retrieves all mixins for a specified site.


Required scopes

  • site.site_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant name should always be provided in lowercase.

siteCodestringRequired

Site code, defined when a site is created.

Responses
200
OK
application/json
400Error
application/json
401Error
application/json
403Error
application/json
get
GET /site/{tenant}/sites/{siteCode}/mixins HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "couponSettings": {
    "rewardpoints": {
      "codePrefix": "T",
      "orderValueToRewardPointsFactor": 1,
      "enabled": true,
      "validityInMonths": 2
    },
    "codePrefix": "ED",
    "length": 3,
    "referral": {
      "codePrefix": "E",
      "redemptionCodeValue": 8,
      "value": 8,
      "orderValueToRewardPointsFactor": 1
    },
    "sendReferralCoupon": true,
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/couponSettingsSiteMixIn.v4"
    }
  },
  "merchantInfo": {
    "merchantName": "Emporix",
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/merchantAddressMixin.v10"
    }
  },
  "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}$"
    },
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/customerSettingsSiteMixIn.v3"
    }
  },
  "imageSize": {
    "productTileSizes": {
      "default": "214x160"
    },
    "productDetailSizes": {
      "mobile": "347x261",
      "tablet": "290x218",
      "desktop": "490x367"
    },
    "basketLineItemImage": {
      "mobile": "40x30",
      "tablet": "47x35",
      "desktop": "60x45",
      "default": "60x45"
    },
    "imageSlider": {
      "desktop": "1473x491",
      "tablet": "960x320",
      "mobile": "379x133"
    },
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/imageSize.v6"
    }
  },
  "feeService": {
    "serviceUrl": "https://api.emporix.io/fee",
    "active": true,
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/siteFeeService.json"
    }
  },
  "orderProcessSettings": {
    "checkoutSettings": {
      "minimumOrderValue": 20,
      "lastPossibleOrderTime": 8,
      "lastPossibleOrderTimeDateShift": -1,
      "minOrderAge": 18,
      "maxOrderAge": 100,
      "minDeliveryTimeSpan": 2,
      "cutOffTimeValidationEnabled": false,
      "checkoutElements": {
        "onPickup": {
          "showPackingOptions": false
        },
        "onDelivery": {
          "showPackingOptions": true
        }
      }
    },
    "deliveryTimeToMethodSettings": {
      "1": "1-2_hours_timeframe",
      "3": "3_hours_timeframe",
      "4": "4-more_hours_timeframe",
      "10": "4-more_hours_timeframe"
    },
    "paymentSettings": {
      "paymentByInvoice": true,
      "paymentByDebit": false,
      "paymentByCash": true,
      "paymentByCredit": false
    },
    "pickup": false,
    "pickupTimeToMethodSettings": {
      "1": "pickup"
    },
    "paymentSettingsB2B": {
      "paymentByInvoice": true,
      "paymentByDebit": true,
      "paymentByCash": false,
      "paymentByCredit": false
    },
    "paymentSettingsB2C": {
      "paymentByInvoice": true,
      "paymentByDebit": true,
      "paymentByCash": false,
      "paymentByCredit": false
    },
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/orderProcessSettingsSiteMixIn.v7"
    }
  },
  "generalShopSettings": {
    "footerLogoUrl": "saas-storefront/images/tenant/tenant_logo.png",
    "confirmationPageImageUrl": "saas-storefront/images/misc/Example_neutral_700.png",
    "placeholderLogo": "saas-storefront/images/example/example_placeholder.png",
    "baseStyleUrl": "https://example.com/saas-storefront",
    "duzen": true,
    "primaryColor": "#fff",
    "shopCountry": {
      "code": "DE"
    },
    "brandName": "Example Demo",
    "facebookUrl": "https://www.facebook.com/",
    "backgroundColor": "#fff",
    "logoUrl": "https://res.cloudinary.com/saas-ag/image/upload/v1528267395/example/example_logo.png",
    "clientGroup": "example",
    "trustedShopCode": "none",
    "regionName": "Stuttgart",
    "zoneId": "Europe/Berlin",
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/generalShopSettingsSiteMixIn.v10"
    }
  },
  "productSettings": {
    "serviceOptionsConfiguration": {
      "cuttingOptions": [
        {
          "id": "small",
          "displayText": "Dünn geschnitten"
        },
        {
          "id": "medium",
          "displayText": "Mittel geschnitten"
        },
        {
          "id": "thick",
          "displayText": "Dick geschnitten"
        },
        {
          "id": "atAStretch",
          "displayText": "Am Stück"
        },
        {
          "id": "sliced",
          "displayText": "Geschnitten"
        },
        {
          "id": "slice_100GRM",
          "displayText": "Scheibe (ca. 100 g)"
        },
        {
          "id": "slice_120GRM",
          "displayText": "Scheibe (ca. 120 g)"
        },
        {
          "id": "slice_140GRM",
          "displayText": "Scheibe (ca. 140 g)"
        },
        {
          "id": "slice_160GRM",
          "displayText": "Scheibe (ca. 160 g)"
        },
        {
          "id": "slice_180GRM",
          "displayText": "Scheibe (ca. 180 g)"
        },
        {
          "id": "slice_200GRM",
          "displayText": "Scheibe (ca. 200 g)"
        },
        {
          "id": "slice_220GRM",
          "displayText": "Scheibe (ca. 220 g)"
        },
        {
          "id": "slice_240GRM",
          "displayText": "Scheibe (ca. 240 g)"
        },
        {
          "id": "slice_260GRM",
          "displayText": "Scheibe (ca. 260 g)"
        },
        {
          "id": "flimsy",
          "displayText": "Hauchdünn"
        },
        {
          "id": "cubed",
          "displayText": "Würfel"
        },
        {
          "id": "stripCutted",
          "displayText": "Geschnezelt"
        },
        {
          "id": "slice_50MMT",
          "displayText": "Scheibe (ca. 0,5 cm)"
        },
        {
          "id": "slice_1CMT",
          "displayText": "Scheibe (ca. 1 cm)"
        },
        {
          "id": "slice_2CMT",
          "displayText": "Scheibe (ca. 2 cm)"
        },
        {
          "id": "slice_3CMT",
          "displayText": "Scheibe (ca. 3 cm)"
        },
        {
          "id": "unseasoned",
          "displayText": "Ungewürzt"
        },
        {
          "id": "seasoned",
          "displayText": "Gewürzt"
        },
        {
          "id": "bbqSeasoned",
          "displayText": "Grillgewürz"
        },
        {
          "id": "winemakerSeasoned",
          "displayText": "Weinbauerngewürz"
        },
        {
          "id": "marinadeAvignon",
          "displayText": "Marinade Avignon"
        },
        {
          "id": "marinadeBBQ",
          "displayText": "Marinade Barbecue"
        },
        {
          "id": "marinadeWildGarlic",
          "displayText": "Marinade Bärlauch"
        },
        {
          "id": "marinadeCafeParis",
          "displayText": "Marinade Café de Paris"
        },
        {
          "id": "marinadeClassic",
          "displayText": "Marinade Classic"
        },
        {
          "id": "marinadeCurry",
          "displayText": "Marinade Curry"
        },
        {
          "id": "marinadeHotChili",
          "displayText": "Marinade Hot Chili"
        },
        {
          "id": "marinadeItalia",
          "displayText": "Marinade Italia"
        },
        {
          "id": "marinadeCaribbean",
          "displayText": "Marinade Karibik"
        },
        {
          "id": "marinadeLasVegas",
          "displayText": "Marinade Las Vegas"
        },
        {
          "id": "marinadeTexas",
          "displayText": "Marinade Texas"
        },
        {
          "id": "marinadePaprika",
          "displayText": "Marinade Paprika"
        },
        {
          "id": "marinadeAnanas",
          "displayText": "Marinade Ananas",
          "editing": false
        },
        {
          "id": "loafWhole",
          "displayText": "Ganzer Laib"
        },
        {
          "id": "loafHalf",
          "displayText": "Halber Laib"
        },
        {
          "id": "loafQuarter",
          "displayText": "Viertel Laib"
        },
        {
          "id": "grated",
          "displayText": "Gerieben"
        },
        {
          "id": "Grinded",
          "displayText": "Gemahlen"
        },
        {
          "displayText": "Gemahlt",
          "id": "Ground"
        }
      ],
      "servicePackagingOptions": [
        {
          "id": "paper",
          "displayText": "Papier"
        },
        {
          "id": "vacuum",
          "displayText": "Vakuumiert"
        },
        {
          "displayText": "lose",
          "id": "loose"
        }
      ]
    },
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/hybris_schema/productSettingsSiteMixIn.v1"
    }
  }
}

Creating a site mixin

post

Creates a mixin for a specified site.


Required scopes

  • site.site_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant name should always be provided in lowercase.

siteCodestringRequired

Site code, defined when a site is created.

Body

Represents a single mixin. The payload is represented as a map with a single key and value, where key represents a mixin group name and value represents a map with keys and values.

Other propertiesanyOptional
Responses
201
Created
application/json
400
Bad Request
application/json
401Error
application/json
403Error
application/json
409
Conflict
application/json
post
POST /site/{tenant}/sites/{siteCode}/mixins HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "testMixin": {
    "active": true,
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/testMixin.json"
    }
  }
}
{
  "id": "test"
}

Fully updating a site mixin

put

Fully updates a specified site mixin.


Required scopes

  • site.site_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant name should always be provided in lowercase.

siteCodestringRequired

Site code, defined when a site is created.

mixinNamestringRequired

Mixin name, defined when the mixin is created.

Body

Represents a single mixin. The payload is represented as a map with a single key and value, where key represents a mixin group name and value represents a map with keys and values.

Other propertiesanyOptional
Responses
200
OK
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
put
PUT /site/{tenant}/sites/{siteCode}/mixins/{mixinName} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "testMixin": {
    "active": true,
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/testMixin.json"
    }
  }
}

No content

Partially updating a site mixin

patch

Partially updates a specified site mixin.


Required scopes

  • site.site_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant name should always be provided in lowercase.

siteCodestringRequired

Site code, defined when a site is created.

mixinNamestringRequired

Mixin name, defined when the mixin is created.

Body

Represents a single mixin. The payload is represented as a map with a single key and value, where key represents a mixin group name and value represents a map with keys and values.

Other propertiesanyOptional
Responses
200
OK
400Error
application/json
401Error
application/json
403Error
application/json
patch
PATCH /site/{tenant}/sites/{siteCode}/mixins/{mixinName} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "active": true
}

No content