Shop API documents 19.10

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.