GM-X ERP for Blockchain - The SHIPMENT subsystem

By Tony Marston

22nd August 2007
Amended 7th April 2024

Introduction
1. Shipments
2. Outbound Packages
3. Inbound Packages
4. Drop Shipments
5. Shipment Status
6. Dispatch Events
7. Advance Shipment Notice (ASN)
8. Returned Material Authorisation (RMA)
9. Initial Values
Amendment History

Introduction

After orders have been taken the goods have to be sent to their destinations. Enough information needs to be maintained during this process so that the following questions can be answered:

A shipment is basically a movement of goods from one party to another party. It contains the items from a single order, but an order may require several shipments if items are dispatched on different days or from different locations. A shipment contains one or more packages, and each package contains quantities of one or more items.

Shipments fall into one of the following categories:

  1. Outbound - from the organisation to an external location:
  2. Inbound - from an external location into the organisation:
  3. Drop Shipment - this is where the shipment moves from one external party to another external party, typically used by a distributor to ship products directly from a supplier to a customer without having those products held in the organisation's inventory.

When an outbound shipment leaves the premises, usually by vehicle, this is known as a dispatch event. Each dispatch event may contain any number of shipments.


Shipments

Each shipment has a sending party with a sending address and optional contact details, plus a receiving party with a receiving address and optional contact details.

Figure 1 - Shipments

shipment-01 (3K)

SHIPMENT table

This holds the details of all shipments, both outbound and inbound. A shipment is a collection of one or more packages for a single customer for a single order. An order may have several shipments if different items are shipped at different times.

FieldTypeDescription
shipment_id numeric Identity number generated automatically by the system.
shipment_type string Must be one of the following:
  • Customer Shipment
  • Customer Return
  • Supplier Receipt
  • Supplier Return
  • Drop Shipment
  • Transfer Out
  • Transfer In
external_shipment_id string Optional. A shipment being received from a supplier will have that supplier's shipment id, and this may be recorded here to help with any inquiries from the supplier.
shipment_status_type_id string This uses the values specified for the SHIPMENT_STATUS_HIST table.
order_type string Optional. Links to an entry on the ORDER_HEADER table.
order_id numeric Optional. Links to an entry on the ORDER_HEADER table.
estimated_ship_date date Required. Indicates when the shipment is expected to begin its journey to the recipient.
estimated_ready_date date Optional. Indicates when the shipment is expected to be ready to be dispatched, but may require other preparation such as documentation.
estimated_arrival_date date Optional. Indicates when the shipment is expected to arrive at its destination.
latest_cancel_date date Optional. Indicates the latest date on which the shipment may be cancelled.
estimated_ship_cost numeric Optional. May be used for billing purposes.
actual_ship_cost numeric Optional. May be used for billing purposes.
handling_instructions string Optional. For example: "fragile" or "requires signature upon delivery".
party_id_sender numeric Required. This is the supplier. Links to an entry on the PARTY table. Identifies the party (organisation or person) which is sending out the shipment.
party_id_receiver numeric Required. This is the customer. Links to an entry on the PARTY table. Identifies the party (organisation or person) which is receiving the shipment. This is the same as the party which created the order.
contact_mech_id_sender_a numeric Required. Links to an entry on the CONTACT_MECHANISM table.

This is the sender's postal address.

contact_mech_id_receiver_a numeric Required. Links to an entry on the CONTACT_MECHANISM table.

This is the receiver's postal address.

contact_mech_id_sender_n numeric Optional. Links to an entry on the CONTACT_MECHANISM table.

This is the sender's telephone number.

contact_mech_id_receiver_n numeric Optional. Links to an entry on the CONTACT_MECHANISM table.

This is the receiver's telephone number.

contact_name_delivery string Optional. Used when the name of the party receiving the shipment is not the same as party_id_receiver.
asn_id numeric Optional. Links to an entry on the SPLR_SHIPMENT table.

This identifies an Advance Shipment Notice (ASN), so is only valid in a Supplier Receipt.

rma_id numeric Optional. Links to an entry on the RETURN_MATL_AUTH_HDR table.

This identifies a Returned Material Authorisation (RMA), so is only valid in a Customer Return.

The sender identity and source address are held for those circumstances where an enterprise deals with shipments from subsidiary organisations, or from several addresses. If one or both of these values are fixed it is possible to define them as initial values within the MENU system so that they will be filled in automatically.

PACKAGE table

Each shipment consists of one or more packages which have their own identity numbers. The package contents are dealt with slightly differently depending on whether the package is outbound or inbound.

FieldTypeDescription
package_id numeric Identity number which is generated automatically by the system.
party_id_supplier numeric Optional. Links to an entry on the PARTY table. This is combined with external_package_id to make a unique key
external_package_id string Optional. For inbound shipments this is the package identity used by the sender.
shipment_id numeric Links to an entry on the SHIPMENT table.
package_status_type_id string This uses the values specified for the PACKAGE_STATUS_HIST table.

SHIPMENT_ROLE_TYPE table

This identifies the types of role that a party may have when dealing with a shipment.

FieldTypeDescription
role_type_id string Identity
role_type_desc string Description

SHIPMENT_ROLE table

This identifies the parties who play a role in a shipment.

FieldTypeDescription
shipment_id numeric Links to an entry on the SHIPMENT table.
role_type_id string Links to an entry on the SHIPMENT_ROLE_TYPE table.
party_id numeric Links to an entry on the PARTY table.
contact_mech_id_blockchain string Optional. Links to an entry on the CONTACT_MECHANISM table which contains the blockchain address for this party_id.

Outbound Packages

An outbound package contains quantities of one or more products which are normally issued from inventory, but which may have been moved directly from an inbound shipment without the need to go through inventory. Items from an incoming supplier's shipment which are rejected can be returned to that supplier without being received into inventory.

Figure 2 - Outbound Packages

shipment-02 (2K)

PACKAGE_OUT_CONTENT table

This holds the details of every product contained within an outbound package. There may be more than one product in a package, and there may also be quantities of the same product distributed among several packages if the total quantity is too large for a single package. The product is identified either by the ITEM_ISSUANCE or the PACKAGE_IN_CONTENT record.

FieldTypeDescription
package_id numeric Links to an entry on the PACKAGE table.
package_seq_no numeric Sequence number which is generated automatically by the system.
item_issuance_id numeric Optional. Links to an entry on the ITEM_ISSUANCE table.
quantity_packed numeric Required.
package_id_in numeric Optional. Links to an entry on the PACKAGE_IN_CONTENT table.
package_seq_no_in numeric Optional. Links to an entry on the PACKAGE_IN_CONTENT table.
order_type string Optional. Links to an entry on the ORDER_ITEM table.
order_id numeric Optional. Links to an entry on the ORDER_ITEM table.
order_item_seq_no numeric Optional. Links to an entry on the ORDER_ITEM table.
product_id string Optional. Links to an entry on the PRODUCT table.
supplier_part_no string Optional. Identifies the part number used by the supplier. Links to an entry on the PRODUCT_SUPPLIER table.
serial_no string Required if the product is serialised, otherwise it must be blank.
lot_id numeric Required if the product is tracked by lot, otherwise it must be blank. This links to an entry on the LOT table.

PACKAGE_STATUS_HIST table

This keeps a history of all changes in the delivery status for an outbound package. This is in addition to the status of the shipment as a shipment may contain more than one package, and individual packages may suffer different fates (such as being lost or damaged).

FieldTypeDescription
package_id numeric Links to an entry on the PACKAGE table.
seq_no numeric Sequence number which is generated by the system.
package_status_type_id string Must be one of the following:
  • Pending - the package is being processed.
  • Processed - the package has been processed.
status_date date The date of this change in status.

Inbound Packages

An inbound package contains quantities of one or more items which are either sent in from a supplier, returned by a customer, or transferred from an external location. Details of individual items are held on the PACKAGE_IN_CONTENT table.

Figure 3 - Inbound Packages

shipment-03 (3K)

PACKAGE_IN_CONTENT table

This holds the details of every product contained within an inbound package. There may be more than one product in a package, and there may also be quantities of the same product distributed among several packages if the total quantity is too large for a single package.

As the items are removed from their packages they are normally inspected, and quantities can be marked as either accepted or rejected. Rejected items can be immediately transferred to an outbound shipment for return to the supplier, while accepted quantities can be booked into inventory.

The order_id and order_item_seq_no are normally only provided when the item from the supplier is for a specific sales order item. This will enable the item to be immediately moved to an outbound shipment for the relevant customer.

FieldTypeDescription
package_id numeric Links to an entry on the PACKAGE table.
package_seq_no numeric Sequence number which is generated automatically by the system.
item_receipt_desc string Required. May be entered manually, but will default to the product description if a product is defined.
order_type string Optional. Links to an entry on the ORDER_ITEM table.
order_id numeric Optional. Links to an entry on the ORDER_ITEM table.
order_item_seq_no numeric Optional. Links to an entry on the ORDER_ITEM table.
product_id string Optional. Links to an entry on the PRODUCT table.
supplier_part_no string Optional. Identifies the part number used by the supplier. Links to an entry on the PRODUCT_SUPPLIER table.
serial_no string Required if the product is serialised, otherwise it must be blank.
lot_id_external string Required if the product is tracked by lot, otherwise it must be blank. This will be the supplier's own lot id which will be used to link to an entry on the internal LOT table.
quantity_accepted numeric Required.
quantity_rejected numeric Optional.
rejection_reason_id string Optional. Links to an entry on the REJECTION_REASON table.

PACKAGE_IN_FEATURE table

This holds the details of the optional features associated with an item contained within an inbound package.

FieldTypeDescription
package_id numeric Links to an entry on the PACKAGE_IN_CONTENT table.
package_seq_no numeric Links to an entry on the PACKAGE_IN_CONTENT table.
prod_feature_id numeric Links to an entry on the PRODUCT_FEATURE table.

PACKAGE_IN_FEATURE_CUSTOMISATION table

This table holds all the customised values for a feature which apply to an inventory item. Some features within a feature category may be able to be customised, such as engraving options for jewellery will need the text which is to be engraved.

FieldTypeDescription
package_id numeric Links to an entry on the PACKAGE_IN_FEATURE table.
package_seq_no numeric Links to an entry on the PACKAGE_IN_FEATURE table.
prod_feature_id numeric Links to an entry on the PACKAGE_IN_FEATURE table.
custom_seq_no numeric Links to the seq_no field on an entry in the PROD_FEAT_CAT_CUSTOMISATION table.
feature_customisation string Text.

REJECTION_REASON table

This holds the reasons for which items received from external sources may be rejected and returned instead of being booked into inventory.

FieldTypeDescription
rejection_reason_id string Identity
rejection_reason_desc string Description

Here are some examples:

RECEIPT_ROLE_TYPE table

This identifies the types of role that a party may have when receiving items from incoming shipments.

FieldTypeDescription
role_type_id string Identity
role_type_desc string Description

Here are some examples:

ITEM_RECEIPT_ROLE table

This identifies the parties who play a role in the receipt of items from incoming shipments.

FieldTypeDescription
package_id numeric Links to an entry on the PACKAGE_IN_CONTENT table.
package_seq_no numeric Links to an entry on the PACKAGE_IN_CONTENT table.
role_type_id string Links to an entry on the RECEIPT_ROLE_TYPE table.
party_id numeric Links to an entry on the PARTY table.
contact_mech_id_blockchain string Optional. Links to an entry on the CONTACT_MECHANISM table which contains the blockchain address for this party_id.

Drop Shipments

This is where the shipment moves from one external party to another external party, typically used by an organisation to ship products directly from a supplier to a customer without having those products held in the organisation's inventory.

Each shipment goes to a single supplier, and instead of containing packages of items it contains the order details for one or more items.

Figure 4 - Drop Shipments

shipment-04 (2K)

DROP_SHIPMENT_ITEM table

This identifies the items which a supplier will ship direct to the customer. The customer details are supplied on the ORDER_HEADER.

FieldTypeDescription
shipment_id numeric Links to an entry on the SHIPMENT table.
seq_no numeric Sequence number which is generated automatically by the system.
order_type string Links to an entry on the ORDER_ITEM table.
order_id numeric Links to an entry on the ORDER_ITEM table.
order_item_seq_no numeric Links to an entry on the ORDER_ITEM table.
product_id string Links to an entry on the PRODUCT table.
quantity numeric The quantity ordered.

Shipment Status

A shipment will be in different states at different points in time, and instead of just recording the current state it may be more useful to maintain a history of each change in state.

Figure 5 - Shipment Status

shipment-05 (2K)

SHIPMENT_STATUS_HIST table

This keeps a history of all changes in status for a shipment. The entry with the highest sequence number is the latest.

FieldTypeDescription
shipment_id numeric Links to an entry on the SHIPMENT table.
seq_no numeric Sequence number which is generated by the system.
shipment_status_type_id string Must be one of the following:
  • Pending - the items are being picked and placed into packages.
  • Awaiting Dispatch - the items are ready to be dispatched.
  • In Transit - the items are on their journey to the recipient.
  • Delivered - the items have been delivered.
  • On Hold
  • Cancelled
  • Arrived (for inbound shipments only) - the items have been received, but not yet inspected and booked into inventory.
status_date date The date of this change in status.

Dispatch Events

When an outbound shipment leaves the premises, usually by vehicle, this is known as a dispatch event. Several shipments may leave in the same vehicle, and that vehicle may have to visit several locations in order to deliver all those shipments.

All the packages within a shipment must leave the premises in the same dispatch event. If packages need to be split across multiple dispatch events then they must be treated as separate shipments.

If an organisation uses its own vehicles for shipments then it may be useful to keep a record of those vehicles and the journeys that they make. It is also possible to record the mileage and fuel usage for each dispatch event, which may then be used to calculate the cost of the delivery.

Figure 6 - Dispatch Events

shipment-06 (2K)

DISPATCH_EVENT table

This identifies every instance when shipments leave the premises to be delivered to their destination. The destination may be the customer's address, or it may be some sort of transfer facility.

FieldTypeDescription
dispatch_event_id numeric Identity number which is generated automatically by the system.
estimated_start_datetime datetime Optional.
actual_start_datetime datetime Optional.
estimated_end_datetime datetime Optional.
actual_end_datetime datetime Optional.
start_mileage numeric Optional.
end_mileage numeric Optional. Required if the vehicle_id's principal activity is Custom vehicle ('C'), Vehicle distance ('V'; i.e., road transport), Fuel use and vehicle distance ('D'; for U.S. vehicles only), Passenger distance ('P';, i.e., public transport), or Weight distance ('W'; i.e., freight transport).
fuel_used numeric Optional.
fuel_type_used numeric Optional. The type of fuel_used. Required if the vehicle_id's principal activity is Fuel use and vehicle distance ('D'; for U.S. vehicles only), Custom fuel ('F'), or Fuel use ('U'), in which case the possible values are:
  • 16 = Aviation gasoline
  • 18 = On-road diesel fuel
  • 19 = Jet fuel
  • 22 = Gasoline/petrol
  • 29 = Residual fuel oil (3s 5 and 6)
  • 37 = LPG
  • 41 = 100% biodiesel
  • 55 = CNG
  • 56 = LNG
  • 57 = Ethanol
  • 58 = E85 ethanol/gasoline
  • 59 = B20 biodiesel/diesel
uom_id_fuel string Optional. The unit of measure for fuel_used (Litre by default). Required if the vehicle_id's principal activity is Fuel use and vehicle distance ('D'; for U.S. vehicles only), Custom fuel ('F'), or Fuel use ('U'), in which case the possible values are:
  • 'GALLON(US)' - U.S. gallon
  • 'GALLON' - U.K. gallon
  • 'LITRE' - Litre
  • 'BBL' - Barrel
  • 'CU_FT(S)' - Standard cubic foot
  • 'CU_FT' - Cubic foot
  • 'CU_M' - Cubic meter
shipment_method_type_id string Links to an entry on the SHIPMENT_METHOD_TYPE table.
carrier_id numeric Links to an entry on the PARTY table. This should have an entry n the PARTY_ROLE_LINK table which identifies it as a "Freight Carrier".
contact_mech_id_blockchain string Optional. Links to an entry on the CONTACT_MECHANISM table which contains the blockchain address for this carrier_id.
vehicle_id numeric Optional. Links to an entry on the VEHICLE table.
facility_id_origin numeric Optional. Links to an entry on the FACILITY table.
facility_id_destination numeric Optional. Links to an entry on the FACILITY table.
global_consignment_id string Optional. Global Consignment Identification number which conforms to GS1 standards. Used when communicating with an outside agency.
actual_weight_net numeric Optional. The actual net weight of this DISPATCH_EVENT.
actual_weight_tare numeric Optional. The actual tare weight of this DISPATCH_EVENT.
actual_weight_gcw numeric Optional. The actual gross combination weight (GCW) of this DISPATCH_EVENT.
uom_id_weight string Optional. The unit of measure in which the actual_weight_net, actual_weight_tare, and actual_weight_gcw values are denominated (Kilograms by default). Links to an entry on the UNIT_OF_MEASURE table.
passenger_count numeric Optional. The passenger count. Required for the purpose of estimating Scope 1 greenhouse gas (GHG) emissions from transport or mobile sources when this DISPATCH_EVENT is associated with a VEHICLE having the ‘Passenger distance (i.e., public transport)’ activity_type value.

When a DISPATCH_EVENT is associated with a VEHICLE, that VEHICLE has the ‘Weight distance (i.e., freight transport)’ activity_type value, and the actual_weight_gcw of the DISPATCH_EVENT is zero or NULL, the system will calculate actual_weight_gcw using the following formula:

    actual_weight_net + actual_weight_tare = actual_weight_gcw

SHIPMENT_DISPATCH_EVENT table

This identifies which shipments were part of the same dispatch event.

FieldTypeDescription
dispatch_event_id numeric Links to an entry on the DISPATCH_EVENT table.
shipment_id numeric Links to an entry on the SHIPMENT table.

PACKAGE_DISPATCH_EVENT table

This identifies which packages were part of the same dispatch event. It can also record when the package was delivered, or the reason for the delivery being rejected.

FieldTypeDescription
dispatch_event_id numeric Links to an entry on the DISPATCH_EVENT table.
package_id numeric Links to an entry on the PACKAGE table.
delivery_datetime datetime The date and time on which this shipment was delivered.
rejection_reason_id string Optional. Links to an entry on the REJECTION_REASON table.
rejection_notes string Optional text.

SHIPMENT_METHOD_TYPE table

This identifies the different ways in which items can be shipped.

FieldTypeDescription
shipment_method_type_id string Identity
shipment_method_type_desc string Description

Here are some examples:

CARRIER_SHIPMENT_METHOD table

This identifies which shipment methods are used by which carriers.

FieldTypeDescription
party_id numeric Links to an entry on the PARTY table.
shipment_method_type_id string Links to an entry on the SHIPMENT_METHOD_TYPE table.

VEHICLE_TYPE table

This identifies the different types of vehicle that the organisation may use for shipments.

FieldTypeDescription
vehicle_type_id string Identity
vehicle_type_desc string Description

Here are some examples:

VEHICLE table

This identifies the different vehicles that the organisation may use for shipments. An individual vehicle may be used in an number of different dispatch events.

FieldTypeDescription
vehicle_id numeric Identity number which is generated automatically by the system.
vehicle_desc string Optional description.
vehicle_type_id string Links to an entry on the VEHICLE_TYPE table.
vehicle_reg_no string Vehicle Registration Number.
global_asset_id string Optional. Global Asset Identification number which conforms to GS1 standards. Used when communicating with an outside agency.
asset_id number Optional. Links to an entry on the ASSET table.
area_id number Optional. Links to an entry on the GEOGRAPHIC_AREA table.
chassis_no string Optional.
motor_no string Optional.
activity_type string Optional. Signifies that greenhouse gas (GHG) emissions from this VEHICLE are estimated based on the VEHICLE’s principal activity, in which case the allowable values are:
  • 'D' = Fuel use and vehicle distance (for U.S. vehicles only)
  • 'U' = Fuel use
  • 'V' = Vehicle distance (i.e., road transport)
  • 'P' = Passenger distance (i.e., public transport)
  • 'W' = Weight distance (i.e., freight transport)
  • 'F' = Custom fuel
  • 'C' = Custom vehicle
emission_factor_id numeric Optional. The emission factors associated with this VEHICLE. Links to an entry on the EMISSION_FACTOR table. Required for the purpose of estimating Scope 1 greenhouse gas (GHG) emissions from transport or mobile sources attributable to this VEHICLE if the activity_type value is NULL.
uom_id string The unit of measure (i.e., odometer calibration by Mile or Kilometer) in which start_mileage and end_mileage are denominated on related DISPATCH_EVENT entries (Mile by default). Links to an entry on the UNIT_OF_MEASURE table.

Advance Shipment Notifications (ASNs)

When a purchase order is raised on a supplier nothing else happens within this system until the goods arrive as part of a supplier receipt. However, it is possible for a supplier to access this system via a Supplier Portal in order to perform the following:

The supplier-generated shipment record is known as an Advance Shipment Notice/Notification (ASN) which can be used as source data when the organisation actually receives the shipment. This will save having to key in the shipment details manually.

Figure 7 - Supplier Portal

shipment-07 (1K)

SPLR_SHIPMENT (ASN) table

The supplier can generate one of these when preparing a shipment of goods back to the receiving organisation in response to a purchase order. After creating an ASN record the supplier can create one or more package records, then for each package he can identify the items that are contained within that package.

Note that the supplier may have his own shipment numbering system which is independent of the number sequence used by this application. This number can be entered so that it can be tallied with the identification on the supplier's documentation.

When the shipment is actually received by the customer this document can be used to create a Supplier Receipt.

FieldTypeDescription
shipment_id numeric Identity number generated automatically by the system.
party_id_supplier numeric Links to an entry on the PARTY table.
party_id_receiver numeric Links to an entry on the PARTY table.
contact_mech_id_blockchain string Optional. Links to an entry on the CONTACT_MECHANISM table which contains the blockchain address for party_id_receiver.
splr_shipment_status string Identifies the status of this shipment. Possible values are:
  • Pending
  • Dispatched by Supplier
  • Received from Supplier
shipment_date date The date on which the shipment was dispatched by the supplier.
external_shipment_id string Optional. The supplier's own shipment Id, if there is one.
order_type string Optional. Links to an entry on the ORDER_HEADER table.
order_id numeric Optional. Links to an entry on the ORDER_HEADER table.

SPLR_PACKAGE (ASN) table

Each ASN will contain one or more packages, and each package will contain one or more items.

Note that the supplier may have his own package numbering system which is independent of the number sequence used by this application.

FieldTypeDescription
package_id numeric Identity number generated automatically by the system.
shipment_id numeric Links to an entry on the SPLR_SHIPMENT table.
party_id_supplier numeric Optional. Links to an entry on the PARTY table. This is combined with external_package_id to make a unique key
external_package_id string Optional. The supplier's own package Id, if there is one.

SPLR_PACKAGE_CONTENT (ASN) table

Once a package as been created it will be possible to log which items have been included in that package. Only those purchase order items which have been marked as "Awaiting Dispatch by Supplier" will be eligible.

FieldTypeDescription
package_id numeric Links to an entry on the SPLR_PACKAGE table.
package_seq_no numeric A sequence number which is generated by the system.
order_type string Links to an entry on the ORDER_ITEM table.
order_id numeric Links to an entry on the ORDER_ITEM table.
order_item_seq_no numeric Links to an entry on the ORDER_ITEM table.
product_id string Optional. Links to an entry on the PRODUCT table.
serial_no string Optional. Only used if this is a serialised product.
lot_id_external string Optional. Provides the supplier's lot identification number. This will be added to the LOT table when the items are received.
item_desc string Item description.
quantity numeric Item quantity. Must be greater than 1.

Returned Material Authorisations (RMA)

Sometimes after receiving an item a customer may wish to return it, either because it is the wrong product, does not work, is broken, or there is something else wrong with it. It is usual practice for the customer to contact the organisation's customer services department beforehand in order to report the problem and request an RMA number. Sometimes the organisation may arrange to collect the item free of charge, or provide a freepost address so that the customer does not have to pay to return the item. Some organisations will not accept returns unless they quote a valid RMA number. It may also be company policy to send the customer a pre-formatted label which has to be attached to the product before it can be returned.

It is also possible to generate a Credit Note for the returned item.

Figure 8 - Returned Material Authorisation

shipment-08 (2K)

RETURN_MATL_AUTH_HDR table

This identifies the RMA number and RMA date for items which are to be returned for a sales order. The items are specified on the RETURN_MATL_AUTH_ITEM table.

FieldTypeDescription
rma_id numeric Identity number generated automatically by the system.
party_id_sender numeric Links to an entry on the PARTY table.
party_id_receiver numeric Links to an entry on the PARTY table.
rma_date date The date on which this record was created.
rma_status_type_id string Identifies the status of this RMA. Possible values are:
  • Pending
  • Complete
  • Returned
  • Credit Note Produced
order_type string Links to an entry on the ORDER_HEADER table.
order_id numeric Links to an entry on the ORDER_HEADER table.
invoice_type string Optional. Links to an entry on the INVOICE_HEADER table.
invoice_id numeric Optional. Links to an entry on the INVOICE_HEADER table.
shipment_id numeric Optional. Links to an entry on the SHIPMENT table. This cannot be entered until the item(s) are returned.

RETURN_MATL_AUTH_ITEM table

This identifies the items from a sales order which are to be returned, along with the quantities and reason.

FieldTypeDescription
rma_id numeric Links to an entry on the RETURN_MATL_AUTH_HDR table.
seq_no numeric Sequence number which is generated automatically by the system.
order_type string Links to an entry on the ORDER_ITEM table.
order_id numeric Links to an entry on the ORDER_ITEM table.
order_item_seq_no numeric Links to an entry on the ORDER_ITEM table.
rma_quantity numeric The quantity of this item that is to be returned.
rma_reason string The reason why the customer wishes to return this order item.

RETURN_MATL_AUTH_STATUS_HIST table

This keeps a history of all changes in the status for an RMA.

FieldTypeDescription
rma_id numeric Links to an entry on the PACKAGE table.
seq_no numeric Sequence number which is generated by the system.
rma_status_type_id string Must be one of the following:
  • Pending - the RMA is being assembled.
  • Complete - the RMA has been assembled.
  • Returned - the item(s) have been returned.
  • Credit Note Produced
status_date date The date of this change in status.

Initial Values

There may be cases where a transaction requires user input and a particular value or values remains constant for all instances of that transaction. In order to avoid having to manually input the same value(s) each time the transaction is run it is possible to define each of those values in the database and have those values automatically included in the user input. For maximum flexibility the following tables in the MENU database are used:

TableDescription
mnu_task_field Identifies the field names within each task for which initial values can be defined. Entries must be created here for each task+field before any initial values can be defined for a task+field.
mnu_initial_value_role This defines the initial values which are to be used when users within this role execute this task.
mnu_initial_value_user This defines the initial values which are to be used when this user executes this task.

Note that USER values take precedence over ROLE values.

Here are some typical cases:

Task Field Description
shp_dispatch_event(add1)
(add shipment dispatch event)
facility_id_origin The facility_id of the place from where the shipment will be dispatched.
shp_dispatch_event(add2)
(add shipment dispatch event)
facility_id_origin The facility_id of the place from where the shipment will be dispatched.
shp_shipment_drop(add1)
(create drop shipment)
party_id_sender The party_id of the organisation from whom the shipment originates.
sending_contact_mech_id The contact_mechanism_id of the sender's telephone number.
source_contact_mech_id The contact_mechanism_id of the sender's address.
shp_shipment_in1(add1)
(create customer return)
party_id_receiver The party_id of the organisation for whom the shipment is destined.
receiving_contact_mech_id The contact_mechanism_id of the recipient's telephone number.
destination_contact_mech_id The contact_mechanism_id of the recipient's address.
shp_shipment_in2(add1)
(create purchase shipment)
party_id_receiver The party_id of the organisation for whom the shipment is destined.
receiving_contact_mech_id The contact_mechanism_id of the recipient's telephone number.
destination_contact_mech_id The contact_mechanism_id of the recipient's address.
shp_shipment_in3(add1)
(create inbound transfer)
party_id_receiver The party_id of the organisation for whom the shipment is destined.
receiving_contact_mech_id The contact_mechanism_id of the recipient's telephone number.
destination_contact_mech_id The contact_mechanism_id of the recipient's address.
shp_shipment_out1(add1)
(create customer shipment)
party_id_sender The party_id of the organisation from whom the shipment originates.
sending_contact_mech_id The contact_mechanism_id of the sender's telephone number.
source_contact_mech_id The contact_mechanism_id of the sender's address.
shp_shipment_out2(add1)
(create purchase return)
party_id_sender The party_id of the organisation from whom the shipment originates.
sending_contact_mech_id The contact_mechanism_id of the sender's telephone number.
source_contact_mech_id The contact_mechanism_id of the sender's address.
shp_shipment_out3(add1)
(create outbound transfer)
party_id_sender The party_id of the organisation from whom the shipment originates.
sending_contact_mech_id The contact_mechanism_id of the sender's telephone number.
source_contact_mech_id The contact_mechanism_id of the sender's address.
shp_shipment(add2)
(add shipment)
party_id_sender The party_id of the organisation or person from whom the shipment originates.
sending_contact_mech_id The contact_mechanism_id of the sender's telephone number.
source_contact_mech_id The contact_mechanism_id of the sender's address.
party_id_receiver The party_id of the organisation or person for whom the shipment is destined.
receiving_contact_mech_id The contact_mechanism_id of the recipient's telephone number.
destination_contact_mech_id The contact_mechanism_id of the recipient's address.
shp_shipment(add4)
(create shipment from picklist)
party_id_sender The party_id of the organisation or person from whom the shipment originates.
sending_contact_mech_id The contact_mechanism_id of the sender's telephone number.
source_contact_mech_id The contact_mechanism_id of the sender's address.
shp_splr_package_content(list2)s
(list package contents)
party_id The party_id of the supplier from whom the shipment originates.
shp_splr_package(list2)s
(list supplier packages)
party_id The party_id of the supplier from whom the shipment originates.
shp_splr_shipment(list2)
(list supplier shipments)
party_id_supplier The party_id of the supplier from whom the shipment originates.

Date created: 22nd August 2007

Amendment history:

7th Apr 2024 Updated the DISPATCH_EVENT table to add the fuel_type_used and uom_id_fuel columns, and modify the description of the fuel_used column.
30th Mar 2024 Updated the DISPATCH_EVENT table to add the actual_weight_net, actual_weight_tare, actual_weight_gcw, uom_id_weight and passenger_count columns.
Updated the VEHICLE table to add the vehicle_desc, activity_type, emission_factor_id and uom_id columns.
15th Aug 2020 Updated the VEHICLE table to add the asset_id, area_id, chassis_no and motor_no columns.
17th Aug 2019 Updated the SPLR_SHIPMENT table to remove the external_shipment_id_prefix column.
3rd Jan 2019 Updated the RETURN_MATL_AUTH_HDR table to add the rma_status_type, invoice_type, invoice_id and shipment_id columns.
Added the RETURN_MATL_AUTH_STATUS_HIST table.
20th Sep 2018 Updated the SPLR_SHIPMENT table to add the order_type and order_id columns.
Updated the SPLR_PACKAGE table to add the party_id_supplier column.
Updated the SPLR_PACKAGE_CONTENT table to add the lot_id_external column.
Updated the PACKAGE table to add the party_id_supplier column.
Updated the PACKAGE_IN_CONTENT table to add the lot_id_external column.
Updated the PACKAGE_OUT_CONTENT table to add the product_id, supplier_part_no, serial_no and lot_id columns.
Updated the RETURN_MATL_AUTH_HDR table to add the party_id_sender and party_id_receiver columns.
9th Apr 2018 Updated the SPLR_SHIPMENT table to add the party_id_receiver column.
17th Dec 2017 Updated the VEHICLE table to include the global_asset_id column.
Updated the DISPATCH_EVENT table to include the global_consignment_id and contact_mech_id_blockchain columns.
Updated the ITEM_RECEIPT_ROLE table to include the contact_mech_id_blockchain column.
Updated the SPLR_SHIPMENT table to include the contact_mech_id_blockchain column.
Added the SHIPMENT_ROLE_TYPE and SHIPMENT_ROLE tables.
3rd Apr 2017 Updated the PACKAGE_IN_FEATURE table to remove the feature_customisation column.
Added the PACKAGE_IN_FEATURE_CUSTOMISATION table
3rd June 2010 Added the PACKAGE_IN_FEATURE table.
11th May 2010 Removed the RETURNED_MATERIAL_AUTH table and replaced it with the RETURN_MATL_AUTH_HDR and RETURN_MATL_AUTH_ITEM tables.
26th Feb 2010 Updated the PACKAGE_OUT_CONTENT table to include order_type, order_id an order_item_seq_no.
Added the PACKAGE_STATUS_HIST table.
17th Jan 2010 Updated the SHIPMENT table to include contact_name_delivery.
11th Aug 2008 Added the RETURNED_MATERIAL_AUTH table.
Updated the SHIPMENT table to include rma_id.
31st Jul 2008 Updated the PACKAGE_IN_CONTENT table to include supplier_part_no.
12th Feb 2008 Added tables SPLR_SHIPMENT, SPLR_PACKAGE and SPLR_PACKAGE_CONTENT which appear in the Supplier Shipments via Supplier Portal section.
Added column asn_id to the SHIPMENT table.
Updated PACKAGE_IN_CONTENT to include the order_type, order_id and order_item_seq_no columns.

Copyright © 1999-2024 by Geoprise Technologies Licensing, All Rights Reserved.