GetItemByKey

Description

Retrieves a single inventory item object based on the item key value supplied.

Parameters

Parameter	Type	Description
key	ItemKey	An item key object that specifies the item to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetItemByKeyResult	Item	An item object.

Interfaces

• Dynamics GP
• Inventory

Examples

The following C# example retrieves the inventory item with the key value "128 SDRAM". The item description is displayed in a message box.

** 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;
            ItemKey itemKey;
            Item item;

            // 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 an item key object to specify the item
            itemKey = new ItemKey();
            itemKey.Id = "128 SDRAM";

            // Retrieve the item object
            item = wsDynamicsGP.GetItemByKey(itemKey, context);

            // Display the description property from the item object
            MessageBox.Show("Item description: " + item.Description);
        }
    }
}

** 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;
            ItemKey itemKey;
            Item item;

            // 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 an item key object to specify the item
            itemKey = new ItemKey();
            itemKey.Id = "128 SDRAM";

            // Retrieve the item object
            item = wsDynamicsGP.GetItemByKey(itemKey, context);

            // Display the description property from the item object
            MessageBox.Show("Item description: " + item.Description);

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