Commerce Connector Pack releases

This page provides a list of releases and a compatibility matrix for the module to Magnolia version.

E-commerce module changelog

E-commerce module 1.3.6

Released on November 30, 2023.

This release brings an option to customize the query limit for improved performance if needed. For more details, see commercetools connector configuration.

  • ECOMMERCE-543 Commerce tools: queries search only within 20 first items

E-commerce module 1.3.5

Released on October 4, 2023.

This release brings some notable bug fixes.

  • ECOMMERCE-587 The timeouts values for e-commerce connectors are too high

  • ECOMMERCE-564 magnolia-ecommerce-sap-connector requires price for all products

  • ECOMMERCE-565 Cannot select the product on SAP connector in ecommerce chooser

E-commerce module 1.3.4

Released on March 21, 2023.

This release brings some important bug fixes.

E-commerce module 1.3.3

Released on May 2, 2022.

This release significantly improves seeing which products are selected when adding e-commerce content to a page and introduces two new fields for product choosers.

This release is only compatible with Magnolia 6.2.18.

Improvements

  • ECOMMERCE-477

    • Display JSON in text fields of e-commerce meaningfully. The new implementation displays a product’s name and SKU or the category path for categories.

      See for yourself!

      Adding e-commerce content

    • Two new fields ecommerceProductLinkField and ecommerceProductListLinkField extend ecommerceLinkField. See here for a full list of choosers and the E-commerce module documentation for more information on configuring chooser dialogs.

      • product-detail-v3.yaml

        form:
  properties:
    productDetail:
      $type: ecommerceProductLinkField

        See what it looks like…​

        E-commerce product detail

      • product-teaser-v3.yaml

        form:
  properties:
    productTeaser:
      $type: ecommerceProductLinkField

      • product-list-v3.yaml

        form:
  properties:
    productList:
      $type: ecommerceProductListLinkField

        See what it looks like…​

        E-commerce product detail

E-commerce module 1.3.2

Released on March 28, 2022.

This release brings a number of improvements as well as bug and security fixes.

Endpoint/API updates and improvements

Where can I update the endpoint?

In the Resource Files app, you can find the endpoint in the commercetools.yaml file.

commercetools YAML file

In particular, you need to update authUrl and apiUrl to the endpoint given below.

/ecommerce-commercetools-connector/ecommerces/commercetools.yaml
class: info.magnolia.ecommerce.common.EcommerceDefinition
type: commercetools
enabled: true
implementation:
  products:
    all: info.magnolia.ecommerce.commercetools.products.All
    byId: info.magnolia.ecommerce.commercetools.products.ById
    byCategoryId: info.magnolia.ecommerce.commercetools.products.ByCategoryId
    searchByText: info.magnolia.ecommerce.commercetools.products.SearchByText
  categories:
    all: info.magnolia.ecommerce.commercetools.categories.All
    byId: info.magnolia.ecommerce.commercetools.categories.ById
    byParentCategoryId: info.magnolia.ecommerce.commercetools.categories.ByParentCategoryId
    byProductId: info.magnolia.ecommerce.commercetools.categories.ByProductId
  connectionValidator: info.magnolia.ecommerce.commercetools.common.CommercetoolsConnectionValidator
connections:
  connectionName:
    enabled: true
    authUrl: https://auth.sphere.io
    parameters:
      clientId: <client_id>
      clientSecret: <client_secret_or_path_to_password_manager>
      apiUrl: https://api.sphere.io
      projectKey: <project_key>
      limit: 400 (1)
      locale: en (2)

New SAP security and timeouts

  • ECOMMERCE-492 You must use the SAP Application Interface Key (AIR) for any API call to an SAP system since the end of 2021.

  • ECOMMERCE-495 You can adjust the connection timeout if required using the variables connectionTimeoutInSeconds and readTimeoutInSeconds.

Product selection enhancements

  • ECOMMERCE-476 Product chooser default width widened to show all columns optimally.

  • ECOMMERCE-508 Error when selecting a product.

Other fixes and improvements

  • ECOMMERCE-464 Salesforce seems to lose connection from time to time.

  • ECOMMERCE-488 Manage netty version in core BOMs.

  • ECOMMERCE-502 Should not see trace logs from the commercetools client.

  • ECOMMERCE-510 Commercetools: getShippingMethods throws RestExceptionMapper error.

E-commerce module 1.3.1

Released on October 6, 2021.

This release brings a number of improvements.

New ecommerceLinkField field

A new ecommerceLinkField field (extends Link field) has been introduced.

The ecommerceLinkField replaces the ecommerceChooserField, which is deprecated.

Here are the default configurations for the different e-commerce components provided:

/ecommerce-templating/dialogs/components/category-list-v3.yaml
form:
  properties:
    categoryList:
      $type: ecommerceLinkField
      enableCategorySelection: false
/ecommerce-templating/dialogs/components/product-detail-v3.yaml
form:
  properties:
    productDetail:
      $type: ecommerceLinkField
/ecommerce-templating/dialogs/components/product-list-v3.yaml
form:
  properties:
    productList:
      $type: ecommerceLinkField
      enableProductSelection: false
/ecommerce-templating/dialogs/components/product-teaser-v3.yaml
form:
  properties:
    productTeaser:
      $type: ecommerceLinkField

ECOMMERCE-461

New validators

New EcommerceChooserValidator classes have been added to ensure the connection, category and product selected are valid when adding e-commerce content to a page.

(ECOMMERCE-472)

Connection status message display improved

When you test a connection, the result message is now displayed for longer to make it easier to read.

(ECOMMERCE-465)

E-commerce module 1.2.6

Released on October 6, 2021.

This maintenance release:

  • Improves the connection status message: when you test a connection, the result message is now displayed for longer to make it easier to read. (ECOMMERCE-465)

  • Fixes an exception that occurred when selecting a product detail component from the list of previously added products in the dialog. (ECOMMERCE-447)

E-commerce module 1.3

Released on July 21, 2021.

This Magnolia CMS 6.2.9+ compatible release brings improvements and bug fixes:

Intuitive product chooser

A user-friendly product chooser makes finding and selecting categories and products faster and simpler for end users.

Product chooser dialog

Each column provides a filter at the top.

The chooser dialog can also be configured to enable or disable certain columns.

Updated component definitions and template files

You can find component definitions and template files configured under /ecommerce-templating/templates/components.

The components introduced in v1.3 are suffixed with -v3.

Those with no suffix are provided for backwards compatibility with E-commerce v1.2.x.

You can still view and edit the 1.2.x version components but we recommend you recreate your e-commerce pages using the new component definitions to benefit from the new product chooser dialog and other improvements.

E-commerce module 1.2.5

Released on July 21, 2021.

This Magnolia CMS 6.2.2+ compatible maintenance release brings improvements and bug fixes:

Category list and Product list components updated

The sample components Category list and Product list have been aligned with the other e-commerce page components and now provide chooser dialogs for selecting the e-commerce content to be displayed.

The chooser dialogs only store the connectionId property, which consists of {definitionName}/{connectionName} in JCR instead of the previously stored properties definition and connection.

The related template files category-list.ftl and product-list.ftl were adapted accordingly.

To ensure backward compatibility with the previous template files, an ecommerce-freemarker renderer was introduced and configured for the renderType property in the component configuration yaml files:

  • ecommerce-templating/dialogs/components/category-list.yaml

  • ecommerce-templating/dialogs/components/product-list.yaml

The ecommerce-freemarker renderer parses the definition and connection names from the connectionId property and wraps the component content with the definition and connection properties with the parsed values.

(ECOMMERCE-389, ECOMMERCE-389)

commercetools locale configuration in YAML file

A new locale parameter used for product/category names or descriptions can be set in the commercetools configuration.

See the parameter description in the tab for commercetools.

ECOMMERCE-389

See the 1.2.5 changelog for all the changes.

E-commerce module 1.2.4

Released on April 13, 2021.

This release brings full compatibility with Magnolia 6.2.7 as well as some bug and security fixes.

Notable fixes:

See the 1.2.4 changelog for all the changes.

E-commerce module 1.2.3

Released on December 1, 2020.

E-commerce module 1.2.3 is a bug-fixing release.

See the 1.2.3 changelog for all the changes.

E-commerce module 1.2.2

Released on November 30, 2020.

This release brings full compatibility with Magnolia 6.2.5 as well as some bug fixes.

See the 1.2.2 changelog for all the changes.

E-commerce module 1.2.1

Released on September 16, 2020.

This release brings full compatibility with Magnolia 6.2.3 as well as some bug fixes.

See the 1.2.1 changelog for all the changes.

E-commerce module 1.2

Released on August 20, 2020.

SAP Commerce Cloud Connector

This release delivers a new connector for SAP Commerce Cloud (formerly Hybris).

The connector includes a new User endpoint for SAP:

  • /users/{userId}/accessToken — To log in a user and obtain the user’s access token.

  • /users/{userId}/addresses — To handle stored addresses of users.

  • /users/{userId}/paymentMethods — To handle stored payment methods of users.

accessToken
@POST
@Path("/v2/users/{userId}/accessToken")

getUserAddresses
@GET
@Path("/v2/users/{userId}/addresses")

createUserAddress
@POST
@Path("/v2/users/{userId}/addresses")

deleteUserAddress
@DELETE
@Path("/v2/users/{userId}/addresses/{addressId}")

updateUserAddress
@PUT
@Path("/v2/users/{userId}/addresses/{addressId}")

getUserPaymentMethods
@GET
@Path("/v2/users/{userId}/paymentMethods")

updateUserPaymentMethod
@PUT
@Path("/v2/users/{userId}/paymentMethods/{paymentMethodId}")

deleteUserPaymentMethod
@DELETE
@Path("/v2/users/{userId}/paymentMethods/{paymentMethodId}")

See the User REST endpoint page.

Cart and Checkout endpoint updates

This release provides a V2 of two endpoints:

  • Checkout endpoint — In v2, the checkout endpoint sets the address of a cartId to ensure the correct resource is consistently identified. For example, the v1 /checkouts/address/{cartId} becomes in v2 /checkouts/carts/{cartId}/address.

    setAddress
@PUT
@Path("/checkouts/cart/{cartId}/address")

setShippingMethod
@PUT
@Path("/checkouts/cart/{cartId}/shippingmethod")

createOrder
@POST
@Path("/checkouts/cart/{cartId}/order")

getShippingMethods
@POST
@Path("/checkouts/cart/{cartId}/shippingmethods")

  • Cart endpoint — In v2, cartId is a path parameter instead of form parameter in the REST calls. For example the v1 /carts/items becomes in v2 /carts/{cartId}/items. The other parts of the call are unchanged.

    addItem
@POST
@Path("/v2/carts/{cartId}/items")

removeItem
@DELETE
@Path("/v2/carts/{cartId}/items/{itemId}")

updateItemQuantity
@POST
@Path("/v2/carts/{cartId}/items/{itemId}")

The ecommerce-rest-role has been updated to allow the v2 endpoints.

See the V2 endpoint pages.

V1 of the Cart and Checkout endpoints are deprecated from this release on. They will be removed in the next major version of the Commerce Connector Pack.

Product chooser

This release also improves the sample template provided in the Pages app. Magnolia provides a dialog to select the connection, category and product instead of requiring you to manually enter the connection name, definition name and a product ID. If you only have one connection configured, you choose the category and product directly.

List of changes:

See the 1.2.2 changelog for all the changes.

E-commerce module 1.1.1

Released on July 7, 2020.

This release introduces compatibility with Magnolia 6.2.2 and an improvement that means images are displayed instead of the URL now in the E-commerce app (see Configuring the images displayed in the E-commerce app). List of changes:

  • [ECOMMERCE-226] - Prod detail sub-app - image field displays image instead of path

  • [ECOMMERCE-295] - Use i18n keys instead of literals for labels in product detail view

  • [ECOMMERCE-254] - Manual tagging action should tag a product even if the product has a tag already

See the 1.2.1 changelog for all the changes.

E-commerce module 1.1

Released on April 6, 2020.

This release delivers a new connector for Salesforce Commerce.

See the 1.1 changelog for all the changes.

E-commerce module 1.0

Released on July 9, 2019.

Initial release of the Commerce Connector Pack for connecting to e-commerce systems such as Magento and commercetools.

See Commerce Connector Pack for an overview of the functionality provided.

Commerce Connector Pack compatibility

Module version Magnolia CMS version

1.3.3

6.2.18

1.3+

6.2.9+

1.2+

6.2.2+

1.1.1

6.2.2

1.1

6.2

1.0

6.1

A note about connector compatibilty

The third-party versions listed below are the versions Magnolia has developed and tested against. If you don’t see a particular version listed, it simply means that we do not routinely test on it. If you are using another version of the third-party tool and run into compatibility issues, please contact our Support.
Module version commercetools SDK

7.6.0

Tested against 2.0. The API of version 7.6.0 was adapted for commercetools SDK v2 following the deprecation of SDK v1.

1.0

Tested against 1.51.0
Module version Adobe Commerce (formerly Magento) API

1.0

Tested against V1
Module version Salesforce Commerce API

1.2.4

Tested against v20_10

1.0

Tested against 20.4
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the Ecommerce module docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules