GetItemVendorByKey

Description

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

Parameters

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

Return Value:

Value	Type	Description
GetItemVendorByKeyResult	ItemVendor	An item vendor object.

Interfaces

• Dynamics GP
• Inventory

Examples

The following C# example retrieves the item vendor with an item key value of "100XLG" and a vendor key value of "ACETRAVE0001". 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;
            VendorKey vendorKey;
            ItemVendorKey itemVendorKey;
            ItemVendor itemVendor;

            // 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 to specify the item
            itemKey = new ItemKey();
            itemKey.Id = "100XLG";

            // Create a vendor key to specify the vendor
            vendorKey = new VendorKey();
            vendorKey.Id = "ACETRAVE0001";

            // Create an item vendor key object
            itemVendorKey = new ItemVendorKey();
            itemVendorKey.ItemKey = itemKey;
            itemVendorKey.VendorKey = vendorKey;

            // Retrieve the item vendor object
            itemVendor = wsDynamicsGP.GetItemVendorByKey(itemVendorKey, context);

            // Display the item description
            MessageBox.Show("Item description: " + itemVendor.VendorItemDescription);
        }
    }
}

** 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;
            VendorKey vendorKey;
            ItemVendorKey itemVendorKey;
            ItemVendor itemVendor;

            // 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 to specify the item
            itemKey = new ItemKey();
            itemKey.Id = "100XLG";

            // Create a vendor key to specify the vendor
            vendorKey = new VendorKey();
            vendorKey.Id = "ACETRAVE0001";

            // Create an item vendor key object
            itemVendorKey = new ItemVendorKey();
            itemVendorKey.ItemKey = itemKey;
            itemVendorKey.VendorKey = vendorKey;

            // Retrieve the item vendor object
            itemVendor = wsDynamicsGP.GetItemVendorByKey(itemVendorKey, context);

            // Display the item description
            MessageBox.Show("Item description: " + itemVendor.VendorItemDescription);

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