API Documantation
The Lidia API is a comprehensive, open API designed to provide seamless integration with the Lidia Commerce Engine. It offers an extensive set of endpoints for managing products, customers, orders, payments, and other e-commerce operations. The API follows RESTful principles and supports JSON format for request and response payloads.
Key Features
- Microservice Architecture: Leverages 18 microservices for modular and scalable integration.
- Headless Commerce Support: Provides back-end commerce capabilities while allowing custom front-end experiences.
- Integration Ready: Supports integration with third-party systems such as ERP, CRM, logistics providers, and payment gateways.
- Comprehensive Documentation: All API endpoints are fully documented with example requests and responses for quick implementation.
This section provides a high-level overview of the Lidia API, focusing on core services for developers. For detailed technical documentation, please refer to our external; API documentation link.
Services | Descriptions | Page Links |
|---|---|---|
Identity | Manages roles, users, authentication and consents | Lidia Identity |
Metadata | Manages product, category, trademark and list data. This is the PIM (Product Information Management) of the Lidia Platform. | Lidia Metadata |
Inventory | Manages store, warehouse and inventory data. Inventory concept includes SKU's, price and stock. | Lidia Inventory |
Content | Manages storefronts(showcases), menus and dynamic pages, acts as a headless CMS for your application. | Lidia Content |
Order | Manages cart, orders, deliveries and claims (cancellation, return). | Lidia Order |
Marketing | Manages promotions and coupons with a smart condition-award engine. | Lidia Marketing |
Organization | Manages organizations, branches, contacts for your application. | Lidia Organization |
Subscription | Manages subscription-based services, including renewals, cancellations, and customer access. | Lidia Subscription |
Collector | Gathers and consolidates data from multiple sources, enabling comprehensive analytics and reporting. | Lidia Collector |
Notifications | Manages the creation and delivery of notifications to users, ensuring timely updates for various events. | Lidia Notification |
Delivery | Handles the logistics of order delivery, integrating with shipping providers and managing tracking information. | Lidia Delivery |
Case | Manages customer service cases, providing tools for tracking, resolving, and reporting issues. | Lidia Case |
Social | Integrates social media platforms and enables social commerce functionalities within the application. | Lidia Social |
Document | Manages document storage and retrieval, facilitating the handling of contracts, invoices, and other critical files. | Lidia Document |
Commander | Provides tools for administrators to control and configure system-wide settings and operations. | Lidia Commander |
Analytics | Collects and analyzes data across your digital commerce platform, providing insights into performance, customer behavior, and sales trends. | Lidia Analytics |
Procurement | Manages supplier relationships, purchase orders, and procurement workflows to streamline the sourcing of products and services. | Lidia Procurement |
Search | Powers the search functionality, enabling users to efficiently find products, categories, and content within the application. | Lidia Search |
Updated about 1 month ago