Overview
ECRS® offers three Representational State Transfer (REST) Application Programming Interface (API) solutions that allow ECRS merchants and/or their chosen third parties to interface with data within the CATAPULT database. These REST API solutions are:
- CATAPULT® Passport API
- Third-Party Loyalty Redemption API
- Digital Coupon and External Loyalty API Client
- CATAPULT Cognition™ API
More details on each API, and access to the documentation for each, can be found in the corresponding sections below.
CATAPULT® Passport API
The CATAPULT Passport API is a RESTful API that provides a number of endpoints to bidirectionally move data (import and export) between the CATAPULT® database and third-party retail systems. Examples of endpoints in the Passport API include managing Purchase Orders from start to finish, getting information about items within the CATAPULT database, and updating the details of customer records within the CATAPULT database.
Loyalty Redemption API
The Loyalty Redemption API is a RESTful API that provides the capability to check and decrease the loyalty balances for customers within the CATAPULT database.
Digital Coupon and External Loyalty API Client
The Digital Coupon and External Loyalty API Client is a RESTful API Client that can be leveraged to allow CATAPULT Point of Sale (POS) terminals and CATAPULT WebCart™ sites to interact with external digital coupon and loyalty providers. Note that this truly is an API Client, and any third party who intends to use it must create a server for the POS Terminals and/or WebCart sites to submit requests to.
CATAPULT Cognition™ API
The CATAPULT Cognition API is a RESTful API designed to provide access to predictive endpoints utilized by CATAPULT system applications. These endpoints are restricted to ECRS applications, but their definitions are available for third parties to replicate and use to provide recommendations into ECRS applications. Examples of endpoints detailed in the Cognition API documentation include recommendations (such as similar items, related items, customer specific coupons/items, etc.) and DemandFill™ 3.0 predictions. Please note that while we strive to maintain backward compatibility, changes to the API may occur.