c# Syntax

User Login();

void Logout();

While calling the Login and Logout methods are not necessary for calling the Service API methods when not using the REST interface, the Login method will return the User object, as shown below. When calling any of the Service API methods, it is necessary to set the Username and Password properties of the Username property of the ClientCredentials object. The ClientCredentials object is part of the proxy class, of type ClientBase, created when a Service Reference is added to the project from Visual Studio to the Service API web service. This is the same proxy class you would be using to make calls to the Service API. This Username and Password must be a valid login for the Northstar WMS website, and it also determines which customer database will be used when calling each of the Service API methods. When an API method is called, the Username and Password set in the ClientCredential object is passed to the web service and they are validated before the Service API method is called. Each API method requires that the login be authenticated before calling it.

When using the REST interface, the application will need to call the Login method of the Authentication service. This will return an authentication ticket, stored in a cookie, from the website, and this authentication ticket will then be used on all subsequent REST API method calls to let the website know that caller of the method is already authenticated and authorized to call the API method. See the sample test application, in the file RestServiceSecurityManager.cs, to see how to setup the client application during the login process. The Login method of the Authentication service has the same c# syntax as shown above. It takes no data on the request and returns a User object in the response in JSON format. The Logout REST API call takes no data on the request and returns no data on the response.

public class user
{
	public string FirstName { get; set; }
	public string LastName { get; set; }
	public string Email { get; set; }
	public string Username { get; set; }
	public string Password { get; set; }
	public string Phone { get;   set; }
	public string Department { get ;  set; }
}

Error Processing during Imports

A list of Response objects is returned for each Import method. The list of response objects indicate any errors and/or warnings that have occurred for each object being imported. Below is what is returned, along with descriptions of each property.

public class Response
{
	public bool Success { get; set; }
	public string EntityId { get; set; }
	public string LineNo { get; set; }
	public string ItemNo { get; set; }
	public  List<string> WarningMessages { get; set; }
	public  List<string> ErrorMessages { get;   set; }	
}

Exception Handling

While making a call to one of the Service API methods, it is possible that an exception may occur while the method on the server is being executed. Each Service API method is configured to return a Fault Exception. This Fault Exception is of type NorthstarWmsFault and has the following structure and description.

public class  NorthstarWmsFault
{		
	public string ExceptionMessage { get; set; }		
	public IList <string>  InnerExceptionMessages { get ;  set; } 
}

When calling any of the Service API methods, it is recommended that a try/catch block be constructed as follows:

try
{
}	
	catch ( FaultException<NorthstarWmsFault>northstarWmsFault)
{
}	
	catch ( MessageSecurityException  msEx)
{
}
	catch ( Exception   ex)
{
}

In the try block, the call to the Service API method would be made, and then up to one of three catch blocks will be executed, depending on whether an exception occurred, and what type of exception. The first catch block catches any exceptions of type FaultException which is the type of fault exception that each Service API method will return. Assuming that the variable holding the exception object is named norhtstarWmsFault, as in the code above, then the NorthstarWmsFault object can be accessed by calling the Detail property of northstarWmsFault. The last two catch blocks in the example above will catch any MessageSecurityException and any other Exception that may occur, respectively.

Notes on the NorthstarWmsIntegrationTestClient Sample Application

The NorthstarWmsIntegrationTestClient sample application demonstrates the use of both the standard web services API, as well as the REST API. The app.config file sets a couple application settings that configures the base web service address, whether to use the REST interface, and the content type of the REST service calls (JSON or XML). The main form of the application is the TestPage1.cs form. The form contains buttons that call each web service method, using either the standard web service interface or the REST interface. The INorthstarIntegration.cs file contains the INorthstarIntegration interface used by both the standard web service and REST interfaces, and includes method, as well as data, declarations described in this document. The IServiceMethods.cs, ServiceMethodsNet.cs, and ServiceMethodsRest.cs files implement the actual web service and REST interface method calls used by the TestPage1 form. The RestServiceClientBase.cs file contains the base class for the ServiceMethodsRest class and defines some methods used by the ServiceMethodsRest class. The RestServiceSecurityManager.cs file contains the logic used for the REST services to login to the web services using an Authentication service. This file is very important in that it contains all the logic necessary for authenticating with the API’s using the REST interface. Please look at this file very closely when using the REST interface. The ServiceClient.cs file contains the ServiceClient class used by both the standard and REST web services to setup the service client. If you notice, there are no Service References used by the sample application. The client interfaces are configured inside the ServiceMethodsNet, RestServiceClientBase, and RestServiceSecurityManager classes.

c# Syntax

	
	List <Response> SavePurchaseOrders(List<PurchaseOrder>purchaseOrders);
	
    List <PurchaseOrder> GetPurchaseOrders(DateTime? fromDate,DateTime? toDate, bool qtyEaches, string warehouse,DateTime? fromRecvDate,DateTime? toRecvDate);    
    
    List<PurchaseOrder> GetPurchaseOrdersForPoNo( string poNo,bool qtyEaches, string warehouse);

REST syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/PurchaseOrders/Save

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/PurchaseOrders

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/PurchaseOrders/PoNo

The SavePurchaseOrders method saves one or more new Purchase Orders with their details, or updates existing Purchase Orders and their details. The PurchaseOrder class contains the properties for the Purchase Order header, and a list of the order details, each being a PurchaseOrderDetail type. The list of Response objects contains any warnings or errors that occurred while saving or updating the Purchase Orders. The EntityId property of the Response object will be set to the PoNo property of the PurchaseOrder type. The PurchaseOrder and PurchaseOrderDetail classes, along with the descriptions of their properties, are shown below.

The GetPurchaseOrders method returns a list of Purchase Orders that have been closed, but not yet exported. A From Date and a To Date can be specified to retrieve a list of Purchase Orders within a particular date range.

Date range is not required, when left blank all orders that have been received where receive qty > export qty will be returned, unless you want a specific range of orders leaving the date fields blank is the best approach.

Also, the quantities returned can be returned in Eaches if the qtyEaches parameter is set to true, otherwise, if set to false, it will return the quantities using UOM quantities. The quantities affected by the qtyEaches parameter are the OrderQty and RecvQty properties. After the Purchase Orders are retrieved, the Purchase Order details are marked as being exported by setting the Exported quantity to the Received quantity.

For the REST interface, the /PurchaseOrders/Save REST call, the equivalent of the SavePurchaseOrders c# method, expects an array of PurchaseOrder objects, serialized to JSON, on the request, and returns an array of Response objects, in JSON format, on the response to the REST API call. The /PurchaseOrders REST call, the equivalent of the GetPurchaseOrders c# method, takes a GetPurchaseOrdersRequest object, serialized to JSON, on the request, and returns an array of PurchaseOrder objects, in JSON format.

public class PurchaseOrder
{
	  public string WarehouseName { get; set; }
	  public string PoNo { get; set; }
	  public string VendorId { get; set; }
	  public string VendorName { get; set; }
	  public string VendorAddress { get; set; }
	  public string Phone { get;   set; }
	  public string VendorAddress2 { get ;  set; }
	  public string VendorCity { get ;  set; }
	  public string VendorState { get ;  set; }
	  public string VendorZip { get ;  set; }
	  public string VendorCountry { get ;  set; }
	  public string Status { get ;  set; }
	  public string OrderDate { get ;  set; }
	  public string DueDate { get ;  set; }
	  public string Carrier { get ;  set; }
	  public string ShipModeName { get ;  set; }
	  public string CustOwnerName { get ;  set; }
	  public decimal? ShipCost { get ;  set; }
	  public string Comment { get ;  set; }
	  public string ShipToId { get ;  set; }
	  public string ShipToName { get ;  set; }
	  public string ShipToAddress { get ;  set; }
	  public string ShipToAddress2 { get ;  set; }
	  public string ShipToCity { get ;  set; }
	  public string ShipToState { get ;  set; }
	  public string ShipToZip { get ;  set; }
	  public string ShipToCountry { get ;  set; }
	  public String ProjectNo { get ;  set; }
	  public List<PurchaseOrderDetail> PurchaseOrderDetails { get ;  set; }
	  public string CustOwnerId { get ;  set; }
	  public string TrackingNo { get ;  set; }
	  public string Market { get ;  set; }
      public string HLID { get ;  set; }
	  public string Misc1 { get ;  set; }
	  public string Misc2 { get ;  set; }
	  public string Misc3 { get ;  set; }
	  public string Misc4 { get ;  set; }
	  public string Misc5 { get ;  set; }
	  public string Misc6 { get ;  set; }
	  public string Misc7 { get ;  set; }
	  public string Misc8 { get ;  set; }
      public bool? IgnoreImportLock { get ;  set; }
      public byte[] OrderPicture1 { get ;  set; }
      public byte[] OrderPicture2 { get ;  set; }
      public bool? DropShip { get ;  set; }
	  public bool? ChangePODetailLine { get ;  set; }
	  public string VendorDocNumber { get; set; }
}

public class PurchaseOrderDetail
{
	public int? PoLine { get; set; }
	public string ItemNo { get; set; }
	public string ItemDesc { get; set; }
	public decimal? UnitCost { get; set; }
	public decimal? UnitWgt { get; set; }
	public decimal? CaseCost { get;   set; }
	public decimal? CaseWeight { get ;  set; }
	public string SerialNo { get ;  set; }
	public string ExpirationDate { get ;  set; }
	public string BestByDate { get ;  set; }
	public string LotNo { get ;  set; }
	public string ItemUomName { get ;  set; }
	public long? ItemUnitQuantity { get ;  set; }
	public decimal? OrderQty { get ;  set; }
	public decimal? RecvQty { get ;  set; }
	public string ReceiveDate  { get ;  set; }
	public string Misc1 { get ;  set; }
	public string Misc2 { get ;  set; }
	public string Misc3 { get ;  set; }
	public string Misc4 { get ;  set; }
	public string InvMisc1 { get ;  set; }
	public string InvMisc2 { get ;  set; }
	public string InvMisc3 { get ;  set; }
	public string InvMisc4 { get ;  set; }
	public string OrderNo { get ;  set; }
	public string VendorDetailId { get ;  set; }
	public string VendorDetailName { get ;  set; }
	public string VendorDetailAddress { get ;  set; }
	public string VendorDetailAddress2 { get ;  set; }
	public string VendorDetailCity { get ;  set; }
	public string VendorDetailState { get ;  set; }
	public string VendorDetailZip { get ;  set; }
	public string VendorDetailCountry { get ;  set; }
	public decimal? DamageQty { get ;  set; }
	public string DamageComment { get ;  set; }
	public byte[] DamagePicture { get ;  set; }
    public string Location { get ;  set; }
	public bool? QAItem { get ;  set; }
    public string QALoc { get ;  set; }
    public string QAWhse { get ;  set; }
	public bool? CrossDock { get ;  set; }
	public string PromiseDate { get ;  set; }
}

public class GetPurchaseOrdersRequest
{
	public DateTime? FromDate { get ;  set; }
	public DateTime? ToDate { get ;  set; }
	public bool  QtyEaches  { get; set; }
	public string  Warehouse  { get; set; }
   	public DateTime? FromRecvDate { get ;  set; }
	public DateTime? ToRecvDate { get ;  set; }    
 	public string StringRecvFromDate  { get ;  set; }
	public string StringRecvToDate  { get ;  set; }

}

public class GetPurchaseOrdersForPoNoRequest
{
	public String PoNo { get ;  set; }
	public bool? QtyEaches { get ;  set; }
	public string Warehouse  { get ;  set; }	
}

c# Syntax

	 List< InventoryHistory>GetInventoryAdjustments(DateTime? fromDate DateTime? toDate, string warehouse);

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/InventoryAdjustments

The GetInventoryAdjustments method gets the list of records from Item History where Inventory has been adjusted. A date range can be specified using the optional fromDate and toDate parameters. The InventoryHistory class, along with the descriptions of its properties, is shown below. Unless you want a specific range of adjustments returned, the best approach is to leave the toDate blank and set the fromDate/datetime to the date/time of the last call.

For the REST interface, the /InventoryAdjustments REST call, the equivalent of the GetInventoryAdjustments c# method, takes a GetInventoryAdjustmentsRequest object, serialized to JSON, in the request, and returns an array of InventoryHistory objects, in JSON format, in the response.

public class InventoryHistory
{
	public string TransactionType { get ;  set; }
	public string SoNo { get ;  set; }
	public int ? SoLine { get; set; }
	public string PoNo { get; set; }
	public string PoLine { get; set; }
	public string ItemNo { get; set; }
	public string Status { get; set; }
	public string FromWhouse { get; set; }
	public string FromBin { get; set; }
	public string ToWhouse { get; set; }
	public string ToBin { get; set; }
	public string Qty { get; set; }
	public string LotNo { get; set; }
	public string SerialNo { get; set; }
	public string Container { get; set; }
	public string RecvDate { get; set; }
	public string Comment { get; set; }
	public string CustOwner { get; set; }
	public string Misc1 { get; set; }
	public string Misc2 { get; set; }
	public string Misc3 { get; set; }
	public string Misc4 { get; set; }
	public string Misc5 { get; set; }
	public string Misc6 { get; set; }
	public string Misc7 { get; set; }
	public string Misc8 { get; set; }
	public string Misc8 { get; set; }
	public string Reason { get; set; }
	public string BatchNo { get; set; }
	public string BatchDate { get; set; }
	public string ProcessDate { get; set; }
	public string ProcessStatus { get; set; }
	public string NewItemNo { get; set; }
	public string NewLotNo { get; set; }
	public string InventoryAdjusted { get; set; }
	public long? HistID { get; set; }
}

public class GetInventoryAdjustmentsRequest
{
	publicDateTime? FromDate { get ;  set; }
	public DateTime? ToDate { get ;  set; }
	public string Warehouse { get ;  set; }
}

c# Syntax

List<Response> SaveInventoryAdjustments( List<InventoryAdjustment> items);

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/InventoryAdjustments/Save

The SaveInventoryAdjustments method saves one or more Item adjustments. The list of Response objects contains any warnings or errors that occurred while updating the Items. The EntityId property of the Response object will be set to the ItemNo property of the InventoryAdjustment type. The InventoryAdjustment class, along with the descriptions of its properties, is shown below.

For the REST interface, the /InventoryAdjustments/Save REST call, the equivalent of the SaveInventoryAdjustments c# method, takes an array of InventoryAdjustment objects, serialized into JSON format, in the request, and returns an array of Response objects, in JSON format, in the response.

public class InventoryAdjustment
{
	

    public string ItemNo { get; se; }
    public string WarehouseName { get; set; }
    public string Bin { get; set; }
    public string Container { get; set; }
    public string LotNo { get;set; }
    public string CustOwner { get; set; }
    public string ItemUomName { get; set; }
    public long? ItemUnitQuantity { get; set; }
    public DateTime? ReceiveDate { get; set; }
    public string Reason { get; set; }
    public string SerialNo { get; set; }
    public string ItemStatus { get;set; }
    public string ItemDesc { get; set; }
    public decimal? Quantity { get; set; }
    public string Misc1 { get; set; }
    public string Misc2 { get; set; }
    public string Misc3 { get; set; }
    public string Misc4 { get; set; }
    public string AdjustAllocated { get; set; }	
	public string AdjustPlusOrMinus { get; set; }	
	public bool? IgnoreMisc1Check { get; set; }

}

c# Syntax

public class GetInventoryAdjustmentsRequest
{
	List<Response> SaveItems( List<Item>items);
}

c# Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServicesREST/Items/Save

The SaveItems method saves one or more new Items, or updates existing Items. The list of Response objects contains any warnings or errors that occurred while saving or updating the Items. The EntityId property of the Response object will be set to the ItemNo property of the Item type. The Item class, along with the descriptions of its properties, is shown below.

For the REST interface, the /Items/Save REST call, the equivalent of the SaveItems c# method, takes an array of Item objects, serialized into JSON format, in the request, and returns an array of Response objects, in JSON format, in the response.

public String Item
{
	public string ItemNo { get ;  set; }
	public string UpcNo { get ;  set; }
	public string ItemXRef { get ;  set; }
	public string ItemDesc { get ;  set; }
	public decimal? StockWgt { get ;  set; }
	public string  WeightUom { get ;  set; }
	public long? RopMin { get ;  set; }
	public long? OrderQty { get ;  set; }
	public string  StockUom { get ;  set; }
	public decimal? SalesPrice { get ;  set; }
	public decimal? VendCost { get ;  set; }
	public string  Comment { get ;  set; }
	public long ? QtyRequired { get ;  set; }
	public char? AbcCode { get ;  set; }
	public string Misc1 { get ;  set; }
	public string Misc2 { get ;  set; }
	public string Misc3 { get ;  set; }
	public string Misc4 { get ;  set; }
	public string Misc5 { get ;  set; }
	public string Misc6 { get ;  set; }
	public string Misc7 { get ;  set; }
	public string Misc8 { get ;  set; }
	public string SccCaseUpc { get ;  set; }
	public string PackUpc { get ;  set; }
	public string VendorId { get ;  set; }
	public string Vendor1Name { get ;  set; }
	public string Vendor1Country { get ;  set; }
	public string Vendor1City { get ;  set; }
	public string Vendor1Address2 { get ;  set; }
	public string Vendor1Address { get ;  set; }
	public string Vendor1State { get ;  set; }
	public string Vendor1Zip { get ;  set; }
	public string PrimeBinName { get ;  set; }
	public string PickBinName { get ;  set; }
	public string Vendor { get ;  set; }
	public string PrimeBin { get ;  set; }
	public string PickBin { get ;  set; }
	public string ContUom { get ;  set; }
	public string WarehouseName { get ;  set; }
	public string VendorId2 { get ;  set; }
	public string Vendor2Country { get ;  set; }
	public string Vendor2City { get ;  set; }
	public string Vendor2Address2 { get ;  set; }
	public string Vendor2Name { get ;  set; }
	public decimal? VendCost2 { get ;  set; }
	public string Vendor3Name { get ;  set; }
	public decimal? VendCost3 { get ;  set; }
	public string Vendor2Address { get ;  set; }
	public string Vendor2State { get ;  set; }
	public string Vendor2Zip { get ;  set; }
	public string VendorId3 { get ;  set; }
	public string Vendor3Country { get ;  set; }
	public string Vendor3Address2 { get ;  set; }
	public string Vendor4Name { get ;  set; }
	public decimal? VendCost4 { get ;  set; }
	public string Vendor3Address { get ;  set; }
	public string Vendor3State { get ;  set; }
	public string Vendor3Zip { get ;  set; }
	public string Vendor3City { get ;  set; }
	public string VendorId4 { get ;  set; }
	public string Vendor4Country { get ;  set; }
	public string Vendor4Address2 { get ;  set; }
	public string Vendor4Address { get ;  set; }
	public string Vendor4State { get ;  set; }
	public string Vendor4Zip { get ;  set; }
	public string Vendor4City { get ;  set; }
	public string CaseUpc { get ;  set; }
	public string ProductGrade { get ;  set; }
	public string CountryOrigin { get ;  set; }
	public string ProductCommodity{ get ;  set; }
	public string ProductVariety { get ;  set; }
	public string SuperItem { get ;  set; }
	public string ItemSubstitute { get ;  set; }
	public string ItemSubstituteName { get ;  set; }
	public string OwnerName { get ;  set; }
	public string ItemUomName { get ;  set; }
	public long? ItemUomQuantity { get ;  set; }
	public decimal? CaseSalesPrice { get ;  set; }
	public decimal? CaseWeight { get ;  set; }
	public decimal? CaseWeight { get ;  set; }
	public decimal? VendCaseCost { get ;  set; }
	public decimal? VendCaseCost2 { get ;  set; }
	public decimal? VendCaseCost3 { get ;  set; }
	public decimal? VendCaseCost4 { get ;  set; }
	public bool? DoubleBox { get ;  set; }
	public string  BoxID { get ;  set; }	 
	public bool? ProductSN { get ;  set; }
	public string Manufacture { get ;  set; }
	public string CubeID { get ;  set; }
   	public double? CubeHeight { get ;  set; }
	public double? CubeWidth { get ;  set; }
	public double? CubeLength { get ;  set; }
    public bool? IsTransparency { get ;  set; }
    public decimal? UnitCost { get ;  set; }
    public decimal? UnitSalesPrice { get ;  set; }
    public string Status { get ;  set; }
	public DateTime? LastCount { get ;  set; }
	public int? Recount { get ;  set; }
	public string RecountIntervalType { get ;  set; }
	public string RecvUOM { get ;  set; }
	public string ShipUOM { get ;  set; }
	public int? ConversionQty { get ;  set; }
	public bool? ViceVersa { get ;  set; }
	
}    
	

c# Syntax

	List<Response> SaveVendors( List<Vendor> vendors);

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/Vendors/Save

The SaveVendors method saves one or more new Vendors, or updates existing Vendors. The list of Response objects contains any warnings or errors that occurred while saving or updating the Vendors. The EntityId property of the Response object will be set to the VendorId property of the Vendor type. The Vendor class, along with the descriptions of its properties, is shown below.

For the REST interface, the /Vendors/Save REST call, the equivalent of the SaveVendors c# method, takes an array of Vendor objects, serialized to JSON, in the request, and returns an array of Response objects, in JSON format, in the response.

public class Vendor
{
	public string VendorId { get ;  set; }
	public string Company { get ;  set; }
	public string Contact { get ;  set; }
	public string Phone { get ;  set; }
	public string Fax { get ;  set; }
	public string Email { get ;  set; }
	public string Address { get ;  set; }
	public string Address2 { get ;  set; }
	public string City { get ;  set; }
	public string State { get ;  set; }
	public string ZipCode { get ;  set; }
	public string Country { get ;  set; }
	public string Misc1 { get ;  set; }
	public string Misc2 { get ;  set; }
}

c# Syntax

	List<Response> SaveCustomerBillTos( List<CustomerBillTo> CustomerBillTos);

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/Customers/BillTo/Save

The SaveCustomerBillTos method saves one or more new Customer BillTo’s, or updates existing Csutomer BillTo’s. The list of Response objects contains any warnings or errors that occurred while saving or updating the CustomerBillTo’s. The EntityId property of the Response object will be set to the CustomerId property of the CustomerBillTo type. The CustomerBillTo class, along with the descriptions of its properties, is shown below.

For the REST interface, the /Customers/BillTo/Save REST call, the equivalent of the SaveCustomerBillTos c# method, takes an array of CustomerBillTo objects, serialized to JSON, in the request, and returns an array of Response objects, in JSON format, in the response.

public class CustomerBillTo
{
	public string CustomerId { get ;  set; }
	public string Company { get ;  set; }
	public string Contact { get ;  set; }
	public string Phone { get ;  set; }
	public string Fax { get ;  set; }
	public string Email { get ;  set; }
	public string Address { get ;  set; }
	public string Address2 { get ;  set; }
	public string Address3 { get ;  set; }
	public string City { get ;  set; }
	public string State { get ;  set; }
	public string ZipCode { get ;  set; }
	public string Country { get ;  set; }
	public string Misc1 { get ;  set; }
	public string Misc2 { get ;  set; }
	public string UpsAccountNumber { get ;  set; }
	public string UspsAccountNumber { get ;  set; }
	public string FedexAccountNumber { get ;  set; }
	public string SpeeDeeAccountNumber { get ;  set; }
}

c# Syntax

	List<Response> SaveCustomerShipTos( List<CustomerShipTo> customerShipTos);

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/Customers/ShipTo/Save

The SaveCustomerShipTos method saves one or more new Customer ShipTo’s, or updates existing Customer ShipTo’s. The list of Response objects contains any warnings or errors that occurred while saving or updating the CustomerShipTo’s. The EntityId property of the Response object will be set to the CustomerId property of the CustomerShipTo type. The CustomerShipTo class, along with the descriptions of its properties, is shown below.

For the REST interface, the /Customers/ShipTo/Save REST call, the equivalent of the SaveCustomerShipTos c# method, takes an array of CustomerShipTo objects, serialized to JSON, in the request, and returns an array of Response objects, in JSON format, in the response.

public class CustomerShipTo
{
	public string CustomerId { get ;  set; }
	public string Company { get ;  set; }
	public string Contact { get ;  set; }
	public string Phone { get ;  set; }
	public string Fax { get ;  set; }
	public string Email { get ;  set; }
	public string Address { get ;  set; }
	public string Address2 { get ;  set; }
	public string Address3 { get ;  set; }
	public string City { get ;  set; }
	public string State { get ;  set; }
	public string ZipCode { get ;  set; }
	public string Country { get ;  set; }
	public string Misc1 { get ;  set; }
	public string Misc2 { get ;  set; }
	public string UpsAccountNumber { get ;  set; }
	public string UspsAccountNumber { get ;  set; }
	public string FedexAccountNumber { get ;  set; }
	public string SpeeDeeAccountNumber { get ;  set; }
	public string BillToId { get ;  set; }
	public string BillToName { get ;  set; }
}

c# Syntax

	List<Response> SaveCustomerMarkTos( List<CustomerMarkTo> customerMarkTos);

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/Customers/MarkTo/Save

The SaveCustomerMarkTos method saves one or more new Customer MarkTo’s, or updates existing Customer MarkTo’s. The list of Response objects contains any warnings or errors that occurred while saving or updating the Customer MarkTo’s. The EntityId property of the Response object will be set to the CustomerId property of the CustomerMarkTo type. The CustomerMarkTo class, along with the descriptions of its properties, is shown below.

For the REST interface, the /Customers/MarkTo/Save REST call, the equivalent of the SaveCustomerMarkTo c# method, takes an array of CustomerMarkTo objects, serialized to JSON, in the request, and returns an array of Response objects, in JSON format, in the response.

public class CustomerMarkTo
{
	public string CustomerId { get ;  set; }
	public string Company { get ;  set; }
	public string Contact { get ;  set; }
	public string Phone { get ;  set; }
	public string Fax { get ;  set; }
	public string Email { get ;  set; }
	public string Address { get ;  set; }
	public string Address2 { get ;  set; }
	public string Address3 { get ;  set; }
	public string City { get ;  set; }
	public string State { get ;  set; }
	public string ZipCode { get ;  set; }
	public string Country { get ;  set; }
	public string Misc1 { get ;  set; }
	public string Misc2 { get ;  set; }
	public string UpsAccountNumber { get ;  set; }
	public string UspsAccountNumber { get ;  set; }
	public string FedexAccountNumber { get ;  set; }
	public string SpeeDeeAccountNumber { get ;  set; }
	public string BillToId { get ;  set; }
	public string BillToName { get ;  set; }
}

c# Syntax

List<ResponseDto> SaveInvERP( List<InvERPDto> invERPs);
List<ResponseDto> LiveInventoryImport( List<InvERPDto> invERPs);

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/InventoryERP/Save

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/InventoryERP/LiveInventoryImport

The SaveInvERP method saves one or more new ERP Inventories without any update instead it will delete all previous ERP Inventory first. The list of Response objects contains any warnings or errors that occurred while saving or deleting the new or old ERP Inventory. The InvERPDto class, along with the descriptions of its properties, is shown below.

For the REST interface, the /InventoryERP/Save REST call, the equivalent of the SaveInvERP c# method, takes an array of InvERPDto objects, serialized to JSON, in the request, and returns an array of Response objects, in JSON format, in the response.

The LiveInventoryImport method, inports the inventory lines based on the parameters sent as request.

public class InvERPDto
{	
	public string Warehouse { get ;  set; }
	
	public string Location { get ;  set; }
	
	public string ItemNo { get ;  set; }
	
	public string ItemDesc { get ;  set; }
	
	public string UOM { get ;  set; }
	
	public string EachCount { get ;  set; }
	
	public string Qty { get ;  set; }
    
	public string ReceiveDate { get ;  set; }
   
	public string Misc1 { get ;  set; }
	
	public string Misc2 { get ;  set; }

	public string Misc3 { get ;  set; }
	
	public string Misc4 { get ;  set; }
	
	public string SerialNo { get ;  set; }
}

c# Syntax

	List<ResponseDto> SaveShipOrders( List<ShipOrder> ShipOrder);
	
	List<ShipOrder> GetShipOrders( DateTime? fromDate, DateTime? toDate, bool qtyEaches, string warehouse);
	
	List<ShipOrderDto> GetShipOrdersForSoNo( string soNo,bool qtyEaches, string warehouse);

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/ShipOrders/Save

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/ShipOrders

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/ShipOrders/SoNo

The SaveShipOrders method saves one or more new Ship Orders with their details, or updates existing Ship Orders and their details. The ShipOrder class contains the properties for the Ship Order header, and a list of the order details, each being a ShipOrderDetail t ype. The list of Response objects contains any warnings or errors that occurred while saving or updating the Ship Orders. The EntityId property of the Response object will be set to the SoNo property of the ShipOrder type. The ShipOrder and ShipOrderDetail classes, along with the descriptions of their properties, are shown below.

The GetShipOrders method returns a list of Ship Orders that have been closed, but not yet exported. A From Date and To Date can be specified to retrieve a list of Ship Orders within a particular date range. Date range is not required, when left blank all orders that have been shipped where ship qty > export qty will be returned, unless you want a specific range of orders leaving the date fields blank is the best approach.

Also, the order and shipped quantities returned can be returned in Eaches if the qtyEaches parameter is set to true, otherwise, if set to false, it will return order and shipped quantities using UOM quantities. The quantities affected by the qtyEaches parameter are the OrderQty and ShippedQty properties. After the Ship Orders are retrieved, the Ship Order details are marked as being exported by setting the Exported quantity to the Pick quantity. The GetShipOrdersForSoNo is the same as the GetShipOrders method, but retrieves any Ship Orders based on the SoNo of the ship order. Also, there are no date range parameters to the method.

For the REST interface, the /ShipOrders/Save REST call, the equivalent of the SaveShipOrders c# method, expects an array of ShipOrder objects, serialized to JSON, in the request, and returns an array of Response objects, in JSON format, in the response to the REST API call. The /ShipOrders REST call, the equivalent of the GetShipOrders c# method, takes a GetShipOrdersRequest object, serialized to JSON, in the request, and returns an array of ShipOrder objects, in JSON format. The /ShipOrders/SoNo REST call, the equivalent of the GetShipOrdersForSoNo c# method, takes a GetShipOrdersForSoNoRequest object, serialized to JSON, in the request, and returns an array of ShipOrder objects, in JSON format.

public class ShipOrder
{
        public string SoNo { get ;  set; }
        public string ShipInstructions { get ;  set; }
        public string Status { get ;  set; }
        public string ShipWarehouseName { get ;  set; }
        public string ShipMode { get ;  set; }
        public string Email { get ;  set; }
        Public string CustOwnerName { get ;  set; }
	    
        public string OrderDate { get ;  set; }
        public string ShipDate { get ;  set; }
        public string DelivDate { get ;  set; }            
	    public string Address3 { get ;  set; }
	    public string City { get ;  set; }
	    public string ProNo { get ;  set; }
	    public string TrailerNo { get ;  set; }
	    public string CustPo { get ;  set; }
	    public string BolNo { get ;  set; }
	    public string SealNo { get ;  set; }
	    public string InvoiceNo { get ;  set; }
	    public string ProjectNo { get ;  set; }
	    public string ShipMethod { get ;  set; }
	    public string CBol { get ;  set; }
	    public string ShipToId { get ;  set; }
	    public string ShipToName { get ;  set; }
	    public string ShipToAddress { get ;  set; }
	    public string ShipToAddress2 { get ;  set; }
	    public string ShipToCity { get ;  set; }
	    public string ShipToState { get ;  set; }
	    public string ShipToZipCode { get ;  set; }
	    public string ShipToCountry { get ;  set; }
	    public string ShipToPhone { get ;  set; }
	    public string ShipToFax { get ;  set; }
	    public string ShipToContact { get ;  set; }
	    public string ShipToEmail { get ;  set; }
	    public string MarkToId { get ;  set; }
	    public string MarkToName { get ;  set; }
	    public string MarkToAddress { get ;  set; }
	    public string MarkToAddress2 { get ;  set; }
	    public string MarkToCity { get ;  set; }
	    public string MarkToState { get ;  set; }
	    public string MarkToZipCode { get ;  set; }
	    public string MarkToCountry { get ;  set; }
	    public string MarkToPhone { get ;  set; }
	    public string MarkToFax { get ;  set; }
	    public string MarkToContact { get ;  set; }
	    public string MarkToEmail { get ;  set; }
	    public string BillToId { get ;  set; }
	    public string BillToName { get ;  set; }
	    public string MarkToPhone { get ;  set; }
	    public string BillToAddress { get ;  set; }
	    public string BillToAddress2 { get ;  set; }
	    public string BillToCity { get ;  set; }
	    public string BillToState { get ;  set; }
	    public string BillToZipCode { get ;  set; }
	    public string BillToCountry { get ;  set; }
	    public string BillToPhone { get ;  set; }
	    public string BillToFax { get ;  set; }
	    public string BillToContact { get ;  set; }
	    public string BillToEmail { get ;  set; }
	    public double? LoadSeq { get ;  set; }
	    public bool? Transfer  { get ;  set; }
	    public string CustOwnerId { get ;  set; }
	    public string CaseWeight { get ;  set; }
	    public decimal? CaseWeight { get ;  set; }
	    public decimal? CaseSalesPrice { get ;  set; }
	    public List<ShipOrderDetail> ShipOrderDetails { get ;  set; }
        public string Misc1 { get ;  set; }
        public string Misc2 { get ;  set; }
        public string Misc3 { get ;  set; }
        public string Misc4 { get ;  set; }
        public string Misc5 { get ;  set; }
        public string Misc6 { get ;  set; }
        public string Misc7 { get ;  set; }
        public string Misc8 { get ;  set; }
        public string Ecommerce { get; set; }	  
        public string Document { get ;  set; }
        public string TrackingNo { get ;  set; }
        public bool? ShipLTL { get ;  set; }
        public bool? IgnoreImportLock { get ;  set; }
        public bool? Signature { get ;  set; }
        public decimal? TaxRate { get ;  set; }
        public decimal? HandlingCharges { get ;  set; }
        public string WaveNo { get ;  set; }
        public bool? DropShip { get ;  set; }
		public stringPackageType { get ;  set; }
		public bool?SaturdayDelivery { get ;  set; }
		public string PickType { get ;  set; }
		public string PackStageLocation { get ;  set; }
}

public class ShipOrderDetail
{
	public int? SoLine  { get ;  set; }
	public string ItemNo { get ;  set; }
	public string LotNo { get ;  set; }
	public string SerialNo { get ;  set; }
	public decimal? OrderQty { get ;  set; }
	public decimal? PickQty { get ;  set; }
	public decimal? ShippedQty { get ;  set; }
	public string DispMsg { get ;  set; }
	public string Misc1 { get ;  set; }
	public string Misc2 { get ;  set; }
	public string Misc3 { get ;  set; }
	public string Misc4 { get ;  set; }
	public string Misc5 { get ;  set; }
	public string Misc6 { get ;  set; }
	public string Misc7 { get ;  set; }
	public string Misc8 { get ;  set; }
	  
    public string PickDate { get ;  set; }
	public decimal? AllocatedQty { get ;  set; }
	public decimal? PackedQty { get ;  set; }
	public decimal? RecvQty { get ;  set; }
	public string ItemUomName { get ;  set; }
	public string VendorId { get ;  set; }
	public string VendorIdName { get ;  set; }
	public string VendorIdAddress { get ;  set; }
	public string VendorIdAddress2 { get ;  set; }
	public string VendorIdCity { get ;  set; }
	public string VendorIdState { get ;  set; }
	public string VendorIdZip { get ;  set; }
	public string VendorIdCountry { get ;  set; }
	public string ContainerName { get ;  set; }
	public long? ItemUnitQuantity  { get ;  set; }
	public string ItemDesc { get ;  set; }
	public long? CaseSalesPrice { get ;  set; }
	public decimal? CaseWeight { get ;  set; }
	public string BoxID { get ;  set; }
    public string TransparencyNum { get ;  set; }
	public string Location { get ;  set; }
	public decimal? UnitSalesPrice { get ;  set; }
    public decimal? UnitCost { get ;  set; }
	public bool? CrossDock { get ;  set; }
}

public class GetShipOrdersRequest
{
	public DateTime? FromDate { get ;  set; }
	public DateTime? ToDate { get ;  set; }
	public bool QtyEaches { get ;  set; }
	public string Warehouse  { get ;  set; }
    public string StringFromDate  { get ;  set; }
    public string StringToDate  { get ;  set; }
}

public class GetShipOrdersForSoNoRequest
{
	public String SoNo { get ;  set; }
	public bool? QtyEaches { get ;  set; }
	public string Warehouse  { get ;  set; }
	public DateTime? FromDate { get ;  set; }
}

c# Syntax

ResponseDto GenWaves(WaveDto Wave );

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/GenWaves

The GenWaves method, picking multiple order on Wave. The list of Response objects contains any warnings or errors that occurred while saving the new Wave. The GenWaves class, along with the descriptions of its properties, is shown below.

The GenWaves method, imports the picking order based on the parameters sent as request.

public class WaveDto
{	
	public string Warehouse { get ;  set; }
	
	public string FromOrder { get ;  set; }
	
	public string ToOrder { get ;  set; }
	
	public DateTime FromShipDate { get ;  set; }
	
	public DateTime ToShipDate { get ;  set; }
	
	public string OrderStatus { get ;  set; }
    
	public int FromLineCount { get ;  set; }
   
	public int ToLineCount { get ;  set; }
	
	public int FromPieceCount { get ;  set; }

	public int ToPieceCount { get ;  set; }
	
	public string Carrier { get ;  set; }
	
	public string CarrierMethod { get ;  set; }
	
	public bool ProductSN { get ;  set; }
	
	public bool Doublebox { get ;  set; }
	
	public bool NoBox { get ;  set; }
	
	public string ItemNo { get ;  set; }
	
	public string Ecommerce { get ;  set; }
	
	public int NoOfOrderOnWave { get ;  set; }
}

c# Syntax

[Serializable]
public classGetInventoryRequest
{
        public  DateTime? FromDate { get ;  set; }
        public  DateTime? ToDate { get ;  set; }
        public bool QtyEaches { get ;  set; }  
        public string Warehouse { get ;  set; } 
        public string CustOwner { get ; set; }  
}

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServicesREST/GetInventory

The GetInventory method exports available inventory as per given dates range. The list of Inventory objects contains all exported data details. The Inventory class, along with the descriptions of its properties, is shown below. For the REST interface, the GetInventory REST call, the equivalent of the GetInventory c# method, takes from date, to date, qty in eaches and warehouse parameters, serialized into JSON format, in the request, and returns an array of Inventory objects, in JSON format.

[DataContract(
        Name = "Inventory",
        Namespace = "http://wms.northstar-automation.com/NorthstarWmsIntegration/DTO/2015/03")]

public class Inventory
{	
  public string  Warehouse { get ;  set; }  
  public string  Location { get ;  set; }  
  public string  LocationTypes { get ;  set; }  
  public string  BinType { get ;  set; }  
  public string  ItemNo { get ;  set; }  
  public string  UpcNo { get ;  set; }  
  public string  ItemDesc { get ;  set; }  
  public decimal ? Quantity { get ;  set; }  
  public decimal ? StockWeight { get ;  set; }  
  public string  ItemUomName { get ;  set; }  
  public long? ItemUnitQuantity { get ;  set; }  
  public string  RopMin { get ;  set; }  
  public string  CustOwnerName { get ;  set; }  
  public string  CustOwnerName{ get ;  set; }
  public long? RopMin { get ;  set; }   
  public decimal? SalesPrice { get ;  set; }  
  public decimal? UnitCost { get ;  set; }  
  public string  Container { get ;  set; }  
  public string  LotNo { get ;  set; }    
  public DateTime? ReceiveDate { get ;  set; }  
  public string  SerialNo { get ;  set; }  
  public string  Allocated Order# { get ;  set; }  
  public string  Misc1 { get ;  set; }  
  public string  Misc2 { get ;  set; }  
  public string  Misc3 { get ;  set; }  
  public string  Misc4 { get ;  set; }  
  public string  Misc5 { get ;  set; }  
  public string  Misc6 { get ;  set; }  
  public string  Misc7 { get ;  set; }  
  public string  Misc8 { get ;  set; }    
  public string  AllocatedSO { get ;  set; }    
}

c# Syntax

publicList<Inventory> GetInventoryByItemNo( string itemNo,  string warehouse = "", string bin = "", string misc1 = "")
{	
	var getInvsRequestByItemNo = new GetInventoryRequestByItemNo
	{
        ItemNo = itemNo;
		Warehouse = warehouse;
        Bin = bin;
        Misc1 = misc1;
	};
	var requestData = SerializeToJson(getInvsRequest);
	var request = string.Format("{0}/GetInventoryByItemNo", RestServiceAddress);
	var response = ExecuteTwoWayRequest <Inventory[]>(request, HttpMethod.Post, requestData);
	return response.ToList();
}
[Serializable]
public classGetInventoryRequestByItemNo
{
  public  string ItemNo { get ;  set; }
  public  string Warehouse { get ;  set; }
  public string Bin { get ;  set; }  
  public string Misc1 { get ;  set; }  
}

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServicesREST/GetInventoryByItemNo

The GetInventoryByItemNo method exports available inventory as per given parameters. The list of Inventory objects contains all exported data details. The Inventory class, along with the descriptions of its properties, is shown below. For the REST interface, the GetInventoryByItemNo REST call, the equivalent of the GetInventoryByItemNo c# method, takes ItemNo, Warehouse, Bin and Misc1 parameters, serialized into JSON format, in the request, and returns an array of Inventory objects, in JSON format.

[DataContract(
        Name = "Inventory",
        Namespace = "http://wms.northstar-automation.com/NorthstarWmsIntegration/DTO/2015/03")]

public class Inventory
{	
    public string  Warehouse { get ;  set; }  
    public string  Location { get ;  set; }  
    public string  LocationTypes { get ;  set; }  
    public string  BinType { get ;  set; }  
    public string  ItemNo { get ;  set; }    
    public string  ItemDesc { get ;  set; }  
    public decimal ? Quantity { get ;  set; }    
    public string  ItemUomName { get ;  set; }  
    public long? ItemUnitQuantity { get ;  set; }  
    public string  CustOwnerName { get ;  set; }
    public string  RopMin { get ;  set; }  
    public decimal? SalesPrice { get ;  set; }  
    public string  Container { get ;  set; }  
    public string  LotNo { get ;  set; }    
    public DateTime? ReceiveDate { get ;  set; }  
    public string  SerialNo { get ;  set; }  
    public string  Misc1 { get ;  set; }  
    public string  Misc2 { get ;  set; }  
    public string  Misc3 { get ;  set; }  
    public string  Misc4 { get ;  set; }     
}

c# Syntax

public void btnImportKits_Click ( object, sender, EventArgse);
{	
	var items = new List<Kit>();
	var item1 = new Kit();
	 {
                KitItemNo = "Kit011519_02", /// this is a kit
                KitItemDescription = "The Kit desc",  /// this is a kit desc
                KitUOM = "Dozen",  /// this is a kit uom primary setup
                KitEachCount = 2, /// this is a kit uom qty primary setup
                LotNo = "LT-new",  /// created lot under kit tab
                KitYield = 2.45M, /// yield under kit tab
                MixInstruction = "mix ins",
                PackingInstruction = "pack ins",
                BakersInstruction = "handle ins",
 
                KitCost = 2.10M,  /// not showing on screen, kitunitcost is in kit table
                KitDescription = "kit desc under kit table",  //not showing on screen, is in kit table
            };
				var items = new List<KitItems>();
			var kitDetail1  = new KitItems();
	            {
	                ItemNo = "Kit012219_00",
	                ItemDescription = "kit first sub comp",
	                KitItemEachCount = 3,
	                KitItemUOM = "Pall",
	                BakersPercentage = 3.01M,
	                ProdPercent = .023M,
	                KitQty = 2,
	            };
	            item1.KitItems.Add(kitDetail1);
	            var kitDetail2 = new KitItems
	            {
	                ItemNo = "Kit012219_01",
	                ItemDescription = "kit second sub comp",
	                KitItemEachCount = 4,
	                KitItemUOM = "Case",
	                BakersPercentage = 5.01M,
	                ProdPercent = .05M,
	                KitQty = 6,
	            };
	            item1.KitItems.Add(kitDetail2);
	            items.Add(item1);
	            
	            var response = ServiceMethods.SaveKits(items);
	            if (response == null) return;
	 
	            ShowResults(response, "Kit");
	        }

	Service Method:

	public List<Response> SaveKits(List<Kit> kits)
	        {
	            var requestData = SerializeToJson(kits.ToArray());
	            var request = string.Format("{0}/Kits/Save", RestServiceAddress);
	            var response = ExecuteTwoWayRequest<Response[]>(request, HttpMethod.Post, requestData);
	            return response.ToList();
	        }

	Classes: 

	 [DataContract(
	         Name = "Kit",
	         Namespace = "http://wms.northstar-automation.com/NorthstarWmsIntegration/DTO/2015/03")]
	    public class Kit
	    {
	        private List<KitItems> _KitItems;
	 
	        [DataMember(Name = "KitItemNo", IsRequired = true, Order = 0)]
	        public string KitItemNo { get; set; }
	 
	        [DataMember((Name = "KitItemDescription", IsRequired = true, Order = 1)]
	        public string( KitItemDescription { get; set; }
	 
	        [DataMember(Name = "KitItems", IsRequired = true, Order = 2)]
	        public List<KitItems> KitItems
	        {
	            get { return _KitItems ?? (_KitItems = new List<KitItems>()); }
	            set { _KitItems = value; }
	        }
	 
	        [DataMember(Name = "KitUOM", IsRequired = false, Order = 3)]
	        public string KitUOM { get; set; }
	 
	        [DataMember(Name = "KitEachCount", IsRequired = false, Order = 4)]
	        public long? KitEachCount { get; set; }
	 
	        [DataMember(Name = "BakersInstruction", IsRequired = false, Order = 5)]
	        public string BakersInstruction { get; set; }
	 
	        [DataMember(Name = "KitYield", IsRequired = false, Order = 6)]
	        public decimal? KitYield { get; set; }
	 
	        [DataMember(Name = "MixInstruction", IsRequired = false, Order = 7)]
	        public string MixInstruction { get; set; }
	 
	        [DataMember(Name = "PackingInstruction", IsRequired = false, Order = 8)]
	        public string PackingInstruction { get; set; }
	 
	        [DataMember(Name = "LotNo", IsRequired = false, Order = 9)]
	        public string LotNo { get; set; }
	 
	        [DataMember(Name = "KitCost", IsRequired = false, Order = 10)]
	        public decimal? KitCost { get; set; }
	 
	        [DataMember(Name = "KitDescription", IsRequired = false, Order = 11)]
	        public string KitDescription { get; set; }
	    }
	 
	    [DataContract(
	        Name = "KitItems",
	        Namespace = "http://wms.northstar-automation.com/NorthstarWmsIntegration/DTO/2015/03")]
	     public class KitItems
	    {
	        public long SoId { get; set; }
	 
	        [DataMember(Name = "ItemNo", IsRequired =  true, Order = 0)]
	        public string ItemNo { get; set; }
	 
	        [DataMember(Name = "ItemDescription", IsRequired =  true, Order = 1)]
	        public string ItemDescription { get; set; }
	 
	        [DataMember(Name = "KitItemEachCount", IsRequired =  true, Order = 2)]
	        public long? KitItemEachCount { get; set; }
	 
	        [DataMember(Name = "KitItemUOM", IsRequired =  true, Order = 3)]
	        public string KitItemUOM { get; set; }
	 
	        [DataMember(Name = "KitQty", IsRequired =  true, Order = 4)]
	        public decimal? KitQty { get; set; }
	 
	        [DataMember(Name = "BakersPercentage", IsRequired =  false, Order = 5)]
	        public decimal? BakersPercentage { get; set; }
	 
	        [DataMember(Name = "ProdPercent", IsRequired =  false, Order = 6)]
	        public decimal? ProdPercent { get; set; }
	    
}

c# Syntax

		Response SaveItemImage(ItemImage itemImage)		

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/Items/Image/Save

The SaveItemImage method saves an image for a given Item. Both the c# and REST interfaces take an ItemImage class and is detailed below. Both return a Response object containing any warnings or errors that occurred while saving the image. The Image property of the SaveItemImage class takes an array of byte data. The binary data of the image file can be set using the following code. It is assumed that the imageFileName variable in the code below has already been set to the full path and file name of the image to be saved, perhaps by using the File Open dialog box control.

				
				const string itemNo = "TEST ITEM 10001";
				const int imageNo = 1;
				const string itemFilename = "TestItem10001Image.jpg";

				var fileStream = new FileStream(imageFilename, FileMode.Open, FileAccess.Read); 
				var binaryReader = new BinaryReader(fileStream);												
				var totalBytes = new FileInfo(imageFilename).Length;
				var image = binaryReader.ReadBytes((int) totalBytes);
				fileStream.Close();
				fileStream.Dispose();
				binaryReader.Close();

				var itemImage = new ItemImage
				{
				ItemNo = itemNo,
				ImageNo = imageNo,
				FileName = itemFilename,
				Image = image
				};
				Below is the description of the ItemImage class.


				public class ItemImage
				{
				public string ItemNo { get; set; }
				public int ImageNo { get; set; }
				public string FileName { get; set; }
				public byte[] Image { get; set; }
				}

Calling demo code

var data = newList<DeleteShipOrder>();
	var order  = newDeleteShipOrder
		{
			SoNo = "API_test",
			ShipWarehouseName = "17FR",
			DeleteOrder = true,// if true, the entire order would deleted including every line and other dependencies, otherwise only lines that have ‘Picked Qty’ less than or equal to 0 would be delete. Will not delete lines that have been picked.
            ReturnInv = true,// if true, the picked Inventory will be added back to Its original location from it was last picked.
		};
		var details = new List<DeleteShipOrderDetail>();
		/// as per current implemented logic, line/s is/are not required to be passed 
		
		 order.DeleteShipOrderDetails = details;
		 
		 data.Add(order);
		 
		  var  response = ServiceMethods.DeleteShipOrders(data);
		 

Calling signature

					public List<Response>DeleteShipOrders(ListdeleteShipOrders)
					{
						var requestData = SerializeToJson(deleteShipOrders.ToArray());
						var request = string.Format("{0}/ShipOrders/Delete", RestServiceAddress);
						var response = ExecuteTwoWayRequest <Response[]>(request, HttpMethod.Post, requestData);
						return response.ToList();
					}
				

Classes

					[DataContract(
						Name = "DeleteShipOrder",
						Namespace = "http://wms.northstar-automation.com/NorthstarWmsIntegration/DTO/2015/03")]
						public class DeleteShipOrder
						{
							[DataMember(Name = "SoNo", IsRequired = true, Order = 0)]
							
							public string SoNo{ get;  set; }
							
							
							[DataMember(Name = "ShipWarehouseName", IsRequired = true, Order = 1)]
							
							public string ShipWarehouseName{ get;  set; }
							
							
							[DataMember(Name = "DeleteOrder", IsRequired = true, Order = 2)]
							
							public bool  DeleteOrder{ get;  set; }
							
							
							[DataMember(Name = "DeleteShipOrderDetail", IsRequired = true, Order = 3)]
							
							public List<DeleteShipOrderDetails>{ get;  set; }						
							
							
						}
						
							[DataContract(
							Name = "DeleteShipOrderDetail",
							Namespace = "http://wms.northstar-automation.com/NorthstarWmsIntegration/DTO/2015/03")]
							public class DeleteShipOrderDetail
							
							{
							
								[DataMember(Name = "SoLine", IsRequired = true, Order = 0)]
							
								 public int? SoLine { get;  set; }

								
								[DataMember(Name = "ItemNo", IsRequired = true, Order = 1)]
							
								 public string ItemNo { get;  set; }								
							
								
								[DataMember(Name = "ItemUomName", IsRequired = true, Order = 1)]
							
								 public string ItemUomName { get;  set; }
																
								
								[DataMember(Name = "ContainerName", IsRequired = true, Order = 1)]
							
								 public string ContainerName { get;  set; }
																
								
								[DataMember(Name = "SoNo", IsRequired = true, Order = 1)]
							
								 public string SoNo { get;  set; }
							}
					

Calling demo code

var data = newList<DeletePurchaseOrder>();
	var order  = newDeletePurchaseOrder
		{
			PoNo  = "API_test",
			WarehouseName  = "17FR",
			DeleteOrder  = true,// if true, entire order would delete including every line and other dependencies if status is Closed or Open, otherwise only lines which have ‘Received Qty’ less than or equal to 0 will be deleted.
            DeleteAll = true,// if true, entire order would delete including every line and other dependencies Regardless of the Sataus and Recv Qty.
		};
		var details = new List<DeletePurchaseOrderDetail>();
		/// as per current implemented logic, line/s is/are not required to be passed
		
		 order.DeletePurchaseOrderDetails = details;
		 
		data.Add(order);
		 
		  var  response = ServiceMethods.DeletePurchaseOrders(data);
		 

Calling signature

					public List<Response>DeleteShipOrders(ListdeleteShipOrders)
					{
						var requestData = SerializeToJson(deleteShipOrders.ToArray());
						var request = string.Format("{0}/ShipOrders/Delete", RestServiceAddress);
						var response = ExecuteTwoWayRequest <Response[]>(request, HttpMethod.Post, requestData);
						return response.ToList();
					}
					
					public List<Response>DeletePurchaseOrders(ListDeletePurchaseOrders)
					{
						var requestData = SerializeToJson(DeletePurchaseOrders.ToArray());
						var request = string.Format("{0}/PurchaseOrders/Delete", RestServiceAddress);
						var response = ExecuteTwoWayRequest <Response[]>(request, HttpMethod.Post, requestData);
						return response.ToList();
					}
				

Classes

					[DataContract(
						Name = "DeletePurchaseOrder",
						Namespace = "http://wms.northstar-automation.com/NorthstarWmsIntegration/DTO/2015/03")]
						public class DeletePurchaseOrder
						{
							
							[DataMember(Name = "WarehouseName", IsRequired = true, Order = 0)]
							
							 public string  WarehouseName { get;  set; }
							
							
							[DataMember(Name = "PoNo", IsRequired = true, Order = 1)]
							
							 public string PoNo { get;  set; }								
							
							
							[DataMember(Name = "DeleteOrder", IsRequired = true, Order = 1)]
							
							 public string DeleteOrder { get;  set; }
															
							
							[DataMember(Name = "DeletePurchaseOrderDetail", IsRequired = true, Order = 1)]
							
							 public string DeletePurchaseOrderDetail { get;  set; }
							
							
							public List<DeletePurchaseOrderDetail > DeletePurchaseOrderDetails  { get;  set; }
							
							
							[DataContract(
							Name = "DeletePurchaseOrderDetail",
							Namespace = "http://wms.northstar-automation.com/NorthstarWmsIntegration/DTO/2015/03")]
							public class DeletePurchaseOrderDetail
							
							{
							
								[DataMember(Name = "PoLine", IsRequired = true, Order = 0)]
							
								 public int? PoLine { get;  set; }

								
								[DataMember(Name = "ItemNo", IsRequired = true, Order = 1)]
							
								 public string ItemNo { get;  set; }								
							
								
								[DataMember(Name = "ItemUomName", IsRequired = true, Order = 1)]
							
								 public string ItemUomName { get;  set; }
																
								
								[DataMember(Name = "LotNo", IsRequired = true, Order = 1)]
							
								 public string LotNo { get;  set; }
																
								
								[DataMember(Name = "PoNo", IsRequired = true, Order = 1)]
							
								 public string PoNo { get;  set; }
							}
						}
					

Calling demo code

var data = newList<DeleteItem>();
	var erp   = newDeleteItem
		{
			ItemNo  = "API_test",
			
		};
			data.Add(erp);
			
		  var  ServiceMethods.DeleteItems(data);
		 

Calling signature

					public List<Response>DeleteItems(List<DeleteItem>deleteItems)
					{
						var requestData = SerializeToJson(deleteItems.ToArray());
						var request = string.Format("{0}/Items/Delete", RestServiceAddress);
						var response = ExecuteTwoWayRequest <Response[]>(request, HttpMethod.Post, requestData);
						return response.ToList();
					}
					
					
				

Classes

					[DataContract(
						Name = "DeleteItem",
						Namespace = "http://wms.northstar-automation.com/NorthstarWmsIntegration/DTO/2015/03")]
						public class DeleteItem
						{
							
							[DataMember(Name = "ItemNo", IsRequired = true, Order = 0)]
							
							 public string  ItemNo { get;  set; }
						}
					
				

c# Syntax

	public List<Response> SaveCubes(List<CubeMasterdto> cube)
				{
					return NorthstarWmsIntegrationImpl.SaveCubes(cube);
				} 

REST syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/Cubes/Save

		
	 public  class CubeMasterdto
	{
		 public string CubeId {  get;  set; }
		 public string CubeDesc { get;  set; }
		 public bool? LocationType { get;  set;}
		 public bool? ContainerPalletType {  get;  set; }
		 public bool? ItemType { get;  set;}
		 public bool? BoxType { get;  set;}
		 public bool? CubeByVolume { get;  set;}
		 public bool? CubeByEaches { get;  set;}
		 public bool? CubeByWeight { get;  set;}
		 public double? Length {  get;  set;}
		 public double? Width {  get;  set; }
		 public double? Height {  get;  set; }
		public string UOMEaches { get;  set; }
		public double? Weight {  get;  set; }
	}

c# Syntax

	
	
	List<ASNInfo> GetASN( GetASNRequest request);	

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/ASN

The GetASN method return ASN details.

The GetASN method returns a list of Ship Orders that have been shipped QTy greater than Exported Qty. All orders that have been shipped where ship qty > export qty will be returned.

For the REST interface, the /ASN REST call, the equivalent of the GetASN c# method, expects an GetASNRequest object, serializable to JSON, in the request, and returns an array of ASNInfo objects, in JSON format, in the response to the REST API call.

public class ASNInfo
{
    public string WhouseName { get ;  set; }
    public string OrderNumber { get ;  set; }
    public string ItemNumber { get ;  set; }
    public string LineNo { get ;  set; }
    public int ActualQty { get ;  set; }
    public string CustomerName { get ;  set; }
    public string ShipToID { get ;  set; }
    public string ShipToName { get ;  set; }
    public string OrderDate { get ;  set; }
    public decimal? ShippingCharges { get ;  set; }
    public string TrackingNo { get ;  set; }
    public string Carrier { get ;  set; }
    public string BoxSSCCNo { get ;  set; }
    public int BoxNo { get ;  set; }
    public string PalletNo { get ;  set; }
    public decimal? Weight { get ;  set; }
    public string PalletSSCCNo { get ;  set; }
    public string BOLNo { get ;  set; }       
    public string ShipMethod { get ;  set; }
    public DateTime? DateTime { get ;  set; }
    public string UTCTimeZone { get ;  set; }
    public string Misc1 { get ;  set; }
    public string Misc2 { get ;  set; }
    public string Misc3 { get ;  set; }
    public string Misc4 { get ;  set; }
    public string Misc5 { get ;  set; }
    public string Misc6 { get ;  set; }
    public string Misc7 { get ;  set; }
    public string Misc8 { get ;  set; }
    public string DetailMisc1 { get ;  set; }
    public string DetailMisc2 { get ;  set; }
    public string DetailMisc3 { get ;  set; }
    public string CarrierDesc { get ;  set; }
    public string TransparencyNum { get ;  set; }
    public string SerialNo { get ;  set; }
    public DateTime? ShipDate { get ;  set; }
}

public class GetASNRequest
{
    public string Warehouse { get ;  set; }
    public bool? UpdateSOOrderExportQuantityfromASN { get ;  set; }	
    public bool?? ALLShippedOrders { get ;  set; }	
    public string FromShipDate { get ;  set; }	
    public string ToShipDate { get ;  set; }	
}

c# Syntax

	 List<ItemHistory>GetItemHistory(GetItemHistoryRequest request);

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/GetItemHistory

For the REST interface, the /GetItemHistory REST call, the equivalent of the GetItemHistory c# method, takes a GetItemHistoryRequest object, serialized to JSON, in the request, and returns an array of ItemHistory objects, in JSON format, in the response.

public class GetItemHistoryRequest
{
	public string FromDate { get ;  set; }
	public string ToDate { get ;  set; }
	public string Warehouse { get ;  set; }
   	public string ItemNo { get ;  set; }    
   	public string TransType { get ;  set; }    
   	public string Misc8 { get ;  set; }    
   
}

public class ItemHistory
{
    public string  UserID  { get ;  set; }
    public string  StartDatetime  { get ;  set; }    
    public string  HistDate  { get ;  set; }
    public string  ItemNo  { get ;  set; }
    public string  TransactionType  { get ;  set; }
    public string  ProjectNo  { get ;  set; }
    public int?  POLine  { get ;  set; }
    public int?  SOLine  { get ;  set; }
    public string  SoNo  { get ;  set; }
    public string  PoNo  { get ;  set; }
    public decimal  Qty  { get ;  set; }
    public string  FromBin  { get ;  set; }
    public string  ToBin  { get ;  set; }
    public decimal?  FromQty  { get ;  set; }
    public decimal?  ToQty  { get ;  set; }
    public string  UOM  { get ;  set; }
    public decimal  RunningBalance  { get ;  set; }
    public string  FromWhouse  { get ;  set; }
    public string  ToWhouse  { get ;  set; }
    public string  ShipDate  { get ;  set; }
    public string  LotNo  { get ;  set; }
    public string  Container  { get ;  set; }
    public string  NewItemNo  { get ;  set; }
    public string  NewLotNo  { get ;  set; }
    public string  Reason  { get ;  set; }
    public string  ReasonComment  { get ;  set; }
    public string  CustOwner  { get ;  set; }
    public string  Location  { get ;  set; }
    public string  RecvDate  { get ;  set; }
    public string  Misc1  { get ;  set; }
    public string  Misc2  { get ;  set; }
    public string  Misc3  { get ;  set; }
    public string  Misc4  { get ;  set; }
    public string  Misc5  { get ;  set; }
    public string  Misc6  { get ;  set; }
    public string  Misc7  { get ;  set; }
    public string  Misc8  { get ;  set; }
    public string  Whouse  { get ;  set; }
    public string  SubTask  { get ;  set; }
	public long? HistID { get; set; }
	
}

c# Syntax

public<Response> DeleteInventory(DeleteInventory DeleteInvParameter);

REST Syntax

Integration/NorthstarWmsIntegrationRest.svc/IntegrationServiceREST/InventoryERP/DeleteInventory

The DeleteInventory method deletes the Inventories based on the Warehouse name.

public class DeleteInventory
{	
    public string WarehouseName { get ;  set; }
}