Itracker Ecommerce API

P a g e | 1 iTracker eCommerce API eCommerce API

Overview iTracker eCommerce API is a set of methods and classes that can be used to extend your application, and access the iTracker database to pull inventory quantities, place orders, and check the status of your orders. You can also let your warehouse know inventory is coming by taking advantage of the Receipt Notification.

Our API uses SOAP based services to interface with your application. Using the WSDL location, client code can be written, or more easily generated to interact with this service. There are many WSDL client generators out there to assist you. Our examples provided used the Microsoft SDK tool, SVCUTIL.EXE, to produce the class eCommerceClient, and the appropriate endpoints for your .config file.

Prior to using the iTracker eCommerce API you (or your contractor) should be familiar with consuming SOAP based web services into your application. Implementing an API requires writing custom code that integrates your program’s business logic and data.

iTracker May 2018 P a g e | 2

Classes

_ItemInventory

_Order

_OrderDetail

_Receipt

_ReceiptLine

Methods

GetCarriers

Parameters  string – ID

o Authentication Key as provided to you by TEMPLATE

Returns  List

o A List object representing an array of string containing the carriers’ names.

Summary  Using the provided authentication key, the service returns a list of Carrier Names that your authentication has access to.

Example

GetConsignees

Returns  List

o A List object representing an array of string containing the consignees’ names.

Summary  Using the provided authentication key, the service returns a list of Consignee Names that your authentication has access to.

Example

GetPayors

Returns  List

o A List object representing an array of string containing the payors’ names.

Summary  Using the provided authentication key, the service returns a list of Payor Names that your authentication has access to.

Example

GetShippers

Returns  List

o A List object representing an array of string containing the shippers’ names.

Summary  Using the provided authentication key, the service returns a list of Shipper Names that your authentication has access to.

Example

GetOwners

Returns  List

o A List object representing an array of string containing the owners’ names.

Summary  Using the provided authentication key, the service returns a list of Owner Names that your authentication has access to. NOTE: Typical usage would return one owner. If you are implementing for one (1) owner, you do not have to provide an owner to other methods, as the service will select the owner for you.

Example

GetWarehouses

Returns  List

o A List object representing an array of string containing the warehouses’ names.

Summary  Using the provided authentication key, the service returns a list of Warehouse Names that your authentication has access to. NOTE: Typical usage would return one warehouse. If you are implementing for one(1) warehouse, you do not have to provide a warehouse to other methods, as the service will select the warehouse for you

Example

GetInventory

Parameters  string – ownerName

o OPTIONAL - An owner of inventory

 String – warehouseName

o OPTIONAL - A warehouse that holds the inventory

 String – ID

Returns  List<_ItemInventory>

o A List object representing an array of _ItemInventory objects.

Summary  Using the provided authentication key, the service returns a list of _InventoryItem objects. The optional owner field will filter down the results for a single owner, if you have access to one owner only, leave this blank. The optional warehouse field will filter down the results for a single warehouse, if you have access to one warehouse only, leave this blank.

Example

GetItemInventory

Parameters  String – itemNumber

o Item number

 String – ownerName

o An owner of inventory (Optional only in single owner environment)

 String – warehouseName

o A warehouse that holds the inventory (Optional only single warehouse environment)

 String -ID

Returns  _ItemInventory

o A single _ItemInventory object.

Summary  Using the provided authentication key, the service returns a single _ItemInventory object. The Item Number is required, and specifies which item you are looking for. Owner Name is not required in single owner environments, as the items are unique per owner. Warehouse Name is not required in single warehouse environments, as the inventory will only be searched in the single warehouse.

Example

GetOrderList

Parameters  string – filterExpression

o A filter string to reduce the number of orders, or help find a specific group of orders. The string provided here, if present, is passed to a standard Linq Where expression to filter on any of the given fields of the _Object class.

 string – ID

Returns  List

Summary  Using the provided authentication key and filter, if present, the service returns a List of Order Numbers. Using a filter expression, such as “IsApiOrder”, or “OwnerName = “Joe Smith””, one can look for an order, without knowing the Order Number. Without a filter expression, one can get a list of all orders, and get a status on each order in conjuction with the getOrder().

Example

GetOrder

Parameters  string – orderNumber

o Order number, as returned from the PlaceOrder method, or PONumber as provided to the PlaceOrder method.

 string – ID

 bool – usePoNumber

o Indicates to the service that the orderNumber field contains a PONumber for use in searching for an Order. Typical scenario would use false, to search by Order Number.

Returns  _Order

Summary  Using the provided authentication key and Order Number, the service returns a single _Order object. The Order Number is required and specifies the order you are looking for. The method has some flexibility. If you want to find an order that was created with a specific PONumber, set the flag to true and provide that to the OrderNumber. As long as the PONumber is unique, it will return the order. Because the PONumber is not maintained within our system, we cannot guarantee that the PONumber is unique. The order will always have a unique RefNumber – this is the value that is returned from the PlaceOrder method – and can be used with usePoNumber set to false to find the order

Example

PlaceOrder

Parameters  _Order – order

o An object containing the recipient’s address, and a list of item number/quantities.

 bool – reserveInventory

o Indicates to the service that the inventory will be reserved by the system, when the pick is created. When set to false, it is left to the warehouse to select what lot the inventory will be pulled from, and will be reserved then. When set to true, then inventory will be reserved according to the owner preference in the system. This feature is ultimately controlled by TEMPLATE.

 string - ID

Returns  String - orderNumber

Summary  Using the provided authentication key, and _Order object, the service creates a Pick Order in iTracker. Prior to calling the method, provide the recipient address, and the list containing the items, and quantity order. If the reserveInventory flag is set to true, the service will assess the current inventory and reserve the inventory based on the rules set by the warehouse owner. If inventory should be released in a specific order, such as, FIFO, LIFO, etc..

Example

ReceiptNotification

Parameters  _Receipt – Object that contains the Details of the Receipt

 String – Authentication Key as provided to you by TEMPLATE

Returns  string – Upon successful creation of the receipt, the receipt number is returned.

Summary  Using the provided authentication key, the method provides the ability to create a receipt in the system.

Example //Initiate context IeCommerceClient context = new IeCommerceClient(); //Create receipt object _Receipt r = new _Receipt(); //Fill receipt r.DueDate = DateTime.Now.AddDays(4); //Add Items //Create array to hold items List<_ReceiptLine> list = new List<_ReceiptLine>(); //Create each receipt line object _ReceiptLine rl = new _ReceiptLine(); //Fill receipt line rl.ItemNumber = "123ABC"; rl.OrderQuantity = 100; //Add item to array list.Add(rl); //Convert list object to array r.ReceiptLines = list.ToArray(); //Send the receipt to the system string receiptNumber = context.ReceiptNotification(r, authenticationKey);

iTracker May 2018