Skip to content

Latest commit

 

History

History
92 lines (73 loc) · 3.55 KB

order-documents.md

File metadata and controls

92 lines (73 loc) · 3.55 KB

Orders Module Documents

Order documents are created by the system to store additional order details. There are two types of documents that are provided ‘out of the box’:

  1. Payment document
  2. Shipment document

The user can access the order documents by selecting a specific order. Order documents are displayed on order details screen. Fig.Customer Orders

Order Payment Document

The user can view the payment details by clicking on the Order Payment Document.

Fig.Customer Orders

The Payment document contains the following fields:

  1. Payment number generated automatically by the system.
    1. The order payment number template can be specified by the admin user as follows:
      1. The user navigates to Settings->Orders->General;
      2. The system opens the General Settings screen;
      3. The user specifies the Order payment number template. Fig.Customer Orders
  2. From label displays the order creation date.
  3. Payment fees input field with currency as a label.
  4. Payment fees incl. taxes input field with currency as a label.
  5. Status drop down.
  6. Payment purpose input field.
  7. Amount input field.

The order payment document screen contains the following widgets:

Fig.Customer Orders

  1. Comments – contains all comments related to order payments.
  2. Payment address widget displays the billing address details:
    1. Address Name;
    2. Address type: Shipping/ Billing and Shipping;
    3. First Name;
    4. Last Name;
    5. Currency;
    6. Region;
    7. City;
    8. Address 1;
    9. Address 2;
    10. Zip code;
    11. Email;
    12. Phone.
  3. Transactions widget displays the list of all payment gateway transactions.
  4. Totals widget displays the total payment details:
    1. Payment price;
    2. Discount total;
    3. Tax total;
    4. Total.
  5. Changes widget displays the payment changes history (logs).
  6. Dynamic properties widget.

Order Shipment Document

The user can access the Shipment document details by clicking the ‘Shipment’ document as displayed on the screenshot bellow.

The Order shipment document screen displays the following fields:

Fig.Customer Orders

  1. Order Shipment number generated automatically by the system. The order shipment number template can be specified by user:
    1. The user navigates to settings->Orders->General;
    2. The system opens the General Settings screen;
    3. The user specifies the Order shipment number template. Fig.Customer Orders
  2. From (label) displays the order creation date.
  3. Status drop down displays the shipment status.
  4. Assigned to drop down displays the name of the person responsible for the shipment processing.
  5. Shipment amount input field.
  6. Shipment amount with tax
  7. Fulfillment center drop down.

The order shipment document screen contains the following widgets:

Fig.Customer Orders

  1. Shipment items widget displays the list of items for shipping.
  2. Changes widget displays the shipment changes history (logs).
  3. Comments widget displays the comments related to the shipment.
  4. Dynamic properties widget.
  5. Delivery address widget.
  6. Totals widget:
    1. Shipping price;
    2. Discount total;
    3. Tax total;
    4. Total.