Introduction

Tipser provides a REST API that is aimed towards the cases where standard combination of Storefront Components and Tipser Portal functionalities are not sufficient and there's the need for a more advanced integration. This breakdown explains different APIs Tipser provides and their primary use-case.

Environments

Each API URL is always constructed as a combination of base URL for environment and endpoint path. We provide a test environment - api.stage.tipser.com which is great get familiar with the mechanics of the API and try out things; our production environment - api.tipser.com - let you perform real transactions on real products.

API Components

The easiest way to look at Tipser REST APIs is to understand their primary use case:

Storefront API

Storefront API is a set of APIs that lets you control your curated inventory (via Storefront API and Collections API resources), fetch it with the detailed product data via Products API and finally enable your users transact via Shopping Carts API. The ideal use case for this APIs is to build amazing and unique shopping experiences on top of Tipser's rich inventory, when the set of standard Components and Elements is not enough.

Transactions API

Transactions API is an API that lets you perform advanced interactions on our checkout, payment, order and fulfilment systems to build a fully owned experience of the checkout for your customers going well beyond the standard Tipser Checkout Element behaviour.

❗️

Checkout Completion

It is not possible to complete the checkout using only API's at this present time. The final checkout page must be completed either using Tipserscript or Elements.

Reports API

Reports API is a set of APIs that gives you an insight into the sales, commissions and order statuses that are useful for your finance, reporting and reconciliation needs.

Export API

Export API is a server-to-server API enabling your system to synchronise Tipser's inventory on a regular and live basis when building your own customized Storefront, as well as exporting your curated inventory under formats compatible with standard third party shopping surfaces such as Google Shopping.

Tipser Analytics API

Analytics API is a single-endpoint API that allows you to send and track user events as part of an API integration. These user events both allow full-funnel analytics and trigger data refreshes for maximum product-data freshness.