Order object
Order 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 | |||||
|---|---|---|---|---|---|---|
Name |
Data Type (in C#) |
Name |
Data Type |
Modifiable |
Comments |
|
1 |
AvailableDate |
DateTime |
o.ord_availabledate |
datetime |
Insert/Update |
|
2 |
BillTo |
string |
o.ord_billto |
varchar(8) |
Insert/Update |
|
3 |
BillToName |
string |
c.cmp_name |
varchar(100) |
No |
Data from Company Table |
4 |
BookedBy |
string |
o.ord_bookedby |
char(20) |
Insert/Update |
|
5 |
BookedDate |
DateTime |
o.ord_bookdate |
datetime |
Insert/Update |
|
6 |
BookingTerminal |
string |
o.ord_booked_revtype1 |
varchar(12) |
Insert/Update |
|
7 |
Branch |
string |
o.ord_broker |
varchar(12) |
Insert/Update |
|
8 |
Carrier |
string |
l.lgh_carrier |
varchar(8) |
Insert/Update |
Customer-specific |
9 |
ChargeItemCode |
string |
o.cht_itemcode |
varchar(6) |
Insert/Update |
|
10 |
ChargeRateUnit |
string |
o.ord_rateunit |
varchar(6) |
Read-only |
|
11 |
Commodity |
string |
o.cmd_code |
varchar(8) |
Insert |
|
12 |
CommodityDescription |
string |
commodity.cmd_name |
varchar(60) |
Read-only |
Data comes from commodity cmd_name |
13 |
CommodityValue |
decimal |
o.ord_cmdvalue |
Money |
Insert/Update |
|
14 |
Consignee |
string |
o.ord_consignee |
varchar(8) |
Insert/Update |
|
15 |
Contact |
string |
o.ord_contact |
varchar(30) |
Insert/Update |
|
16 |
Count |
decimal |
o.ord_totalpieces |
decimal(10,2) |
Insert |
|
17 |
CountUnit |
string |
o.ord_totalcountunits |
varchar(6) |
Insert |
|
18 |
Currency |
string |
o.ord_currency |
varchar(6) |
Insert/Update |
|
19 |
DataReviewNeeded |
Bool |
o.ord_reviewneeded |
char(1) |
Insert/Update |
First available in 2015.1.0. |
20 |
DataSourceID |
string |
N/A |
Not mapped |
||
21 |
DestPoint |
string |
o.ord_destpoint |
varchar(8) |
Insert/Update |
|
22 |
Driver1 |
string |
l.lgh_driver1 |
varchar(8) |
Read-only |
|
23 |
Driver1Name |
string |
m.mpp_lastfirst |
varchar(45) |
Read-only |
Data from Driver Table |
24 |
Driver2 |
string |
l.lgh_driver2 |
varchar(8) |
Read-only |
|
25 |
Driver2Name |
string |
m.mpp_lastfirst |
varchar(45) |
Read-only |
Data from Driver Table |
26 |
EquipmentConfiguration |
string |
o.ord_TrlConfiguration |
varchar(6) |
Insert/Update |
|
27 |
ExtraInfo1 |
string |
o.ord_extrainfo1 |
varchar(30) |
Insert/Update |
|
28 |
ExtraInfo2 |
string |
o.ord_extrainfo2 |
varchar(30) |
Insert/Update |
|
29 |
ExtraInfo3 |
string |
o.ord_extrainfo3 |
varchar(30) |
Insert/Update |
|
30 |
Height |
decimal |
o.ord_height |
money |
Insert/Update |
|
31 |
HeightUnit |
string |
o.ord_heightunit |
varchar(6) |
Insert/Update |
|
32 |
InvoiceStatus |
string |
o.ord_invoicestatus. |
varchar(6) |
Insert/Update |
|
33 |
IsDirty |
bool |
N/A |
Not mapped or used in service |
||
34 |
IsNew |
bool |
N/A |
Not mapped, set to false during save to update |
||
35 |
IsValid |
bool |
N/A |
Not mapped or used in service |
||
36 |
Length |
decimal |
o.ord_length |
money |
Insert/Update |
|
37 |
LengthUnit |
string |
o.ord_lengthunit |
varchar(6) |
Insert/Update |
|
38 |
MaxTemperature |
short? |
o.ord_maxtemp |
smallint |
Insert/Update |
|
39 |
MinTemperature |
short? |
o.ord_mintemp |
smallint |
Insert/Update |
|
40 |
MoveNumber |
int |
o.mov_number |
int |
Read-only |
Required for update |
41 |
Notes |
List<Note> |
Insert/Update |
Reference Note Object in note table |
||
42 |
ord_hdrnumber |
int |
o.ord_hdrnumber |
int |
Read-only |
|
43 |
OrderBy |
string |
o.ord_company |
varchar(8) |
Insert/Update |
|
44 |
OrderNumber |
string |
o.ord_number |
char(12) |
Insert |
|
45 |
OrderSource |
string |
o.ord_order_source |
varchar(6) |
Insert/Update |
|
46 |
OriginPoint |
string |
o.ord_originpoint |
varchar(8) |
Insert/Update |
|
47 |
Priority |
string |
o.ord_priority |
varchar(6) |
Insert/Update |
|
48 |
ReferenceNumber1 |
string |
o.ord_refnum |
varchar(30) |
Insert/Update |
|
49 |
ReferenceNumber2 |
string |
r.ref_number |
varchar(30) |
Insert/Update |
Data from ReferenceNumber Table |
50 |
ReferenceNumber3 |
string |
r.ref_number |
varchar(30) |
Insert/Update |
Data from ReferenceNumber Table |
51 |
ReferenceType1 |
string |
o.ord_reftype |
varchar(6) |
Insert/Update |
|
52 |
ReferenceType2 |
string |
r.ref_type |
varchar(6) |
Insert/Update |
Data from ReferenceNumber Table |
53 |
ReferenceType3 |
string |
r.ref_type |
varchar(6) |
Insert/Update |
Data from ReferenceNumber Table |
54 |
Remark |
string |
o.ord_remark |
varchar(254) |
Insert/Update |
|
55 |
RevType1 |
string |
o.ord_revtype1 |
varchar(6) |
Insert/Update |
|
56 |
RevType2 |
string |
o.ord_revtype2 |
varchar(6) |
Insert/Update |
|
57 |
RevType3 |
string |
o.ord_revtype3 |
varchar(6) |
Insert/Update |
|
58 |
RevType4 |
string |
o.ord_revtype4 |
varchar(6) |
Insert/Update |
|
59 |
Shipper |
string |
o.ord_shipper |
varchar(8) |
Insert/Update |
|
60 |
ShowConsignee |
string |
o.ord_showcons |
varchar(8) |
Insert/Update |
|
61 |
ShowShipper |
string |
o.ord_showshipper |
varchar(8) |
Insert/Update |
|
62 |
Status |
string |
o.ord_status |
varchar(6) |
Insert/Update |
|
63 |
Stops |
List<Stop> |
Insert/ Update |
Reference Stop Object in Stop table |
||
64 |
TemperatureUnits |
string |
o.ord_tempunits |
varchar(6) |
Insert/ Update |
|
65 |
Terms |
string |
o.ord_terms |
varchar(6) |
Insert/Update |
|
66 |
TopSpend |
decimal |
o.ord_revenue_pay |
money |
Insert/Update |
|
67 |
TopSpendFix |
bool |
o.ord_revenue_pay_fix |
int |
Insert/Update |
|
68 |
TotalCharge |
decimal |
o.ord_totalcharge |
float |
No |
|
69 |
Tractor |
string |
l.lgh_tractor |
varchar(8) |
No |
|
70 |
Trailer |
string |
l.lgh_primary_trailer |
varchar(13) |
Insert/Update |
Customer-specific |
71 |
Trailer2 |
string |
l.lgh_primary_pup |
varchar(13) |
No |
|
72 |
TrailerType1 |
string |
o.trl_type1 |
varchar(6) |
Insert/Update |
|
73 |
TrailerType2 |
string |
o.ord_trl_type2 |
varchar(6) |
Insert/Update |
|
74 |
TrailerType3 |
string |
o.ord_trl_type3 |
varchar(6) |
Insert/Update |
|
75 |
TrailerType4 |
string |
o.ord_trl_type4 |
varchar(6) |
Insert/Update |
|
76 |
UpdateableProperties |
N/A |
Not mapped |
|||
77 |
Volume |
decimal |
o.ord_totalvolume |
float |
Insert |
|
78 |
VolumeUnit |
string |
o.ord_totalvolumeunits |
varchar(6) |
Insert |
|
79 |
Weight |
double |
o.ord_totalweight |
float |
Insert |
|
80 |
WeightUnit |
string |
o.ord_totalweightunits |
varchar(6) |
Insert |
|
81 |
Width |
decimal |
o.ord_width |
money |
Insert/Update |
|
82 |
WidthUnit |
string |
o.ord_widthunit |
varchar(6) |
Insert/Update |
|
Order methods
The Return Value for all methods is Order.ReturnObject.
Internal
| Parameters | ||||
|---|---|---|---|---|
Method Name |
Name |
Data type (in C#) |
Order.ReturnObject. |
Description |
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 specified 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 |
|
orderHeaderNumber |
int |
0 = successful 100 = no records found 1000 = errors occurred |
Returns all Order objects with the specified orderHeaderNumber |
|
moveNumber |
int |
0 = successful 100 = no records found 1000 = errors occurred |
Returns the Order object with the specified moveNumber and orderHeaderNumber |
|
orderHeaderNumber |
int |
|||
orderHeaderNumber |
int |
0 = successful 100 = no records found 500 = update proceeded with warnings 1000 = errors occurred |
Uncancels the Order object with the specified orderHeaderNumber and updates the database if requested |
|
updateDB |
bool |
External
| Parameters | ||||
|---|---|---|---|---|
Method Name |
Name |
Data type (in C#) |
Order.ReturnObject. |
Description |
NewOrder |
tokenValue |
string |
0 = successful 1000 = errors occurred |
Creates a new Order object in memory |
NewOrders |
tokenValue |
string |
0 = successful 1000 = errors occurred |
Creates the specified number of new Order objects in memory |
total |
int |
|||
RetrieveOrder |
tokenValue |
string |
0 = successful 100 = no records found 1000 = errors occurred |
Returns all Order objects that meet the specified criteria |
criteria |
||||
SaveOrder |
tokenValue |
string |
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 |
orders |
List<Order> |
|||
updateDB |
bool |
|||
BatchSaveOrders |
tokenValue |
string |
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 |
orders |
List<Order> |
|||
GetOrder |
tokenValue |
string |
0 = successful 100 = no records found 1000 = errors occurred |
Returns all Order objects with the specified orderHeaderNumber |
orderHeaderNumber |
int |
|||
GetCrossDockOrder |
tokenValue |
string |
0 = successful 100 = no records found 1000 = errors occurred |
Returns the Order object with the specified moveNumber and orderHeaderNumber |
moveNumber |
int |
|||
orderHeaderNumber |
int |
|||
UncancelOrder |
tokenValue |
string |
0 = successful 100 = no records found 500 = update proceeded with warnings 1000 = errors occurred |
Uncancels the Order object with the specified orderHeaderNumber and updates the database if requested |
orderHeaderNumber |
int |
|||
updateDB |
bool |
Order.ReturnObject
| Property Name | Data Type (in C#) | Comments | |
|---|---|---|---|
1 |
ErrorMessages |
List<string> |
|
2 |
ErrorObjectIndexList |
List<int> |
|
3 |
Exceptions |
List<Exception> |
|
4 |
ReferenceObjects |
List<Order> |
|
5 |
ReturnCode |
int |
|
6 |
TraceMessages |
List<string> |
|
7 |
WarningMessages |
List<string> |
OrderUpdateInfo object
-
Data types (in C#) for all properties are bool.
-
Set the property to
trueto update the corresponding Order property.
| Property Name | |
|---|---|
1 |
AvailableDate |
2 |
BillTo |
3 |
BookedBy |
4 |
BookedDate |
5 |
BookingTerminal |
6 |
Branch |
7 |
Carrier |
8 |
ChargeItemCode |
9 |
Commodity |
10 |
CommodityDescription |
11 |
CommodityValue |
12 |
Consignee |
13 |
Contact |
14 |
Count |
15 |
CountUnit |
16 |
Currency |
17 |
DestPoint |
18 |
EquipmentConfiguration |
19 |
ExtraInfo1 |
20 |
ExtraInfo2 |
21 |
ExtraInfo3 |
22 |
Height |
23 |
HeightUnit |
24 |
InvoiceStatus |
25 |
Length |
26 |
LengthUnit |
27 |
MaxTemperature |
28 |
MinTemperature |
29 |
Notes |
30 |
OrderBy |
31 |
OrderNumber |
32 |
OrderSource |
33 |
OriginPoint |
34 |
Priority |
35 |
ReferenceNumber1 |
36 |
ReferenceNumber2 |
37 |
ReferenceNumber3 |
38 |
ReferenceType1 |
39 |
ReferenceType2 |
40 |
ReferenceType3 |
41 |
Remark |
42 |
RevType1 |
43 |
RevType2 |
44 |
RevType3 |
45 |
RevType4 |
46 |
Shipper |
47 |
ShowConsignee |
48 |
ShowShipper |
49 |
Status |
50 |
Stop |
51 |
TemperatureUnits |
52 |
Terms |
53 |
TopSpend |
54 |
TopSpendFix |
55 |
Trailer |
56 |
TrailerType1 |
57 |
TrailerType2 |
58 |
TrailerType3 |
59 |
TrailerType4 |
60 |
Volume |
61 |
VolumeUnit |
62 |
Weight |
63 |
WeightUnit |
64 |
Width |
65 |
WidthUnit |
Order Criteria object
|
To condense the information in the table, the Database Column uses the following abbreviations for database tables:
|
| Name | Database Column | Data Type (in C#) | Comments | |
|---|---|---|---|---|
1 |
BillTo |
o.ord_billto |
string |
|
2 |
BillToName |
c.cmp_name |
string |
Join company table |
3 |
BookedBy |
o.ord_bookedby |
string |
|
4 |
BookedFrom |
o.ord_bookdate |
datetime? |
Creates a range that limits the orders returned by booking date |
5 |
BookedTo |
o.ord_bookdate |
datetime? |
|
6 |
BookingTerminal |
o.ord_booked_revtype1 |
string |
|
7 |
Carrier |
l.lgh_carrier |
string |
Join legheader table |
8 |
Consignee |
o.ord_consignee |
string |
|
9 |
ConsigneeCity |
c.cmp_city |
int? |
Join company table |
10 |
ConsigneeRegion1 |
c.cmp_region1 |
string |
|
11 |
ConsigneeRegion2 |
c.cmp_region2 |
string |
|
12 |
ConsigneeRegion3 |
c.cmp_region3 |
string |
|
13 |
ConsigneeRegion4 |
c.cmp_region4 |
string |
|
14 |
ConsigneeState |
c.cmp_state |
string |
|
15 |
ConsigneeZip |
c.cmp_zip |
string |
|
16 |
DeliverFrom |
o.ord_completiondate |
datetime? |
Restricts the return to delivery dates within the provided range |
17 |
DeliverTo |
o.ord_completiondate |
datetime? |
|
18 |
Driver1 |
l.lgh_driver1 |
string |
Join legheader table |
19 |
Driver1Name |
m.mpp_lastfirst |
string |
Join to manpowerprofile table on l.lgh_driver1 |
20 |
Driver2 |
l.lgh_driver2 |
string |
Join legheader table |
21 |
Driver2Name |
m.mpp_lastfirst |
string |
Join to manpowerprofile table on l.lgh_driver2 |
22 |
InvoiceStatus |
o.ord_invoicestatus. |
string |
|
23 |
MoveNumber |
o.mov_number |
int? |
|
24 |
ord_hdrnumber |
o.ord_hdrnumber |
int? |
|
25 |
OrderBy |
o.ord_company |
string |
|
26 |
OrderNumber |
o.ord_number |
string |
|
27 |
OrderSource |
o.ord_order_source |
string |
|
28 |
ReferenceNumber1 |
o.ord_refnum |
string |
|
29 |
ReferenceNumberExactMatch |
boolean? |
Not mapped, determines whether the retrieved orders should have reference numbers equal to or containing the provided number in ReferenceNumber1 |
|
30 |
ReferenceType1 |
o.ord_reftype |
string |
|
31 |
RevType1 |
o.ord_revtype1 |
string |
|
32 |
RevType2 |
o.ord_revtype2 |
string |
|
33 |
RevType3 |
o.ord_revtype3 |
string |
|
34 |
RevType4 |
o.ord_revtype4 |
string |
|
35 |
Shipper |
o.ord_shipper |
string |
|
36 |
ShipperCity |
c.cmp_city |
int? |
Join company table |
37 |
ShipperRegion1 |
c.cmp_region1 |
string |
|
38 |
ShipperRegion2 |
c.cmp_region2 |
string |
|
39 |
ShipperRegion3 |
c.cmp_region3 |
string |
|
40 |
ShipperRegion4 |
c.cmp_region4 |
string |
|
41 |
ShipperState |
c.cmp_state |
string |
|
42 |
ShipperZip |
c.cmp_zip |
string |
|
43 |
StartFrom |
o.ord_startdate |
datetime? |
Creates a range which restricts orders returned by start date |
44 |
StartTo |
o.ord_startdate |
datetime? |
|
45 |
Status |
o.ord_status |
string |
|
46 |
Tractor |
l.lgh_tractor |
string |
Join legheader |
47 |
Trailer |
l.lgh_primary_trailer |
string |
Join legheader |
48 |
Trailer2 |
l.lgh_primary_pup |
string |
Join legheader |