For versions 4.37+


Overview

Adding the Order Documents Widget in the Payments panel of the Checkout page lets users upload payment evidence when submitting an order. Just set document upload against the payment types  documents are needed. Payment evidence can be mandatory for a payment type.

This feature is useful for orders that have been prepaid, third-party financed, or part-paid, or other payment scenarios where evidence of payment is needed. If made mandatory, a customer using this payment type cannot submit an order without uploading at least one document. (Multiple documents can be uploaded.) 




On this page:

Access to payment documents

Document files are stored on the server. They can be accessed by your team members and customers via a link on any order-related emails, e.g., Order Placed, Order Received. Just add the Order Documents Widget to the template. 

                   


Users can also access the documents in Order History


Step-by-step guide

1. Add Order Document Widget to Checkout template

  1. In the CMS, go to ContentPages & Templates → Checkout.

  2. Select the Checkout template.

  3. Locate the Checkout Payment Options Widget. In the same zone, click Add Widget.


  4. Search for Order Documents and click Add Widget.

  5. Edit the widget. See: Order Documents Widget.
    • Enter document file types accepted. For multiple file types, separate each one with a comma, e.g., .pdf,.jpg.
    • Ensure 'Show document link' is toggled OFF. 

  6. Save the widget.

  7. IMPORTANT - Move the Order Documents Widget so that it is positioned just above the Checkout Payment Options Widget in the same zone.


Next, edit the Checkout Payment Options Widget.

  1. Click Edit for the Checkout Payment Options Widget.

  2. Click the Order Documents tab.
  3. In Payment Types Requiring Order Documents, add one or more payment types that need a document uploaded.

  4. If required, edit the Order Document Message. NOTE - The default message contains a placeholder for the payment type.
  5. Click Save

2. Add Order Document Widget to Order Documents template

This step may have been done for your site already.

  1. In the CMS, go to ContentPages & Templates → Orders.

  2. Select the Order Documents Page template.

  3. Ensure the Order Documents widget has been added.  If not, click Add Widget.

  4. Search for Order Documents and click Add Widget.

  5. Edit the widget. See: Order Documents Widget.
    • Enter document file types accepted Format: .pdf For multiple file types, separate each one with a comma, e.g., .pdf,.jpg.
    • Ensure 'Show document link' is toggled OFF. 

  6. Save the widget.

3. Add Order Document Widget to an Email Template

This widget must be added to every email template you want the link to appear. For example, you may want the link to appear in the Order Received and Order Comfirmation emails. The widget must be added to each template separately.


To add the Order Document Widget to an email template:
  1. In the CMS, go to Content → Email

  2. Go to the email template.

  3. In the location you want the link displayed, add the Order Document Widget.

  4. Edit the widget. See: Order Documents Widget.
    • Ensure  document file types accepted are the same as those in the Checkout page's widget.
    • Enter document file types accepted Format: .pdf For multiple file types, separate each one with a comma, e.g., .pdf,.jpg.
    • Ensure 'Show document link' is toggled ON


  5. Click Save.

Additional Information



Minimum Version Requirements


4.37

Prerequisites


--

Self Configurable


Yes

Business Function


Ordering

BPD Only?


Yes

B2B/B2C/Both


Both

Third Party Costs


n/a

Related help

Related widgets