Skip to main content

Prerequisites

Before we start

This Integration Guide is intended to be read like a step-by-step guide spread over several pages. If you are integrating with topi for the first time, we highly recommend reading it sequentially.

Welcome to the topi seller's integration guide!

You can integrate with topi even if you do not have an ecommerce store, although we do see that ecommerce stores provide the best experience (and therefore has the highest conversion rates) among various sales channels.

As long as you have a commerce backend provided by something like an Enterprise Resource Planning (ERP) system, you can still use the topi Seller API to integrate with us.

If you have an ecommerce store

Below are the prerequisites for integrating your ecommerce store with topi.

1. A product catalog

The catalog contains all of the products that you sell on your ecommerce site. This is typically data that can be exported into CSV or JSON from your ecommerce backend, which you can then run a script against to send as HTTP POST requests to topi for upload.

Your catalog's contents are expected to change over time – e.g. when your prices on products are updated seasonally – and you'd need to sync the updated contents periodically to topi.

For details on syncing your catalog, refer to the Syncing your Catalog section of the Integration Guide.

2. A server for webhooks

You will need access to your server to expose an endpoint for topi to send webhooks to, so that your system receives real-time updates of new orders and status updates. Your server is also expected to respond to these HTTP requests with a 2XX response as a way to acknowledge receipt.

For details on setting up webhooks, refer to the Setting up Webhooks section of the Integration Guide.

If you don't have an ecommerce store

Under Construction

This is still in the works. If you need immediate support, please reach out to your topi point of contact.

topi has cutting-edge tools for sellers that operate mostly with telesales and point of sales sales channels instead of ecommerce.

If you are interested in using topi for telesales or point of sales, please reach out to your topi point of contact.