OCAPI resource data formats 23.1

The Open Commerce API currently supports two data formats for resources: JSON and XML. JSON is the default format, but you can explicitly specify XML.

How you specify a format depends on the underlying HTTP method. For GET requests, you provide a value for the URL request parameter format (valid values are json and xml). For POST, PUT, and PATCH requests, you provide a value for the HTTP header content-type (valid values are application/json, application/xml, and text/xml). The HTTP header content-type has precedence over the URL request parameter format.

Note: The Open Commerce API supports character encoding in UTF-8 only.
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.