Order object
First available in SystemsLink: 2014.2
Used by External SystemsLink for TMWSuite.
Methods
The Return Value for all methods is Order.ReturnObject. |
Method Name | Parameters | Order.ReturnObject. ReturnCode |
Description | |
---|---|---|---|---|
Name |
Data type (in C#) |
|||
N/A |
0 = successful 1000 = errors occurred |
Creates a new Order object in memory |
||
total |
int |
0 = successful 1000 = errors occurred |
Creates the specified number of new Order objects in memory |
|
criteria |
0 = successful 100 = no records found 1000 = errors occurred |
Returns all Order objects that meet the provided criteria |
||
orders |
List<Order> |
0 = successful 100 = validation errors occurred and updates prevented 500 = update proceeded with warnings 1000 = error occurred and updates prevented |
Saves the provided Order objects and updates the database if requested, then returns the saved objects if the save was successful |
|
updateDB |
bool |
|||
orders |
List<Order> |
0 = successful 100 = validation errors occurred and updates prevented 500 = update proceeded with warnings 1000 = error occurred and updates prevented |
Saves the provided Order objects, updates the database, and returns the saved objects if the save was successful |
|
orderHdr |
int |
0 = successful 100 = no records found 1000 = errors occurred |
Returns the Order object with the specified orderheader number |
|
MoveNumber |
int |
0 = successful 100 = no records found 1000 = errors occurred |
Returns the Order object with the specified movenumber and orderheader number |
|
OrderHdr |
int |
|||
orderHdr |
int |
0 = successful 100 = no records found 500 = update proceeded with warnings 1000 = errors occurred |
Uncancels the Order object with the specified orderheader number and updates the database if requested |
|
updateDB |
bool |
Properties and column mapping
To condense the information in this table, the Database Column Name uses the following abbreviations for database tables:
|
Property | Database Column | Modifiable | Comments | ||
---|---|---|---|---|---|
Name |
C# Data type |
Name |
Data Type |
||
AvailableDate |
DateTime |
o.ord_availabledate |
datetime |
Insert/Update |
|
BillTo |
string |
o.ord_billto |
varchar(8) |
Insert/Update |
|
BillToName |
string |
c.cmp_name |
varchar(100) |
Read only |
Data from Company table |
BookedBy |
string |
o.ord_bookedby |
char(20) |
Insert/Update |
|
BookedDate |
DateTime |
o.ord_bookdate |
datetime |
Insert/Update |
|
BookingTerminal |
string |
o.ord_booked_revtype1 |
varchar(12) |
Insert/Update |
|
Branch |
string |
o.ord_broker |
varchar(12) |
Insert/Update |
|
Carrier |
string |
l.lgh_carrier |
varchar(8) |
Insert/Update |
Customer-specific |
ChargeItemCode |
string |
o.cht_itemcode |
varchar(6) |
Insert/Update |
|
ChargeQuantity |
decimal |
o.ord_quantity |
float |
Insert/Update |
|
ChargeRate |
decimal |
o.ord_rate |
money |
Insert/Update |
|
ChargeRateUnit |
string |
o.ord_rateunit |
varchar(6) |
Read only |
|
Commodity |
string |
o.cmd_code |
varchar(8) |
Insert |
|
Commodity |
string |
commodity.cmd_name |
varchar(60) |
Read only |
|
CommodityValue |
string |
o.ord_cmdvalue |
Money |
Insert/Update |
|
Consignee |
string |
o.ord_consignee |
varchar(8) |
Insert/Update |
|
ConsigneeName |
string |
c.cmp_name |
varchar(100) |
Read only |
Data from Company table |
Contact |
string |
o.ord_contact |
varchar(30) |
Insert/Update |
|
Count |
decimal |
o.ord_totalpieces |
decimal(10,2) |
Insert |
|
CountUnit |
string |
o.ord_totalcountunits |
varchar(6) |
Insert |
|
Currency |
string |
o.ord_currency |
varchar(6) |
Insert/Update |
|
DataSourceID |
string |
N/A |
Not mapped |
||
DestPoint |
string |
o.ord_destpoint |
varchar(8) |
Insert/Update |
|
Driver1 |
string |
l.lgh_driver1 |
varchar(8) |
Read only |
|
Driver1Name |
string |
m.mpp_lastfirst |
varchar(45) |
Read only |
Data from Driver table |
Driver2 |
string |
l.lgh_driver2 |
varchar(8) |
Read only |
|
Driver2Name |
string |
m.mpp_lastfirst |
varchar(45) |
Read only |
Data from Driver table |
EarliestDrop |
Date |
o.ord_dest_earliestdate |
datetime |
Insert/Update |
|
EarliestPickup |
Date |
o.ord_origin_earliestdate |
datetime |
Insert/Update |
|
Equipment |
string |
o.ord_TrlConfiguration |
varchar(6) |
Insert/Update |
|
ExtraInfo1 |
string |
o.ord_extrainfo1 |
varchar(30) |
Insert/Update |
|
ExtraInfo2 |
string |
o.ord_extrainfo2 |
varchar(30) |
Insert/Update |
|
ExtraInfo3 |
string |
o.ord_extrainfo3 |
varchar(30) |
Insert/Update |
|
FixChargeQuantity |
string |
o.ord_quantity_type |
int |
Insert/Update |
|
Height |
decimal |
o.ord_height |
money |
Insert/Update |
|
HeightUnit |
string |
o.ord_heightunit |
varchar(6) |
Insert/Update |
|
InvoiceStatus |
string |
o.ord_invoicestatus |
varchar(6) |
Insert/Update |
|
IsConsolidated |
bool |
N/A |
Not mapped First available in SystemsLink: 2015.1.0 SP5 |
||
IsCrossDocked |
bool |
N/A |
Not mapped First available in SystemsLink: 2015.1.0 SP5 |
||
IsDirty |
bool |
N/A |
Not mapped or used in service |
||
IsNew |
bool |
N/A |
Not mapped, set to false during save to update |
||
IsValid |
bool |
N/A |
Not mapped or used in service |
||
LatestDrop |
Date |
o.ord_dest_latestdate |
datetime |
Insert/Update |
|
LatestPickup |
Date |
o.ord_origin_latestdate |
datetime |
Insert/Update |
|
LegHeaderNumbers |
List |
Read only |
First available in SystemsLink: 2015.1.0 SP5 |
||
Length |
decimal |
o.ord_length |
money |
Insert/Update |
|
LengthUnit |
string |
o.ord_lengthunit |
varchar(6) |
Insert/Update |
|
MaxTemperature |
short? |
o.ord_maxtemp |
smallint |
Insert/Update |
|
MinTemperature |
short? |
o.ord_mintemp |
smallint |
Insert/Update |
|
MoveNumber |
int |
o.mov_number |
int |
Read only |
|
MoveOrders |
List |
First available in SystemsLink: 2015.1.0 SP5 |
|||
Notes |
List |
Reference Note object in Note table |
|||
ord_hdrnumber |
int |
o.ord_hdrnumber |
int |
Read only |
|
OrderBy |
string |
o.ord_company |
varchar(8) |
Insert/Update |
|
OrderByName |
string |
c.cmp_name |
varchar(100) |
Read only |
Data from Company table |
OrderNumber |
string |
o.ord_number |
char(12) |
Insert |
|
OrderSource |
string |
o.ord_order_source |
varchar(6) |
Insert/Update |
|
OriginPoint |
string |
o.ord_originpoint |
varchar(8) |
Insert/Update |
|
Priority |
string |
o.ord_priority |
varchar(6) |
Insert/Update |
|
PromisedDate |
Date |
o.ord_datepromised |
datetime |
Insert/Update |
|
RateType |
bool |
o.ord_rate_type |
smallint |
Insert/Update |
|
ReferenceNumber1 |
string |
o.ord_refnum |
varchar(30) |
Insert/Update |
|
ReferenceNumber2 |
string |
r.ref_number |
varchar(30) |
Insert/Update |
Data from Reference |
ReferenceNumber3 |
string |
r.ref_number |
varchar(30) |
Insert/Update |
|
ReferenceType1 |
string |
o.ord_reftype |
varchar(6) |
Insert/Update |
|
ReferenceType2 |
string |
r.ref_type |
varchar(6) |
Insert/Update |
Data from Reference |
ReferenceType3 |
string |
r.ref_type |
varchar(6) |
Insert/Update |
|
Remark |
string |
o.ord_remark |
varchar(254) |
Insert/Update |
|
RevType1 |
string |
o.ord_revtype1 |
varchar(6) |
Insert/Update |
|
RevType2 |
string |
o.ord_revtype2 |
varchar(6) |
Insert/Update |
|
RevType3 |
string |
o.ord_revtype3 |
varchar(6) |
Insert/Update |
|
RevType4 |
string |
o.ord_revtype4 |
varchar(6) |
Insert/Update |
|
Shipper |
string |
o.ord_shipper |
varchar(8) |
Insert/Update |
|
ShipperName |
string |
c.cmp_name |
varchar(100) |
Read only |
Data from Company table |
ShowConsignee |
string |
o.ord_showcons |
varchar(8) |
Insert/Update |
|
ShowShipper |
string |
o.ord_showshipper |
varchar(8) |
Insert/Update |
|
Status |
string |
o.ord_status |
varchar(6) |
Insert/Update |
|
Stops |
List |
Insert/ Update |
Reference Stop object in Stop table |
||
TemperatureUnits |
string |
o.ord_tempunits |
varchar(6) |
Insert/ Update |
|
Terms |
string |
o.ord_terms |
varchar(6) |
Insert/Update |
|
TopSpend |
decimal |
o.ord_revenue_pay |
money |
Insert/Update |
|
TopSpendFix |
bool |
o.ord_revenue_pay_fix |
int |
Insert/Update |
|
TotalCharge |
decimal |
o.ord_totalcharge |
float |
Read only |
|
Tractor |
string |
l.lgh_tractor |
varchar(8) |
Read only |
|
Trailer |
string |
l.lgh_primary_trailer |
varchar(13) |
Insert/Update |
Customer-specific |
Trailer2 |
string |
l.lgh_primary_pup |
varchar(13) |
Read only |
|
TrailerType1 |
string |
o.trl_type1 |
varchar(6) |
Insert/Update |
|
TrailerType2 |
string |
o.ord_trl_type2 |
varchar(6) |
Insert/Update |
|
TrailerType3 |
string |
o.ord_trl_type3 |
varchar(6) |
Insert/Update |
|
TrailerType4 |
string |
o.ord_trl_type4 |
varchar(6) |
Insert/Update |
|
Updateable |
OrderUpdateInfo object |
N/A |
Not mapped |
||
Volume |
decimal |
o.ord_totalvolume |
float |
Insert |
|
VolumeUnit |
string |
o.ord_totalvolumeunits |
varchar(6) |
Insert |
|
Weight |
decimal |
o.ord_totalweight |
float |
Insert |
|
WeightUnit |
string |
o.ord_totalweightunits |
varchar(6) |
Insert |
|
Width |
decimal |
o.ord_width |
money |
Insert/Update |
|
WidthUnit |
string |
o.ord_widthunit |
varchar(6) |
Insert/Update |
Order.ReturnObject
Order.ReturnObject includes the following properties:
Property Name | C# Data type | Comments |
---|---|---|
ErrorMessages |
List<string> |
|
ErrorObjectIndexList |
List<int> |
|
Exceptions |
List<Exception> |
|
ReferenceObjects |
List<Order> |
|
ReturnCode |
int |
|
TraceMessages |
List<string> |
|
WarningMessages |
List<string> |
OrderUpdateInfo object
For this object:
|
Property Names | |||
---|---|---|---|
AvailableDate |
EarliestDrop |
OrderSource |
Status |
Order Criteria object
To condense the information in table, the Database Column uses the following abbreviations for database tables:
|
Name | Database Column | C# Data type | Comments |
---|---|---|---|
BillTo |
o.ord_billto |
string |
|
BillToName |
c.cmp_name |
string |
Join company table |
BookedBy |
o.ord_bookedby |
string |
|
BookedFrom |
o.ord_bookdate |
datetime? |
|
BookedTo |
o.ord_bookdate |
datetime? |
|
BookingTerminal |
o.ord_booked_revtype1 |
string |
|
Carrier |
l.lgh_carrier |
string |
Join legheader table |
Consignee |
o.ord_consignee |
string |
|
ConsigneeCity |
c.cmp_city |
int? |
Join company table |
ConsigneeName |
c.cmp_name |
string |
Join company table |
ConsigneeRegion1 |
c.cmp_region1 |
string |
Join company table |
ConsigneeRegion2 |
c.cmp_region2 |
string |
Join company table |
ConsigneeRegion3 |
c.cmp_region3 |
string |
Join company table |
ConsigneeRegion4 |
c.cmp_region4 |
string |
Join company table |
ConsigneeState |
c.cmp_state |
string |
Join company table |
ConsigneeZip |
c.cmp_zip |
string |
Join company table |
DeliverFrom |
o.ord_completiondate |
datetime? |
Retrieves all greater than or equal to specified value |
DeliverTo |
o.ord_completiondate |
datetime? |
Retrieves all greater than or equal to specified value |
Driver1 |
o.ord_driver1 |
string |
Join legheader table |
Driver1Name |
m.mpp_lastfirst |
string |
Join manpowerprofile table on l.lgh_driver1 |
Driver2 |
o.ord_driver2 |
string |
Join legheader table |
Driver2Name |
m.mpp_lastfirst |
string |
Join manpowerprofile table on l.lgh_driver2 |
InvoiceStatus |
o.ord_invoicestatus |
string |
|
MoveNumber |
o.mov_number |
int? |
|
ord_hdrnumber |
o.ord_hdrnumber |
int? |
|
OrderBy |
o.ord_company |
string |
|
OrderByName |
c.cmp_name |
string |
Join company table |
OrderNumber |
o.ord_number |
string |
|
OrderSource |
o.ord_order_source |
string |
|
ReferenceNumber1 |
o.ord_refnum |
string |
|
ReferenceNumberExact |
boolean? |
Not mapped, determines whether the retrieved orders should have reference numbers equal to or containing the provided number in ReferenceNumber1 |
|
ReferenceType1 |
o.ord_reftype |
string |
|
RevType1 |
o.ord_revtype1 |
string |
|
RevType2 |
o.ord_revtype2 |
string |
|
RevType3 |
o.ord_revtype3 |
string |
|
RevType4 |
o.ord_revtype4 |
string |
|
Shipper |
o.ord_shipper |
string |
|
ShipperCity |
c.cmp_city |
int? |
Join company table |
ShipperName |
c.cmp_name |
string |
Join company table |
ShipperRegion1 |
c.cmp_region1 |
string |
Join company table |
ShipperRegion2 |
c.cmp_region2 |
string |
Join company table |
ShipperRegion3 |
c.cmp_region3 |
string |
Join company table |
ShipperRegion4 |
c.cmp_region4 |
string |
Join company table |
ShipperState |
c.cmp_state |
string |
Join company table |
ShipperZip |
c.cmp_zip |
string |
Join company table |
StartFrom |
o.ord_startdate |
datetime? |
Creates a range which restricts orders returned by start date |
StartTo |
o.ord_startdate |
datetime? |
Creates a range which restricts orders returned by start date |
Status |
o.ord_status |
string |
|
Tractor |
l.lgh_tractor |
String |
Join legheader |
Trailer |
l.lgh_primary_trailer |
string |
Join legheader |
Trailer2 |
l.lgh_primary_pup |
string |
Join legheader |