Change History

Change history is a historical log of entity changes made within your Project.

The Change history feature is currently only available on our Google Cloud Regions.

The Change history log provides you with a historical log about the creations, deletions, and updates that happened on the entities in your commercetools Project. You can view the logged data in the Change history table in the Merchant Center. The data help you to:

  • track and review changes made to a Project, for example, for security auditing.
  • determine what entities are most interacted with by customers and platform users.
  • identify usage patterns, for example, to figure out if additional training is required.

Change history table

You can access the Change history directly from the main menu navigation.

Change history main screen with menu entry

By default, the Change history table displays the latest change record at the top. This table is generated at the time the page is loaded and not refreshed automatically thereafter. Please click the Refresh icon in the upper left of the screen to update the visible data. You can configure the columns in visibility and order with the Column manager in the Table settings.

Table columns

The columns available in the Change history table are:

  • User provides information about which user made the change on the entity:

    • Merchant Center user name is displayed when change was made through the Merchant Center.
    • Platform is displayed when change was made through ImpEx.
    • ExternalUserIDstring is displayed when change was made through an API Client and the external User ID was provided for the respective API call.
    • Out of the platform is displayed when change was made through an API Client and no external User ID was provided.
  • Customer provides information about the customer making the change:

    • Customer email address is displayed when change was made through an API Client and the respective API call was made for an authenticated Customer.
    • Anonymous session is displayed when change was made through a Customer who was not authenticated, for example, when using guest checkout.
    • ----- is displayed when no information about the customer is available.
    • Customer deleted is displayed when change was made through an API Client and the respective API call was made for an authenticated Customer, but for any reason the Customer was deleted after the event got logged.
  • Last modified displays the date and timestamp of the modification along with the taken action that can be either Create, Remove or, Update.

  • Changes lists details about the entity modifications along with the changed values.

  • Current entity: shows the name of the modified entity. To show the details of the current version of the modified entity, click its name. By clicking the filter icon next to the current entity, the changes of the selected entity will be displayed exclusively.

  • Entity type indicates the type of the modified entity.

  • Source displays the name of the application or client used to drive the change:

    • Merchant Center
    • Impex
    • API Client Name – Name set during the creation of an API Client
    • API Client Not Available is displayed when using an API Client to drive changes and a valid name is not provided.
  • Version update displays the version of the entity before and after the change.

Depending upon your specific table settings, not all columns may be visible in the table view.

Modify table view

To add or remove table columns, select the Column manager from the Table settings drop down menu in the upper right corner of the screen.

Change history Column manager

You can drag and drop the columns from hidden to visible. Additionally, you can reorder the visible columns by dragging and dropping the entries. To save the table view changes, click Save settings. To return to the table view without changes, click Cancel.

Modify table layout

To modify the table layout, select Layout settings from the Table settings drop down.

Change history Display settings

You can change here the text visibility and the density of the displayed rows. To confirm the changes, click Save settings. To discard your changes, click Cancel.

Change table filtering

The Change history is the aggregation of all changes within the Project. As such, it can grow to be very large. To improve usability, we have built in two methods of filtering content: time filtering and column filtering.

  • Time filtering: By default, the Change history table filters to the past 30 days worth of resource changes. To change the time range, click the drop down in the upper right of the screen. Select one of the options:
    • Today
    • Yesterday
    • Last 7 days
    • Last 30 days
    • Custom date range

Change history time filtering

  • Column filtering: To filter individually, click the filter icon in the upper left and select in the Add filter drop down one of the available filters.

    Change history filter

    You can add and remove the following filters individually or in combination:

    • Source: Select one of the supported sources
      • Merchant Center
      • Platform
      • Out of platform (API Client).
    • Entity type: Select one (is) or more (in) of the supported entity types.
    • Type of changes: Select the type of entity change
      • Update
      • Create
      • Remove.
    • Changes: Select an entity first, in the second step select the related change or action you want to filter on:
    • User: Select the name of the user you want to filter on.
    • API Client: Select the API Client you want to filter on.

To remove all filters, click Clear all.

Contextual views

The Merchant Center will provide contextual Change history views for the entities. To access the contextual Change history view for an entity, click Open change history on the respective entity's detail page. Change History Contextual View

The contextual view will provide a Change history table specific to the entity. Change history contextual table

Merchant Center permissions

All members of the Administrators Team have access to the Change history in the Merchant Center by default. For any other team ensure you have enabled the View all: Audit Log permission for the respective Project and the team.

Change history permission

API Client permissions

To gain access to the Audit Log APIs, your API Client needs to be configured with the View scope for Audit Log. You cannot add a scope to an existing API Client. Create a new API Client that includes the Audit Log view scope.

Change history API Client