Exploring the Power of HCL Commerce Version 9.1.6 Administrative REST API: Swagger Interface

Introduction:

The HCL Commerce administrative API enables you to perform various administrative tasks in managing your website. Additionally, this API comprises a collection of resources designed for tasks such as creating, retrieving, updating, and deleting data related to site globalization capabilities, organizations, and other administrative aspects.

Catalog Administrative REST API:

The provided APIs offer the capability to create and manage the attribute dictionary and attribute dictionary attributes for your stores. Furthermore, you can use these APIs to create and administer the attribute dictionary and attribute dictionary attributes for your stores.

Attribute dictionary attributes: Tasks associated with the creation and management of attribute dictionary attributes. Swagger UI (hcltechsw.com)

Attribute dictionary: Tasks related to the establishment and administration of an attribute dictionary. Swagger UI (hcltechsw.com)

Catalog Entries: Operations for creating and managing catalog entries. Swagger UI (hcltechsw.com)

Catalog Entry Calculation Codes: Tasks involving the creation and management of catalog entry calculation codes. Swagger UI (hcltechsw.com)

Catalog Group Calculation Codes: Operations for creating and managing catalog group calculation codes. Swagger UI (hcltechsw.com)

Catalog Groups: Tasks related to the creation and management of catalog groups. Swagger UI (hcltechsw.com)

Catalogs: Operations for creating and managing catalogs. Swagger UI (hcltechsw.com)

Commerce Composer Administrative REST API:

These APIs serve the purpose of creating and managing store pages for utilization with the Commerce Composer tool. Additionally, the Commerce Composer administrative REST API enables users to create and manage store pages specifically designed for utilization with the Commerce Composer tool.

Store pages involve actions for creating and managing these pages. Swagger UI (hcltechsw.com)

Page types encompass tasks related to creating and managing store page types. Swagger UI (hcltechsw.com)

Layouts deal with the creation and management of layouts. Swagger UI (hcltechsw.com)

Widgets pertain to the creation and management of a collection of all widgets. Swagger UI (hcltechsw.com)

Widgets definition descriptions involve actions for creating and managing Commerce Composer widget definition descriptions. Swagger UI (hcltechsw.com)

Content Administrative REST API:

These APIs enable the creation and administration of content for your site, encompassing items like images and documents utilized in catalogs and marketing.

Attachments involve tasks related to creating and managing attachments. Swagger UI (hcltechsw.com)

File upload jobs encompass actions for creating and managing file upload jobs. Swagger UI (hcltechsw.com)

File export jobs pertain to actions for creating and managing file export jobs. Swagger UI (hcltechsw.com)

Contract Administrative REST API:

These APIs facilitate the creation and management of contracts and contract-related elements, including the administration of contract trading agreements and account-contract relationships.

Accounts contracts refer to activities involving the creation and management of accounts and contract relationships. Swagger UI (hcltechsw.com)

Contracts involve the creation and administration of a collection of contracts. Swagger UI (hcltechsw.com)

REST API for Elasticsearch-based Search:

These APIs are specifically designed to facilitate the creation and management of the Ingest, Query, and NiFi services within the Elasticsearch-based Search solution of Version 9.1. With these APIs, businesses can efficiently handle data ingestion, perform complex search queries, and manage data flow through the NiFi services, all contributing to a powerful and comprehensive search functionality for their e-commerce platform.

The Elasticsearch Query service, along with its API documentation, facilitates querying operations within Elasticsearch. Swagger UI (hcltechsw.com)

Elasticsearch Ingest handles ingestion-related tasks for Elasticsearch. Swagger UI (hcltechsw.com)

The search-display module offers RESTful services to retrieve search displays. Swagger UI (hcltechsw.com)

The HCL Commerce Services – Search Rules API Documentation covers the functionalities of Search Rules in HCL Commerce. Swagger UI (hcltechsw.com)

Globalization Administrative REST API:

These APIs are essential for the creation and management of globalization support, providing businesses with the ability to define languages and currencies for use in their stores. With these functionalities, businesses can easily adapt their e-commerce platforms to cater to diverse international markets and customers.

Currencies

Functions associated with the creation and management of supported currencies. Swagger UI (hcltechsw.com)

Currency conversions

Operations related to creating and managing currency conversion rules. Swagger UI (hcltechsw.com)

Currency descriptions

Functions for creating and managing currency descriptions. Swagger UI (hcltechsw.com)

Currency formats

Operations related to creating and managing currency formats. Swagger UI (hcltechsw.com)

Currency format descriptions

Functions for creating and managing currency formatting rule descriptions. Swagger UI (hcltechsw.com)

Languages

Operations related to registering and managing supported languages for a store. Swagger UI (hcltechsw.com)

Language descriptions

Functions for creating and managing language descriptions.  Swagger UI (hcltechsw.com)

Inventory Management Administrative REST API:

These APIs cater to DOM, Non-ATP, and ATP inventory management, providing a wide range of functionalities. These functionalities include defining the inventory model for a store and effectively managing store inventories. With these capabilities, businesses can streamline their inventory management processes and ensure efficient control over their product stocks.

Inventory configurations (DOM inventory)

Functions associated with the creation and management of inventory configurations. Swagger UI (hcltechsw.com)

Inventory availability (DOM inventory)

Operations related to creating and managing inventory availability. Swagger UI (hcltechsw.com)

Inventories (Non-ATP inventory)

Functions for creating and managing inventories. Swagger UI (hcltechsw.com)

Base items (ATP inventory)

Operations related to creating and managing base items. Swagger UI (hcltechsw.com)

Item specifications (ATP inventory)

Functions for creating and managing item specifications. Swagger UI (hcltechsw.com)

Item fulfillment centers (ATP inventory)

Operations related to creating and managing item fulfillment centers. Swagger UI (hcltechsw.com)

Store items (ATP inventory)

Functions for creating and managing store items. Swagger UI (hcltechsw.com)

Store item fulfillment centers (ATP inventory)

Operations related to creating and managing store item fulfillment centers. Swagger UI (hcltechsw.com)

Distribution arrangements (ATP inventory)

Functions for administering distribution arrangements for orders. Swagger UI (hcltechsw.com)

Receipts (ATP inventory)

Operations related to administering receipts for orders. Swagger UI (hcltechsw.com)

Available receipts (ATP inventory)

Functions for creating and managing available receipts for orders. Swagger UI (hcltechsw.com)

Marketing Administrative REST API:

These APIs are dedicated to the creation and administration of marketing campaigns and marketing content for your stores. Furthermore, they provide the necessary tools to efficiently manage and customize marketing efforts to enhance your e-commerce business’s performance.

Marketing Campaigns

Functions for creating and managing campaigns in a store. Swagger UI (hcltechsw.com)

Marketing content

Operations related to creating and managing marketing content. Swagger UI (hcltechsw.com)

Marketing promotions

Operations for creating, updating, deleting, and managing promotions. Swagger UI (hcltechsw.com)

API Definitions for Seller Organization Requests Approval Service:

This section describes the supported operations for the Seller organization requests approval service.

Swagger UI (hcltechsw.com)

Conclusion:

The HCL Commerce Version 9.1.6 Administrative REST API, with its Swagger interface, efficiently manages and customizes e-commerce sites. Moreover, it seamlessly integrates with HCL Commerce and third-party systems, empowering developers to access and manipulate functionalities, data, and resources. Additionally, RESTful principles ensure efficient data exchange, simplifying operations and connecting with multiple applications. The robust integration capabilities, comprehensive APIs, and microservices architecture drive growth and enhance customer experiences. Furthermore, developers leverage the REST API’s standardized approach and user-friendly documentation for custom solutions, extending processes, automating tasks, and integrating with third-party applications. This streamlined development process ensures high performance and scalability, handling a large volume of API calls and providing real-time responses. Embracing the HCL Commerce Version 9.1.6 Administrative REST API with its Swagger interface unlocks e-commerce businesses’ true potential for success in the digital landscape.

Reference:

https://help.hcltechsw.com/commerce/9.1.0/restapi/concepts/cwvrestapi_admin.html