Documents
- Thibault Galharret
Introduction
This configuration allows you to specify which documents can be generated from the Store App. Once configured, these documents will be displayed from the printer button (pages without scan) or from the preparation pop-up (page with scan).
Page without scan
By default, “shipment” and “dispatch_note” documents are displayed
Page with scan
By default, “shipment” and “dispatch_note” documents are displayed
Default configuration
Most of the time, it is not necessary to modify these elements as a default configuration exists on most pages. Here are the details.
Page | Documents by default | JSON format |
|---|---|---|
prepare_select |
| [
{
"name": "preparation_note",
"existsIf": "documents.preparation_note",
"type": "multi_parcel"
}
] |
pack or pack_multi |
| [
{
"name": "shipment",
"existsIf": "shipment.document_id"
},
{
"name": "dispatch_note",
"existsIf": "documents.dispatch_note"
}
] |
pack_scan |
| [
{
"name": "shipment",
"existsIf": "shipment.document_id"
},
{
"name": "dispatch_note",
"existsIf": "documents.dispatch_note"
}
] |
dispatch |
| |
bag or bag_multi |
| |
bag_scan |
| |
boxing |
| |
customer_search > customer_order |
|
Overloading the configuration
You can override the default configuration to add custom documents or delete some of the defaults by going to the Configuration > Store App > Pages > {Page name} > Documents section.
The configuration is an array of objects whose structure is as follows:
name(mandatory) - Name of the document. Must match the name given in the document template configuration.existsIf(mandatory) - Path used to identify whether or not the document has already been generated. If the document is found via the configured path, then a green tick will be displayed and the document will simply be retrieved and not posted again.entityType(optional) - Used to identify the entity in which you need to check whether the document has been generated. If not entered, the default value is"parcel". Other values can be"return_parcel","order"or"shipment_manifest"type(optional) - Used to indicate whether a custom document is a shipment. Does not need to be configured for a standard"shipment"but must be configured for"return_shipment".
Overloading this configuration completely overrides the default one . You will need to reconfigure the default documents if you wish to keep them.
Examples
Here are a few examples of overloads you can reuse.