Overview
ECRS® offers 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 and/or Cognition databases. These REST API solutions are:
- CATAPULT® Passport API
- CATAPULT Cognition™ API
- CATAPULT WebCart™ API
- Digital Coupon and External Loyalty API Client
- Loyalty Redemption API
- Receipt Survey API
- Third Party Label API Client
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.
CATAPULT Cognition™ API
The CATAPULT Cognition API is a secure, RESTful interface that enables access to transactional data used across CATAPULT system applications, as well as AI-generated predictive data. Use of the API requires an ECRS–issued API key.
Predictive Endpoints
Access to data generated by Cognition’s AI services is available via multiple endpoints including:
- Product recommendations (e.g., similar or related items)
- Cognition Artemis™ personalized recommendations (e.g., customer-specific coupons or item suggestions)
- DemandFill™ 3.0 item demand forecasts
Transaction History Endpoint
Transactional data generated by CATAPULT is available through the Transaction History Endpoint.
CATAPULT WebCart™ API
The WebCart API supports the CATAPULT WebCart™ user interface, providing a robust and flexible framework for integrating and managing various e-commerce functionalities. This API also enables the creation of custom e-commerce solutions through various endpoints which control essential functions such as signing in/out, adding items to a cart, and accepting payment. An active WebCart license is required for this API to function properly.
This documentation is currently under development. Request documentation for undocumented endpoints by contacting the Web Transactions team at ECRS.
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.
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.
Receipt Survey API
The Receipt Survey API is a RESTful API that empowers CATAPULT merchants to enhance their shopper’s receipts with images – such as barcodes, QR codes, or promotional graphics – generated by a third-party web service when specific transaction criteria are met.
Third Party Label API Client
The Third Party Label API Client allows for third party labeling services to automatically receive new and updated inventory item data from the CATAPULT Database. This flow of data ensures that labeling services have the most up-to-date item information for use on physical or electronic labels. Note that this is truly an API Client; any third party that chooses to use it must create a server that can receive and process the information.