GetWarehouseList

Description

Retrieves a list of warehouse (site) summary objects that match the specified criteria.

Parameters

Parameter	Type	Description
criteria	WarehouseCriteria	The warehouse criteria object that specifies which warehouse summary objects to return.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetWarehouseListResult	ArrayOfWarehouseSummary	The list of warehouse summary objects that match the specified criteria.

Interfaces

• Dynamics GP
• Inventory

Examples

The following C# example retrieves the list of warehouse summary objects with a State property of "IL". A message box displays the State and Description for each warehouse in the list.

** Legacy endpoint**

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            LikeRestrictionOfString stateRestriction;
            WarehouseCriteria warehouseCriteria;
            WarehouseSummary[] warehouseSummaries;

            // Create an instance of the service
            DynamicsGP wsDynamicsGP = new DynamicsGP();

            // Be sure the default credentials are used
            wsDynamicsGP.UseDefaultCredentials = true;

            // Create a context with which to call the service
            context = new Context();

            // Specify which company to use (sample company)
            companyKey = new CompanyKey();
            companyKey.Id = (-1);

            // Set up the context object
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Create the restriction object
            // Return all warehouses with a state property of 'IL'
            stateRestriction = new LikeRestrictionOfString();
            stateRestriction.EqualValue = "IL";

            // Create the criteria object
            warehouseCriteria = new WarehouseCriteria();
            warehouseCriteria.State = stateRestriction;

            // Retrieve the list of warehouse summary objects
            warehouseSummaries = wsDynamicsGP.GetWarehouseList(warehouseCriteria, context);

            // Display the state and description for each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (WarehouseSummary a in warehouseSummaries)
            {
                summaryList.AppendLine("State: " + a.State + "  Description: " +
                a.Description);
            }
            MessageBox.Show(summaryList.ToString());
        }
    }
}

** Native endpoint **

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            LikeRestrictionOfstring stateRestriction;
            WarehouseCriteria warehouseCriteria;
            WarehouseSummary[] warehouseSummaries;

            // Create an instance of the service
            DynamicsGPClient wsDynamicsGP = new DynamicsGPClient();

            // Create a context with which to call the service
            context = new Context();

            // Specify which company to use (sample company)
            companyKey = new CompanyKey();
            companyKey.Id = (-1);

            // Set up the context object
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Create the restriction object
            // Return all warehouses with a state property of 'IL'
            stateRestriction = new LikeRestrictionOfstring();
            stateRestriction.EqualValue = "IL";

            // Create the criteria object
            warehouseCriteria = new WarehouseCriteria();
            warehouseCriteria.State = stateRestriction;

            // Retrieve the list of warehouse summary objects
            warehouseSummaries = wsDynamicsGP.GetWarehouseList(warehouseCriteria, context);

            // Display the state and description for each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (WarehouseSummary a in warehouseSummaries)
            {
                summaryList.AppendLine("State: " + a.State + "  Description: " +
                a.Description);
            }
            MessageBox.Show(summaryList.ToString());

            // Close the service
            if(wsDynamicsGP.State != CommunicationState.Faulted)
            {
                wsDynamicsGP.Close();
            }
        }
    }
}