Order object

First available in 2014.2.

For External SystemsLink for TMWSuite use only.

External methods

The Return Value for all methods is Order.ReturnObject.

Method Name	Parameters	Order.ReturnObject.ReturnCode	Description
	Name	Data type (in C#)
NewOrder	tokenValue	string	0 = successful 1000 = errors occurred	Authenticates the token value and creates a new Order object in memory
NewOrders	tokenValue	string	0 = successful 1000 = errors occurred	Authenticates the token value and creates the specified number of new Order objects in memory
	total	int
RetrieveOrder	tokenValue	string	0 = successful 100 = no records found 1000 = errors occurred	Authenticates the token value and returns all Order objects that meet the provided criteria
	criteria	Order.Criteria
SaveOrder	tokenValue	string	0 = successful 100 = validation errors occurred and updates prevented 500 = update proceeded with warnings 1000 = error occurred and updates prevented	Authenticates the token value, 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	Authenticates the token value, 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	Authenticates the token value and returns the Order object with the specified orderheader number
	orderHdrNumber	int
GetCrossDockOrder	tokenValue	string	0 = successful 100 = no records found 1000 = errors occurred	Authenticates the token value and returns the Order object with the specified movenumber and orderheader number
	MoveNumber	int
	OrderHdrNumber	int
UncancelOrder	tokenValue	string	0 = successful 100 = no records found 500 = update proceeded with warnings 1000 = errors occurred	Authenticates the token value, uncancels the Order object with the specified orderheader number, and updates the database if requested
	orderHdrNumber	int
	updateDB	bool

Method Name

Parameters

Order.ReturnObject.ReturnCode

Description

Name

Data type (in C#)

NewOrder

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token value and creates a new Order object in memory

NewOrders

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token value and creates the specified number of new Order objects in memory

total

int

RetrieveOrder

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Authenticates the token value and returns all Order objects that meet the provided criteria

criteria

Order.Criteria

SaveOrder

tokenValue

string

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Authenticates the token value, 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

Authenticates the token value, 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

Authenticates the token value and returns the Order object with the specified orderheader number

orderHdrNumber

int

GetCrossDockOrder

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Authenticates the token value and returns the Order object with the specified movenumber and orderheader number

MoveNumber

int

OrderHdrNumber

int

UncancelOrder

tokenValue

string

0 = successful

100 = no records found

500 = update proceeded with warnings

1000 = errors occurred

Authenticates the token value, uncancels the Order object with the specified orderheader number, and updates the database if requested

orderHdrNumber

int

updateDB

bool