Add Method (Shipment)
- Last UpdatedNov 06, 2025
- 2 minute read
The Add() method adds a new shipment record to the Shipment table against a sales order line item.
'Declaration
Public Shared Sub Add( _
ByVal sessionId As Integer, _
ByVal custId As String, _
ByVal poId As String, _
ByVal soLineNumber As Integer, _
ByVal shipDateUtc As Date, _
ByVal shipVia As String, _
ByVal shipBy As String, _
ByVal shipFrom As Nullable(Of Integer), _
ByVal spare1 As String, _
ByVal spare2 As String, _
ByVal spare3 As String, _
ByVal spare4 As String, _
ByRef lastEditAt As Date _
)
'Usage
Dim sessionId As Integer
Dim custId As String
Dim poId As String
Dim soLineNumber As Integer
Dim shipDateUtc As Date
Dim shipVia As String
Dim shipBy As String
Dim shipFrom As Nullable(Of Integer)
Dim spare1 As String
Dim spare2 As String
Dim spare3 As String
Dim spare4 As String
Dim lastEditAt As Date
Shipment.Add(sessionId, custId, poId, soLineNumber, shipDateUtc, shipVia, shipBy, shipFrom, spare1, spare2, spare3, spare4, lastEditAt)
public static void Add(
int sessionId,
string custId,
string poId,
int soLineNumber,
DateTime shipDateUtc,
string shipVia,
string shipBy,
Nullable<int> shipFrom,
string spare1,
string spare2,
string spare3,
string spare4,
out DateTime lastEditAt
)
Parameters
- sessionId
- Required. Holds the session ID and thus the user who is making this method call.
- custId
- Required. Holds the customer ID, from the SO_Line table.
- poId
- Required. Holds the purchase order ID, from the SO_Line table.
- soLineNumber
- Required. Holds the sales order line number, from the SO_Line table, of the goods shipped.
- shipDateUtc
- Required. Holds the date and time when the goods were shipped, in UTC.
- shipVia
- Optional. Holds the description of how the goods were shipped.
- shipBy
- Optional. Holds the name of who shipped the goods.
- shipFrom
- Optional. Holds the ID of the entity from which the goods were shipped.
- spare1
- Optional. Holds the contents of the user-defined spare1 field.
- spare2
- Optional. Holds the contents of the user-defined spare2 field.
- spare3
- Optional. Holds the contents of the user-defined spare3 field.
- spare4
- Optional. Holds the contents of the user-defined spare4 field.
- lastEditAt
- Output. Holds the returned date/time when this record was added. The lastEditAt parameter is used by other methods that modify or delete this type of record for optimistic concurrency control.
Observe the following input parameter rules:
- Required non-DB* parameters: Must pass a value. Cannot be empty or null.
- Optional non-DB* parameters: Either enter a value or pass a null. If passing a null and a default value has been defined, the default value will be used for the parameter.
- Required DB* parameters: Must pass a value. To enter an empty value for the parameter, pass DB*.null (e.g., DBInt.null).
- Optional DB* parameters: To enter no value for the parameter, pass DB*.null (e.g., DBInt.null). To use the default value for the parameter if one has been defined for the object being added, pass a null.