XML3 - API DLL Documentation
The Orders type exposes the following members.
Constructors
Name | Description | |
---|---|---|
Orders(User) |
Creates an instance for Orders Class
| |
Orders(String, Guid, String) |
Creates an instance for Orders Class
| |
Orders(String, String, String) |
Creates an instance for Orders Class
|
Methods
Name | Description | |
---|---|---|
AddOrder |
Function allowing the user to add a constructed order to the collection.
| |
CreateOrder |
Function enables the user to pass an xml document, that has been formatted accordingly, and have a fully constructed order object.
| |
PlaceOrder |
Place order function allows user to place all orders within the collection of orders with a single method.
| |
RemoveOrder |
Function allowing the user to remove a constructed order to the collection.
| |
SearchOrder |
A search builder that applies search criteria to the result set on every request. To clear the search call "ClearSearch" Method
| |
SearchOrderByBackOrder |
A search builder that applies search criteria by BackOrder to the result set. To clear the search call "ClearSearch" Method
| |
SearchOrderByContactEmail |
A search builder that applies search criteria by ContactEmail to the result set. To clear the search call "ClearSearch" Method
| |
SearchOrderByContactName |
A search builder that applies search criteria by ContactName to the result set. To clear the search call "ClearSearch" Method
| |
SearchOrderByDeliveryMethod |
A search builder that applies search criteria by Delivery Method to the result set. To clear the search call "ClearSearch" Method
| |
SearchOrderByDirectShip |
A search builder that applies search criteria by DirectShip to the result set. To clear the search call "ClearSearch" Method
| |
SearchOrderByFillKill |
A search builder that applies search criteria by FillKill to the result set. To clear the search call "ClearSearch" Method
| |
SearchOrderByOrderNo |
A search builder that applies search criteria by Order Number to the result set. To clear the search call "ClearSearch" Method
| |
SearchOrderByOrderValidated |
A search builder that applies search criteria by Order Validation Status to the result set. To clear the search call "ClearSearch" Method
| |
SearchOrderByShipToCountry |
A search builder that applies search criteria by Ship to Country to the result set. To clear the search call "ClearSearch" Method
| |
SearchOrderByShipToName |
A search builder that applies search criteria by Ship to Name to the result set. To clear the search call "ClearSearch" Method
| |
SearchOrderByShipToPostCode |
A search builder that applies search criteria by ShipToPostCode to the result set. To clear the search call "ClearSearch" Method
| |
ValidateOrderItem |
Validates the OrderItems
|
Properties
Name | Description | |
---|---|---|
AccountNumber |
The unique account number associated with the user accessing the method
| |
IsError |
Flag to indicate if Error has occurred.
| |
Orders |
Collection of Orders
| |
OrdersError |
Error Object
| |
OrdersValidated |
Flag to indicate if all the Orders are validated against the Inventory
| |
SearchFields |
Search Fields for the Class
| |
UserName |
The name of the user accessing the method
|