Overview
OpenApp APIs are modular - a merchant only needs to implement the endpoints relevant to their use case. The table below shows which APIs each e-commerce scenario requires.
| Endpoint | Payments from your own page | In-app shopping | Catalogue & AI Basket |
|---|---|---|---|
| Checkout API | |||
| Basket retrieval | Required | - | - |
| Basket initiation | - | Required | - |
| Basket recalculate | Required | Required | - |
| Order placement | Required | Required | - |
| Basket change callback | Optional | Optional | - |
| Orders & Fulfillment API | |||
| Order status | Required | Required | - |
| Refunds | Optional | Optional | - |
| Catalogue API | |||
| Catalogue polling | - | Required | Required |
| AI Basket API | |||
| Order feed | - | - | Required |
| User recommendations | - | - | Required |
| Wishlist feed | - | - | Optional |
Scenarios
Payments from your own page - The user checks out from the merchant's own webshop or page using the OpenApp widget. No catalogue integration is needed.
In-app shopping - The user browses the merchant's products directly in the OpenApp app and builds a basket there. Requires catalogue polling and the in-app display capability enabled in the control panel.
Catalogue & AI Basket - The merchant uses OpenApp as a recommendation engine, with no payment functionality. Requires catalogue polling and the recommendations order feed; optional wishlist feed enriches personalisation further.
Restaurant POS (HoReCa) - A restaurant POS integrates with OpenApp, starting with QR-initiated bill payment (Scan & Pay) and optionally menu sync, table ordering, and pickup/delivery. This is a separate POS integration with its own API and endpoint set - see the HoReCa API introduction.