Page Comparison

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).

Default configurations

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		Expand title Unfold Code Block language json [ { "name": "preparation_note", "existsIf": "documents.preparation_note", "type": "multi_parcel" } ]

[
  {
    "name": "collect_note",
    "existsIf": "documents.collect_note",
    "entityType": "order"
  },
  {
    "name": "shipment",
    "existsIf": "shipment.document_id",
    "entityType": "parcel"
  },
  {
    "name": "dispatch_note",
    "existsIf": "documents.dispatch_note",
    "entityType": "parcel"
  },
  {
    "name": "return_note",
    "existsIf": "documents.return_note",
    "entityType": "return_parcel"
  },
  {
    "name": "manifest",
    "existsIf": "documents.manifest",
    "entityType": "parcel"
  }
]

• 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".