Documents can get quite complex, especially when you see variables instead of texts and numbers. That’s why we suggest using snippets to make a document look less cluttered in the editor.
Let’s assume that you want to add some information to a document and display it only if certain conditions are met. You could add the information and conditions right to the document code, but that would make the document code look more complicated in the editor.
Instead you can create a snippet and add that information and conditions there. Once you save the snippet, you’ll be able to insert all its content and conditions by simply inserting a reference to the snippet into a document.
Note
Changes in a snippet will automatically apply to the document.
The list of snippets for documents is available under Design → Documents. Click the name of the required document and switch to the Code snippets tab. There you can add, edit, and delete snippets for that specific document.
Important
Each document has its own snippets, which are separate from the snippets of other documents.
Note
If you edit an existing snippet, the Restore button will appear next to the Save button. The Restore button returns the snippet to its initial state (as it was when the snippet was created).
All the snippets of a document are exported and imported together with the document in one XML file. The export and import are done on the Design → Documents page via the gear button. The detailed instructions are available in this documentation article.
Important
An imported snippet will overwrite a snippet that exists in your store, if both snippets have the same <code>
.
All snippets with the Active status appear among the available snippets in the document editor. Just click on the snippet, and it will be added to the place of the document where you left the cursor.
As an alternative, you can insert a snippet manually. For example, to insert a snippet with the code invoice_test
, add {{ snippet(“invoice_test”) }}
to the document. Once you do that, the content of the snippet should appear in document preview.
Questions & Feedback
Have any questions that weren't answered here? Need help with solving a problem in your online store? Want to report a bug in our software? Find out how to contact us.