OCAPI Usage 23.1

All Topics

Detailed information about using the Open Commerce API:

Topic Description
API Explorer You can interactively explore the Open Commerce APIs with API Explorer.
Batch requests You can sometimes use a batch request (a multipart HTTP request that can contain up to 50 subrequests) instead of issuing multiple separate requests.
Best practices Useful tips for working with OCAPI.
Caching You can build client-side application caches or leverage Proxy caches.
Client application identification You must ensure that your client application identifies itself for security and tracking purposes.
CORS You can take advantage of Cross-Origin Resource Sharing (CORS).
Custom properties You can get access to customer properties of business objects.
Customization You can customize OCAPI resources on server-side.
Data formats You can specify a preferred data format for resources (JSON or XML).
Expansions You can minimize network traffic and conserve server CPU usage by using a technique called expansion.
Filtering You can specify a filter on an API request to limit the number of items in the response.
Flash Document contains special information.
Global Exceptions Global exceptions thrown by OCAPI.
Global HTTP headers HTTP headers globally used by OCAPI.
Hook Circuit Breaker The Hook Circuit Breaker feature improves stability and saves processing time by protecting the system from high rates of hook failures.
Hooks Lists all API hooks available in this version.
HTTP methods You create requests based on standard HTTP methods (as defined by RFC 2616).
HTTP status codes and faults You can diagnose problems or failures by examining HTTP status codes and faults.
Images You can retrieve images using absolute URLs.
JSONP You can request that the server return a JSON document with a JavaScript function call wrapped around it.
JWT (JSON Web Token) The stateless Shop API uses JSON Web Tokens in its authentication mechanism.
Localization You can use the API in different locales.
Metadata You can request metadata about the API itself, such as the current version.
OAuth 2.0 You have to authorize your Data API requests using the OAuth 2.0 protocol.
OCAPI settings You can configure OCAPI settings in Business Manager by modifying a JSON data structure, enabling you to control client permissions, caching, and other resource-specific behaviors.
Optimistic locking Describes the two optimistic locking mechanisms supported by OCAPI.
Pagination You can use pagination to break up large responses into smaller chunks.
Property selection You can use property selectors to limit which resource properties are returned.
Resource States Resource States can be used for Optimistic Locking, which prevents collisions of concurrent requests, e.g. the "lost update" problem.
Session bridge Allows seamless interaction between OCAPI and a session-based storefront.
System Jobs Predefined jobs that can be called with an OCAPI request.
URL syntax You must create appropriately constructed URLs to operate on resources.
Versioning and deprecation policy You must ensure that your application conforms to the versioning and deprecation policy.
X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.