Search Results

All Results 6985
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Authentication
Official Documentation
Authentication An access token is necessary for making API calls to Liferay Analytics Cloud. Navigate to Settings → APIs to generate an access token. Choose the duration (e.g. 30 days, 6 months, 1...
Headless APIs
Official Documentation
Headless APIs
Querying Data
Official Documentation
Querying Data The root endpoint of Liferay Analytics Cloud is . You can get the list of all data types endpoints by requesting a GET to the above URL. Try with curl curl -i -L -H "Authorization:...
Warehouse API Basics
Official Documentation
Warehouse API Basics You can manage warehouses from the Applications menu or REST APIs. Call the headless-commerce-admin-inventory services to create and manage warehouses. Adding a Warehouse ...
Resource Types and Structure
Official Documentation
Resource Types and Structure Properties activeIndividualsCount (Number): Number of active individuals belonging to the account. dateCreated (Date): Date the account was created in the system. ...
Commerce APIs
Official Documentation
Commerce APIs You can use headless APIs to interface with Liferay Commerce features, including products, catalogs, and price lists. Here are resources to help you understand and integrate these...
Exporting Data
Official Documentation
Exporting Data Various analytics data can be accessed through the sites dashboard and the individuals dashboard. Analytics data can also be fetched and exported using Analytics Cloud's APIs....
Inventory Management APIs
Official Documentation
Inventory Management APIs Here is a comprehensive resource for understanding and leveraging Liferay’s inventory management APIs.
Order Management APIs
Official Documentation
Order Management APIs Here is a comprehensive resource for understanding and leveraging Liferay’s order management APIs.
Order API Basics
Official Documentation
Order API Basics You can manage orders from the Applications menu or with REST APIs. Call the headless-admin-commerce-order services to create and manage orders. Adding an Order Once Liferay is...
Order Type API Basics
Official Documentation
Order Type API Basics You can manage order types from the Applications menu or with REST APIs. Use the /order-types endpoint from headless-admin-commerce-order to create and manage order types. ...
Catalog API Basics
Official Documentation
Catalog API Basics You can manage catalogs from the Applications menu or REST APIs. Call the headless-commerce-admin-catalog services to create and manage catalogs. Adding a Catalog Once Liferay...
Pricing APIs
Official Documentation
Pricing APIs Use the Price List and Discount APIs to manage product pricing and discounts in Liferay Commerce programmatically. Below are basic usage examples, including common endpoints and...
Discount API Basics
Official Documentation
Discount API Basics You can manage discounts from the Applications menu or with REST APIs. Call the headless-admin-commerce-pricing services to create and manage discounts. Adding a Discount Once...
Product Management APIs
Official Documentation
Product Management APIs You can invoke the services under headless-commerce-admin-catalog to perform various admin operations related to products. However, if you have a headless storefront, you...
Price List API Basics
Official Documentation
Price List API Basics You can manage price lists from the Applications menu or with REST APIs. Call the headless-admin-commerce-pricing services to create and manage price lists. Adding a Price...
Term API Basics
Official Documentation
Term API Basics You can manage terms and conditions from the Applications menu or with REST APIs. Use the /terms endpoint from headless-admin-commerce-order to create and manage terms and...
Currency API Basics
Official Documentation
Currency API Basics Liferay DXP 2024.Q1+/Portal GA112+ You can manage currencies from the Applications menu or with REST APIs. Call the headless-commerce-admin-catalog services to create and...
Option API Basics
Official Documentation
Option API Basics You can manage option templates from the Applications menu or with REST APIs. Call the headless-commerce-admin-catalog services to create and manage options. Adding an Option ...
Product API Basics
Official Documentation
Product API Basics You can manage products from the Applications menu, but you can also use Liferay’s REST APIs. Call these services to create and manage products. Adding a Product Then follow...
Option Value API Basics
Official Documentation
Option Value API Basics You can manage option values from the Options application or with REST APIs. Call the headless-commerce-admin-catalog services to create and manage option values. Adding an...
Store Management Basics
Official Documentation
Store Management Basics Here is a comprehensive resource for understanding and leveraging Liferay’s Channel API basics.
Product API - Creating a Product with Multiple SKUs
Official Documentation
Product API - Creating a Product with Multiple SKUs You can create products with multiple active SKUs using the product API or from the Products application. To create such a product, you must...
Product Delivery API Basics
Official Documentation
Product Delivery API Basics Product API Basics covers the admin API used for creating and managing products. To display product data in your storefront, you must use the Product Delivery API. Call...
Channel API Basics
Official Documentation
Channel API Basics You can manage channels from the Applications menu or with REST APIs. Call the headless-commerce-admin-channel services to create and manage channels. Adding a Channel Once...
Specification API Basics
Official Documentation
Specification API Basics You can manage product specifications from the Applications menu or with REST APIs. Call the headless-commerce-admin-catalog services to create and manage specifications. ...
Blog API Basics
Official Documentation
Blog API Basics Liferay's REST APIs provide services for adding, modifying, and deleting blog posts and images. Liferay DXP 2024.Q4+/Portal GA129+ The Blogs API now uses External Reference Codes...
Content Management APIs
Content Management APIs You can use headless APIs to interface with most types of content in Liferay, including web content, message boards, and knowledge base articles. Here are resources to help...
Categories and Vocabulary API Basics
Official Documentation
Categories and Vocabulary API Basics Liferay's REST APIs provide services for Liferay's categories and vocabularies functionality. You can create and edit vocabularies with the API. You can also...
Knowledge Base API Basics
Official Documentation
Knowledge Base API Basics You can Create Knowledge Base Articles and Manage the Knowledge Base with Liferay's Knowledge Base app, but you can also use Liferay's REST APIs. Call these services to...
Advanced Web Content API
Official Documentation
Advanced Web Content API Using the Liferay DXP REST services, you can create and manage your site's structured content. Structured content is web content that uses a web content structure (or...
Managing Web Content Structures and Templates by Using the REST API
Official Documentation
Managing Web Content Structures and Templates by Using the REST API Web content structures define the information included in a web content article. Structures facilitate creating and managing web...
Message Boards API Basics
Official Documentation
Message Boards API Basics Liferay's Headless Delivery application provides REST services for the Message Boards application. With these services, you can add message board categories, threads, and...
Web Content API
Official Documentation
Web Content API Here is a comprehensive resource for understanding and leveraging Liferay’s Web Content APIs. It supports the integration and management of web content within applications,...
Tags API Basics
Official Documentation
Tags API Basics Liferay's REST APIs provide services for managing tags (referred to as keywords in Liferay's codebase). You can create, edit, and delete tags using the API. Start with an example of...
Web Content API Basics
Official Documentation
Web Content API Basics Using Liferay DXP REST services, you can create and manage structured content on your site. Structured content refers to web content articles that use a web content structure...
Web Content API Basics Using GraphQL
Official Documentation
Web Content API Basics Using GraphQL Use Liferay DXP GraphQL services to manage web content by creating, retrieving, updating, and deleting structured content on your site. Structured content...
Digital Asset Management APIs
Digital Asset Management APIs You can use headless APIs to interface with Liferay's documents and media. Here are resources to help you understand and integrate these APIs.
Wiki API Basics
Official Documentation
Wiki API Basics Liferay's Headless Delivery application provides REST services for the Wiki application. With these services, you can add Wiki nodes and pages, list their information, modify their...
Captcha API Basics
Official Documentation
Captcha API Basics Liferay provides a headless API to retrieve and submit captchas using the SimpleCAPTCHA engine. Using the /captcha endpoint from the API Explorer, you can add captchas in your...
SCIM Resource Type, Service Provider, and Schema Basics
Official Documentation
SCIM Resource Type, Service Provider, and Schema Basics Liferay DXP 2025.Q2+ Liferay provides a headless API to query the SCIM resource types, service providers, and schemas available. Use the...
Document API Basics
Official Documentation
Document API Basics Liferay's headless delivery application provides REST services for Documents and Media that add documents and folders, list their information, modify them, delete them, and...
Document Shortcut API Basics
Official Documentation
Document Shortcut API Basics Liferay's headless delivery application provides REST services for Documents and Media that add document shortcuts to sites or asset libraries, list their information,...
Liferay Security APIs
Liferay Security APIs You can use headless APIs to interface with important Liferay security features, including CAPTCHA configurations and SCIM. Here are resources to help you understand and...
SCIM Group API Basics
Official Documentation
SCIM Group API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM groups to keep their information in sync with your company's...
Object APIs
Object APIs You can use headless APIs to interface with objects and picklists. Here are resources to help you understand and integrate these APIs to enhance your ability to manage objects.
Document Types and Metadata Sets API Basics
Official Documentation
Document Types and Metadata Sets API Basics Liferay DXP 2025.Q1+/Portal GA132+ Liferay's headless delivery application provides REST services for Documents and Media that add document types and...
SCIM User API Basics
Official Documentation
SCIM User API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM users to keep their identity information in sync with your company's...
Custom Object APIs
Official Documentation
Custom Object APIs Liferay 7.4+ When you publish a custom object definition, Liferay generates default REST APIs for interacting with the object and its data. These APIs vary depending on the...
Object API Basics
Official Documentation
Object API Basics When you publish an Object, Liferay automatically generates REST APIs for it. These APIs differ for Company and Site scoped Objects, but they all use the c/[pluralobjectlabel]...
Managing Object Entries Using GraphQL
Official Documentation
Managing Object Entries Using GraphQL You can use GraphQL to manage custom object entries in Liferay efficiently. This API framework simplifies data interaction and serves as an alternative to REST...
Using Aggregation Terms with REST APIs
Official Documentation
Using Aggregation Terms with REST APIs When querying Object entries using REST APIs, you can use an Object's fields as facet criteria for aggregating entry data. To do this, add the...
Using nestedFields to Query Related Entries
Official Documentation
Using nestedFields to Query Related Entries Liferay 7.4 U69+/GA69+ The nestedFields parameter returns multiple levels of related object entries in a single GET request. Pass the nestedFields...
Using nestedFields to Audit Entry History
Official Documentation
Using nestedFields to Audit Entry History Liferay 7.4 U72+/GA72+ When you enable entry history for an object definition, you can use the nestedFields parameter with REST APIs to audit entry...
Picklists API Basics
Official Documentation
Picklists API Basics Liferay provides the headless-admin-list-types REST APIs for creating and managing picklist definitions (ListTypeDefinition) and their entries (ListTypeEntry). You can view and...
Using Object APIs With Base64 Encoded Files
Official Documentation
Using Object APIs With Base64 Encoded Files Liferay DXP 2024.Q2+/Portal GA120+ When creating object entries with attachment fields through APIs, you can generally upload files from your computer...
Using Relationship REST APIs
Official Documentation
Using Relationship REST APIs Liferay 7.4 U70+/GA70+ When you add relationships to custom or system objects, Liferay generates REST endpoints for accessing those relationships. You can relate and...
Using Batch APIs
Official Documentation
Using Batch APIs When you publish an Object, Liferay automatically generates REST APIs for it. These include the batch APIs for bulk POST, PUT, and DELETE operations. Here you'll use cURL commands...
Process Automation APIs
Process Automation APIs You can use headless APIs to interface with automation features in Liferay DXP, including workflows. Here are resources to help you understand and integrate these APIs to...
Notifications API Basics
Official Documentation
Notifications API Basics Liferay's headless delivery application provides REST and GraphQL services for subscribing to or unsubscribing from notifications for platform events across several default...