Shop API documents 23.1

To use the Shop API effectively, you have to work with documents.

Documents encapsulate storefront-related data; they are analogous to objects that you manipulate using the Digital Script API. For example, there is a Product document and a Category document. Documents are included in the body of most API responses, and they are typically required in the body of API requests that use the HTTP methods PUT, POST, or PATCH. Documents are formatted as JSON by default; however, you can also specify XML as the format. See Resource data formats.

See the Shop API document index for more information on individual documents.

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.