Commerce Service API
The Commerce Service API provides the ability for external entities to execute functions within Sitecore XC. The API is RESTful based on Odata. Odata provides built-in benefits, such as supporting annotations on metadata, which enables clients to pre-validate and support enumerable properties.
Service API commands can be short or long-running. Commands are request/response oriented.
The API can be extended by adding commands via a Commerce plugin.
The Sitecore Commerce Service API is made up of three role-oriented APIs, each targeting specific logically separated business needs:
-
CommerceOps API â for the DevOps role in managing a Sitecore XC implementation, including methods to create and manage environments and global policies.
-
CommerceShops API â for supporting the online shopping experience such as a web storefront. For example, when adding to a cart in the Storefront, the related processor in Commerce Connect makes an API call to the Commerce Engine to perform the cart activity and return a result.
-
CommerceAuthoring API â for business users. It introduces the Entity Views concept, which is a mechanism for mapping potentially complex Sitecore Commerce entities into a flattened structure that can be dynamically represented in business tools.
Many Commerce Service API requests are included in the Postman sample collections that are available in the sitecore.Commerce.Engine.SDK package.