Export and import processes can be scheduled and automated to run at preferred times. The data generated can then be automatically transmitted to third party systems. There are two ways to get data from and push data to the Maropost Commerce platform:
In this Article
API
The Maropost Commerce application programmer interface (API) enables third party software to interact with the Maropost Commerce Digital Commerce Platform. Currently all transactions are performed via HTTPS POST.
You can Add, Update and Get data using the API.
We are intent on continually updating and improving the API in it’s current release. There are functions not available through the API and until such time as we have made all functions available the API will remain in development.
1. Get Set up
2. Explore
- Explore the API calls we have available here.
- Use a client such as POSTMAN to test API calls against your account
3. Build
- Build your integration
- Checkout our recommended workflows for different app types
- Ask us if you get stuck, require additional fields, calls or advice
FTP (File Drop / Pickup)
Maropost Commerce can pickup data from and put data files into any FTP location. The following data can be imported / exported this way.
- Sales orders and orderlines
- Shipping tracking information
- Customers
- Products / inventory
Export Data
Maropost Commerce has the ability to create export files in any flat file format including .xml, .csv, .txt etc. These files can be built on the fly using the export file builder which supports our tag and function library. All available database fields can be used in export files. Once created, an export file template can be used for future file creation.
Import Data
Maropost Commerce has the ability to map to practically any flat file format including .xml, .csv, .txt etc. Once mapped a mapping template can be created and used for future import of files in the same format.
Importing and exporting data can happen at a pre-defined schedule or processes can be run manually. For example, you could have the import system set to pickup an order file every 15 minutes from a set FTP location and then move the file to an archive folder once processed.
Example work flow 1 - Add / Update Products
Set up an import template to import a product file.
- The product file would contain information such as SKU, name, description, price and image URL.
- The import template would be setup to “add new / update existing” products.
- Setup a schedule to poll an FTP location periodically to pickup and process the product file data.
- Once created, set the system to archive the product file in an archive folder.
Example work flow 2 - Adding Orders and Exporting Tracking Information
- The order file would contain order details such as order ID, address information and order line data.
- The import template would be setup to “add new” orders and “ignore” duplicates.
- Once processed, set the system to archive the product file in an archive folder.
- Once created, orders would be processed and dispatched using the Maropost Commerce platform.
Example work flow 3 - Setup an export template to export order dispatch notifications
- The dispatch notifications file would contain tracking numbers related to dispatched orders.
- Setup a schedule to put the dispatch notification file at an FTP location periodically.
- A 3rd party system would then access this location to get the dispatch notification files to update its own systems.
- Unique identifiers such as Order ID and product SKU would be used relate data between the two systems.
Template FTP Location
It's often easiest to create import and export templates using the complex wizard, and saving the settings at the end. If you need to add FTP details to the template afterwards:
-
In your Maropost Commerce control panel navigate to Settings & tools > All Settings & Tools.
-
On the Settings & Tools page, locate and select Data Import Template, or Data Export Template.
-
Select the template you would like to change.
-
Scroll down and click on the Import Method & Schedule or Export Method & Schedule tab.
-
Select FTP from the drop down menu.
-
In the field next to File Location enter the FTP address of the file. The address needs to be the full path to the location of the file, including the server, folders, and filename with extensions.
e.g. ftp.myftpserver.com.au/productfiles/myproductfile.csv
-
If the FTP account requires a username / password to access, enter the Login Username and Login Password.
-
Next to schedule select when you would like to import or export to occur. You can choose one of the preset schedules or click on View All Schedules to create a new schedule.
-
Enter a number next to Priority to set the priority of the task. The lower the number, the higher the priority.
Tip: You can also set a Move To address to put the file somewhere once imported It’s a handy way to keep a copy of data yo’re importing, especially if the original file gets overwritten.
e.g. ftp.mywebsite.com.au/assets/backups/
-
Click the Save button to confirm your changes.
Related Articles