Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mzanoni authored Jun 12, 2024
1 parent 91a17ef commit 540a2f7
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,29 @@ The Relewise commercetools connect integration provides a default way of synchro
The commercetools connect integration serves as a robust bridge between the commercetools platform and Relewise, facilitating seamless synchronization of product data. This integration streamlines the process of managing products across both platforms, ensuring consistency and accuracy in product information while minimizing manual efforts.
The integration automates the synchronization process, ensuring that product data is regularly updated and consistent across both commercetools and Relewise platforms. This eliminates the need for manual data entry and reduces the risk of errors.


## Deployment configuration

Here you can see the details about various variables in configuration. You need access to a Relewise Dataset in order to be able to setup the integration.

### Default connect configration
### Default connect configuration
- CTP_PROJECT_KEY: The key of commercetools project.
- CTP_CLIENT_ID: The client ID of your commercetools user account. It is used in commercetools client to communicate with commercetools platform via SDK.
- CTP_CLIENT_SECRET: The client secret of commercetools user account. It is used in commercetools client to communicate with commercetools platform via SDK.
- CTP_SCOPE: The scope constrains the endpoints to which the commercetools client has access, as well as the read/write access right to an endpoint.
- CTP_REGION: As the commercetools APIs are provided in six different region, it defines the region which your commercetools user account belongs to.

### Relewise integration specific configration
- RELEWISE_STORE_KEY: The Key for the store to which from the export is going to be performed on.
- RELEWISE_STORE_KEY: The Key for the store to which from the export is going to be performed on. You can find this in the mercandising center for commercetools
- RELEWISE_DATASET_ID: The DatasetId in Relewise.
- RELEWISE_API_KEY: ApiKey with access to perform Product Updates & administrative actions.
- RELEWISE_SERVER_URL: The Server URL your dataset is hosted on.

The DatasetId, ApiKey and ServerUrl can be found via https://my.relewise.com - which you need access to, in order to be able to view the products imported into Relewise.

### Store with many active products
If your store contains more than 10,000 active products, then make sure to verify / test that the import can run within the allowed scheduled timeouts by commercetools.

## Support & contact

If you run into any issues with the integration, please feel free to reach out. There are multiple ways of reaching us. Check out [here](https://docs.relewise.com/docs/developer/support.html) for more information.
Expand Down

0 comments on commit 540a2f7

Please sign in to comment.