Skip to content

commercetools-java-sync-logos 002

commercetools sync

CI codecov Benchmarks 5.1.1 Download from JCenter Download from Maven Central Javadoc Known Vulnerabilities

Java library that imports commercetools platform data in the following ways:

  1. Synchronise data coming from an external system in any form (CSV, XML, etc..) that has been already mapped to commercetools-jvm-sdk resource draft objects (e.g. CategoryDraft).

  2. Synchronise data from another commercetools project as commercetools-jvm-sdk resource draft objects (e.g. CategoryDraft).

Synchronise: Resources will either be created or updated. But they will not be deleted.

⚡ See the Quick Start Guide for more information on building a product importer!

🔛 Check out the commercetools-project-sync for a ready-to-use CLI application that syncs your entire data catalogue between 2 commercetools projects!

The library supports synchronising the following entities in commercetools

commercetools-java-sync-final 001

Prerequisites

  • Make sure you have JDK 8 installed.
  • commercetools-jvm-sdk as a dependency in your JVM-based application. (Make sure to use a version >= 1.60.0).
  • a target commercetools project for syncing your source data to.

Installation

There are multiple ways to add the commercetools sync dependency to your project, based on your dependency manager. Here are the most popular ones:

Maven

<dependency>
  <groupId>com.commercetools</groupId>
  <artifactId>commercetools-sync-java</artifactId>
  <version>5.1.1</version>
</dependency>

Gradle

implementation 'com.commercetools:commercetools-sync-java:5.1.1'

SBT

libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "5.1.1"

Ivy

<dependency org="com.commercetools" name="commercetools-sync-java" rev="5.1.1"/>