Mixins

Retrieving site mixins

get

Retrieves all mixins for a specified site.

Required scopes

This endpoint requires the following scopes:

: Needed to manage sites.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

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

siteCodestringRequired

Site code, defined when a site is created.

Responses

200

application/json

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

Other propertiesanyOptional

400Error

application/json

401Error

application/json

403Error

application/json

get

/site/{tenant}/sites/{siteCode}/mixins

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/emporix-docs/couponSettingsSiteMixIn.v4"
    }
  },
  "merchantInfo": {
    "merchantName": "Emporix",
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/emporix-docs/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/emporix-docs/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/emporix-docs/imageSize.v6"
    }
  },
  "feeService": {
    "serviceUrl": "https://api.emporix.io/fee",
    "active": true,
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/emporix-docs/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/emporix-docs/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/emporix-docs/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/emporix-docs/productSettingsSiteMixIn.v1"
    }
  }
}

Creating a site mixin

post

Creates a mixin for a specified site.

Required scopes

This endpoint requires the following scopes:

: Needed to manage sites.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant 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

/site/{tenant}/sites/{siteCode}/mixins

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: 155

{
  "testMixin": {
    "active": true,
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/emporix-docs/695388d813fd4242de135807_testMixin_v1.json"
    }
  }
}

{
  "id": "test"
}

Retrieving a site mixin

get

Retrieves a specified site mixin.

Required scopes

This endpoint requires the following scopes:

: Needed to manage sites.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant 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

application/json

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

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

get

/site/{tenant}/sites/{siteCode}/mixins/{mixinName}

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/emporix-docs/customerSettingsSiteMixIn.v3"
      }
    }
  }
}

Fully updating a site mixin

put

Fully updates a specified site mixin.

Required scopes

This endpoint requires the following scopes:

: Needed to manage sites.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant 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

No content

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

put

/site/{tenant}/sites/{siteCode}/mixins/{mixinName}

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: 155

{
  "testMixin": {
    "active": true,
    "metadata": {
      "schema": "https://res.cloudinary.com/saas-ag/raw/upload/emporix-docs/695388d813fd4242de135807_testMixin_v1.json"
    }
  }
}

No content

Deleting a site mixin

delete

Deletes a specified site mixin.

Required scopes

This endpoint requires the following scopes:

: Needed to manage sites.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant 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

/site/{tenant}/sites/{siteCode}/mixins/{mixinName}

DELETE /site/{tenant}/sites/{siteCode}/mixins/{mixinName} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Partially updating a site mixin

patch

Partially updates a specified site mixin.

Required scopes

This endpoint requires the following scopes:

: Needed to manage sites.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant 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

No content

400Error

application/json

401Error

application/json

403Error

application/json

patch

/site/{tenant}/sites/{siteCode}/mixins/{mixinName}

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

PreviousSite Settings NextSite settings

Last updated 4 months ago

Was this helpful?