GetWarehouseByKey

Description

Retrieves a single warehouse (site) object based on the specified warehouse key.

Parameters

Parameter	Type	Description
key	WarehouseKey	The warehouse key object that specifies the warehouse object to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetWarehouseByKeyResult	Warehouse	A warehouse object.

Interfaces

• Dynamics GP
• Inventory

Examples

The following C# example retrieves a warehouse object with the key value "NORTH". A message box displays the warehouse object's Description property.

** 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;
            WarehouseKey warehouseKey;
            Warehouse warehouse;

            // 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 warehouse key object to specify the warehouse
            warehouseKey = new WarehouseKey();
            warehouseKey.Id = "NORTH";

            // Retrieve the warehouse object
            warehouse = wsDynamicsGP.GetWarehouseByKey(warehouseKey, context);

            // Display the description of the warehouse
            MessageBox.Show("Warehouse description: " + warehouse.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;
            WarehouseKey warehouseKey;
            Warehouse warehouse;

            // 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 warehouse key object to specify the warehouse
            warehouseKey = new WarehouseKey();
            warehouseKey.Id = "NORTH";

            // Retrieve the warehouse object
            warehouse = wsDynamicsGP.GetWarehouseByKey(warehouseKey, context);

            // Display the description of the warehouse
            MessageBox.Show("Warehouse description: " + warehouse.Description);

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