2
0
mirror of https://github.com/inventree/InvenTree.git synced 2026-04-16 16:28:47 +00:00

[docs] Docs updates (#10678)

* Display PendingShipments panel

- Overview of all outstanding shipments

* Update UI tests

* add separate page for troubleshooting

* Restructure menus a bit

* Fix top-level page for mobile app

* Add option to override default value in docs

* Update global.md

* Formatting updates

* Update sales pages

* Move order images to "purchasing"

* Small tweaks

* Make "Concepts" a top-level documentation item

* Update image
This commit is contained in:
Oliver
2025-10-26 17:16:59 +11:00
committed by GitHub
parent c54f3f4a30
commit 1f438bb734
56 changed files with 272 additions and 217 deletions

View File

@@ -4,13 +4,15 @@ title: Customers
## Customers
A *customer* is an external client to whom parts or services are sold.
A *customer* is an external [company](../concepts/company.md) to which parts or services are sold.
To access the customer page, click on the <span class="badge inventree nav main">{{ icon("truck-delivery") }} Sales</span> navigation tab and click on <span class="badge inventree nav main">{{ icon("building-store") }} Customers</span> option in the dropdown list.
!!! warning
**Viewing**, **adding**, **editing** and **deleting** customers require the corresponding [Sales Orders user permissions](../settings/permissions.md)
{{ image("sales/customers.png", "Customers list") }}
### Add Customer
Once the customer page is loaded, click on the <span class="badge inventree add">{{ icon("plus-circle") }} New Customer</span> button: the "Create new Customer" form opens. Fill-in the manufacturer information (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>

View File

@@ -4,7 +4,7 @@ title: Return Order
## Return Orders
Return Orders allow stock items (which have been sold or allocated to a customer) to be to be returned into stock, typically for the purpose of repair or refund.
Return Orders allow stock items (which have been sold or allocated to a [customer](./customer.md)) to be to be returned into stock, typically for the purpose of repair or refund.
!!! tip "An Order By Any Other Name"
A Return Order may also be known as an [RMA](https://en.wikipedia.org/wiki/Return_merchandise_authorization)
@@ -13,7 +13,7 @@ Return Orders allow stock items (which have been sold or allocated to a customer
To navigate to the Return Order display, select *Sales* from the main navigation menu, and *Return Orders* from the sidebar:
{{ image("order/ro_display.png", "Return Order Display") }}
{{ image("sales/ro_display.png", "Return Order Display") }}
The following view modes are available:
@@ -21,23 +21,23 @@ The following view modes are available:
*Table View* provides a list of Return Orders, which can be filtered to display a subset of orders according to user supplied parameters.
{{ image("order/ro_list.png", "Return Order List") }}
{{ image("sales/ro_list.png", "Return Order List") }}
#### Calendar View
*Calendar View* shows a calendar display with outstanding return orders, based on the various dates specified for each order.
{{ image("order/ro_calendar.png", "Return Order Calendar") }}
{{ image("sales/ro_calendar.png", "Return Order Calendar") }}
### Enable Return Order Functionality
By default, Return Order functionality is not enabled - it must be enabled by a *staff* user from the settings page:
{{ image("order/return_order_enable.png", "Enable Return Orders") }}
{{ image("sales/return_order_enable.png", "Enable Return Orders") }}
Once this setting is enabled, you can access the "Return Orders" page from the main navigation bar:
{{ image("order/return_order_navbar.png", "Access return orders") }}
{{ image("sales/return_order_navbar.png", "Access return orders") }}
### Return Order Permissions
@@ -47,7 +47,7 @@ Once this setting is enabled, you can access the "Return Orders" page from the m
A list of Return Orders is displayed on the *Return Order* index page:
{{ image("order/return_order_index.png", "Return Order Index") }}
{{ image("sales/return_order_index.png", "Return Order Index") }}
Various filters are available to configure which orders are displayed, and how they are arranged.
@@ -86,7 +86,7 @@ A Return Order is linked to a specific customer, which can be selected from the
!!! warning "Customers Only"
Only companies with the "Customer" attribute enabled will be shown and can be selected
{{ image("order/return_order_create.png", "Create Return Order") }}
{{ image("sales/return_order_create.png", "Create Return Order") }}
Fill in the rest of the form with the return order information, and then click on <span class='badge inventree confirm'>Submit</span> to create the order.
@@ -102,7 +102,7 @@ The order can be assigned to a responsible *owner*, which is either a user or gr
Individual Return Orders can be viewed via the Return Order detail page:
{{ image("order/return_order_detail.png", "Return Order Detail") }}
{{ image("sales/return_order_detail.png", "Return Order Detail") }}
Here the details of the return order are available, and specific actions can be performed:

View File

@@ -5,13 +5,13 @@ title: Sales Orders
## Sales Orders
Sales orders allow tracking of which stock items are sold to customers, therefore converting stock items / inventory into externally sold items.
Sales orders allow tracking of which stock items are sold to [customers](./customer.md), therefore converting stock items / inventory into externally sold items.
### View Sales Orders
To navigate to the Sales Order display, select *Sales* from the main navigation menu, and *Sales Orders* from the sidebar:
{{ image("order/so_display.png", "Sales Order display") }}
{{ image("sales/so_display.png", "Sales Order display") }}
The following view modes are available:
@@ -19,13 +19,13 @@ The following view modes are available:
*Table View* provides a list of Sales Orders, which can be filtered to display a subset of orders according to user supplied parameters.
{{ image("order/so_list.png", "Sales Order list") }}
{{ image("sales/so_list.png", "Sales Order list") }}
#### Calendar View
*Calendar View* shows a calendar display with outstanding sales orders.
{{ image("order/so_calendar.png", "Sales Order calendar") }}
{{ image("sales/so_calendar.png", "Sales Order calendar") }}
### Sales Order Status Codes
@@ -114,7 +114,7 @@ During the allocation process, user is required to select the desired shipment t
Shipments can be marked as "checked" to indicate that the items in the shipment has been verified. To mark a shipment as "checked", open the shipment actions menu, and select the "Check" action:
{{ image("order/so_shipment_check.png", "Check shipment") }}
{{ image("sales/so_shipment_check.png", "Check shipment") }}
The shipment will be marked as checked by the current user.
@@ -177,7 +177,7 @@ The *Pending Shipments* panel displays the shipments which have not yet been sen
- Pending sales order items can be allocated to these shipments
- New shipments can be created if the order is still open
{{ image("order/pending_shipments.png", "Pending shipments") }}
{{ image("sales/pending_shipments.png", "Pending shipments") }}
#### Creating a new Shipment
@@ -187,11 +187,11 @@ To create a new shipment for a sales order, press the *New Shipment* button abov
To complete a shipment, press the *Complete Shipment* button associated with the particular shipment:
{{ image("order/complete_shipment.png", "Complete shipment") }}
{{ image("sales/complete_shipment.png", "Complete shipment") }}
### Completed Shipments
{{ image("order/completed_shipments.png", "Completed shipments") }}
{{ image("sales/completed_shipments.png", "Completed shipments") }}
### Shipment Data
@@ -220,7 +220,7 @@ An optional URL field which can be used to provide a link to an external URL.
All these fields can be edited by the user:
{{ image("order/edit_shipment.png", "Edit shipment") }}
{{ image("sales/edit_shipment.png", "Edit shipment") }}
## Sales Order Settings