Getting Your Data in to Merchstack

Our recommended approach for transferring large amounts of data as part of a custom integration with Merchstack is via file transfer. This can be coupled with our GraphQL Management APIs to enhance certain operations.

Sending Your Data

The file format works using a batch-processing type approach. 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 (see below) 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.

File Format

Merchstack uses the JSONL file format where each line in the file is a JSON record. Each file should have a maximum of 1000 records per file and imports should be broken up over multiple files. Each file should be named using the data type and import ID (covered below) and a number such as product_import90100_1.jsonl. Files that don't follow this format will be ignored.

Import Metadata

Each record of every file for every data-type should have an entry of meta-data that looks like this:

"importMetaData": {
    "formatVersion": "1.0",
    "importId": "123xyz",
    "recordNum": 55,
    "recordOf": 300,
    "recordType": "category"
  },

Data Types