Search Results

All Results 6974
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
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. ...
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...
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...
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...
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...
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 ...
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...
Wiki API Basics
Official Documentation
Wiki API Basics Wiki is deprecated as of Liferay DXP 2024.Q4/Portal GA129. For data continuity, consider transitioning to alternative content management solutions like Liferay Objects or Web...
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.
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,...
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...
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...
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...
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...
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...
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...
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...
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 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.
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...
Managing Object Entry Versions
Official Documentation
Managing Object Entry Versions Liferay DXP 2025.Q4+/Portal 2026.Q1+ Object entry versioning is used in Liferay's Content Management System (CMS). To use versioning with a custom object's entries,...
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 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...
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...
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 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...
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...
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...
Search APIs
Official Documentation
Search APIs Generally Available in Liferay DXP 2025.Q4+/Portal 2026.Q1+ You can search with headless APIs using the endpoints at /o/search. These are the primary endpoints: Use the GET /search...
Search API Basics
Official Documentation
Search API Basics Generally Available in Liferay DXP 2025.Q4+/Portal 2026.Q1+ You can search for content from a Liferay search page, but you can also use the /search API endpoints. If you're...
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...
Workflow Definition Link API Basics
Official Documentation
Workflow Definition Link API Basics Liferay DXP 2025.Q1+/Portal GA132+ You can manage workflow definition links from the Liferay UI or using Liferay's REST APIs. In Liferay, the Control Panel →...
Search Suggestions API
Official Documentation
Search Suggestions API DXP 7.4 U36+/Portal GA36+ You can return suggestions using the /suggestions headless API. This API is used by Liferay's Search Bar Suggestions feature. There are two primary...
Site APIs
Official Documentation
Site APIs Use Liferay’s REST APIs to manage site elements programmatically. This guide introduces the Navigation Menu API and shows how to create, retrieve, update, and delete navigation menus...
Navigation Menu API Basics
Official Documentation
Navigation Menu API Basics Liferay's REST APIs provide services for Liferay's navigation menus. You can create and edit navigation menus with the API. Start by seeing an example of adding a new...
Form Reports
Official Documentation
Form Reports 7.3, 7.4 Once users begin submitting form entries, you can access a field-by-field report on the form's records: Navigate to the Forms application. In the Product Menu (Product...
Managing Form Entries
Official Documentation
Managing Form Entries Once users begin submitting form entries, you can access the form entry data through the UI or export the data to a different file format for further analysis and review. ...