GetItemList

Description

Retrieves a list of inventory items that meet the specified criteria.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Inventory

Examples

The following C# example retrieves the list of item summary objects with an item class ID equal to "CATALOG". A message box displays the item ID and the description of each member of 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 itemClassIdRestriction;
            ItemCriteria itemCriteria;
            ItemSummary[] itemSummaries;

            // 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 a restriction object
            // Retrieve all items in the CATALOG class
            itemClassIdRestriction = new LikeRestrictionOfString();
            itemClassIdRestriction.EqualValue = "CATALOG";

            // Create a item criteria object
            itemCriteria = new ItemCriteria();
            itemCriteria.ItemClassId = itemClassIdRestriction;

            // Retrieve the list of item summary objects
            itemSummaries = wsDynamicsGP.GetItemList(itemCriteria, context);

            // Display the ID and amount of each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (ItemSummary a in itemSummaries)
            {
                summaryList.AppendLine("Item: " + a.Key.Id + "  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 itemClassIdRestriction;
            ItemCriteria itemCriteria;
            ItemSummary[] itemSummaries;

            // 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 a restriction object
            // Retrieve all items in the CATALOG class
            itemClassIdRestriction = new LikeRestrictionOfstring();
            itemClassIdRestriction.EqualValue = "CATALOG";

            // Create a item criteria object
            itemCriteria = new ItemCriteria();
            itemCriteria.ItemClassId = itemClassIdRestriction;

            // Retrieve the list of item summary objects
            itemSummaries = wsDynamicsGP.GetItemList(itemCriteria, context);

            // Display the ID and amount of each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (ItemSummary a in itemSummaries)
            {
                summaryList.AppendLine("Item: " + a.Key.Id + "  Description: " +
                a.Description);
            }
            MessageBox.Show(summaryList.ToString());

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