Build an Integration

You can build an integration between Merchstack and virtually any system that has a catalog of products and categories. This guide walks you through the steps to create a custom file-transfer integration between your system and Merchstack.

Overview

This guide is focused on creating a backend integration between Merchstack and other systems within your commerce stack. This can be complemented by integrating Merchstack directly with your storefront in a headless architecture. We will cover that approach in a separate guide.

Step 1: Planning Your Integration
Step 2: Preparing Your Data
Step 3: Send Your Data
Step 4: Start Using Merchstack
Step 5: Publish Your Data

Step 1: Planning Your Integration

You'll start by working with your Solution Architect and Customer Success manager to define the scope and requirements for your integration. Much of this involves running through the detail outlined in this doc, but we will also cover other items relating to import cadence, error handling, publish cadence and mechanism (triggered vs automated), and more. We will use our early discovery sessions to identify any custom datasets or metafields we need to ingest or generate for publish.

Step 2: Preparing Your Data

The data you are required to send Merchstack can vary depending on your use case. At a minimum, Merchstack requires categories and products to create your catalog in our platform and allow you to start using the platform.

Step 3: Send Your Data

Our recommended approach for a custom data integration with Merchstack is via file transfer. We will provide you with the address to an S3 bucket where files can be dropped on an agreed cadence. The files must conform to our expected file format in order for the data to be imported into Merchstack. The format includes additional metadata that will allow our collective teams to track the status of any import. To make sure your file will be accepted by Merchstack you should use the JSON schemas provided to validate your files. There may still be import errors that need to be addressed.

Schemas

• Category Schema
• Product Schema
• Inventory Schema
• Pricing Schema

Testing and Validation

You will be able to work directly with the Merchstack team to test and validate all data feeds and formats as part of your onboarding process. We will ensure your data is correctly formatted and properly transferred, and that any post-transfer actions are successfully executed.

Step 4: Start using Merchstack

Once your data is in Merchstack, your teams can start using Merchstack's features, including our calculated categories and opportunities engine. As actions are taken, Merchstack will be generating data that you will want to get back into your source system.

Step 5: Publish Your Data

As changes are made within Merchstack, these will be included in the publish queue. On an agreed cadence, or triggered by your end users, Merchstack will export a file and land it on the S3 bucket. The file format will look exactly like the import file format. You will be responsible for converting this format into the data you system requires, or you can engage with our Solutions Engineers to help you achieve specific outcomes for your needs.

Testing and Validation

You will once again work together with your Solution Architect and CSM to validate the data is flowing correctly end-to-end and you have what you need to power specific customer-facing experiences in your connected platform.