Skip to main content

Shipments

The Shipments section allows you to manage the document types used in shipments within the Operations module.

From this configuration, you can view, create, edit, and delete document types, as well as define the conditions under which they will be available.

Shipment document types list

Figure 1. Shipment document types list

Documents List

The list displays the document types configured for shipments and their main information.

#

Indicates the order assigned to the document type.

Code

Identifies the document type within the system.

Name

Indicates the name assigned to the document type.

Modes

Indicates the transport modes in which the document type is available.

Direction

Indicates the trade directions for which the document type is available.

Applies To

Indicates the shipment structures to which the document type applies.

Required

Indicates whether the document type is configured as required.

System

Indicates whether the document type is generated by the system.

Portal

Indicates whether the document is visible in the Portal by default.

Active

Indicates whether the document type is enabled for use.

Available Actions

Search

Allows you to locate document types within the list.

Create Shipment Document Type

Allows you to register a new document type for shipments.

Edit

Allows you to modify the configuration of an existing document type.

Delete

Allows you to delete a registered document type.

Create Document Type

The Create Shipment Document Type option allows you to register a new document type and define the conditions under which it will be available.

Shipment document type creation form

Figure 2. Shipment document type creation form

General Information

Name

Allows you to enter the name used to identify the document type.

Code

Allows you to enter the code used to identify the document type.

Transport Modes

Allows you to define the transport modes in which the document will be available.

Direction

Allows you to define the trade directions for which the document will be available.

Applies To

Allows you to define the shipment structures to which the document will apply.

Order

Defines the display order of the document type.

info

If Transport Modes is left empty, the document applies to all transport modes.

If Applies To is left empty, the document applies to all shipment structures.

Configuration

Required

When enabled, the document is automatically created for each new shipment according to the configured transport mode and trade direction.

System Generated

Indicates whether the document type is generated by the system.

Visible in Portal by Default

Defines whether the document will be visible in the Portal by default.

Active

Defines whether the document type will be enabled for use.

important

Document types generated by the system cannot be created or edited from this form.

info

The Name and Code fields are required.

Actions

Create

Saves the document type and completes the creation process.

Create and Create Another

Saves the current record and starts the creation of a new one.

Cancel

Closes the form without creating the record.

Complete the Configuration

Once created, the document type becomes available according to the conditions defined in its configuration.