GetShippingMethodByKey

Description

Retrieves a single shipping method object based on the specified shipping method key.

Parameters

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

Return Value:

Value	Type	Description
GetShippingMethodByKeyResult	ShippingMethod	A shipping method object.

Interfaces

• Dynamics GP
• Common
• Field Service
• Financials
• Human Resources/Payroll
• Inventory
• Manufacturing
• Project Accounting
• Purchasing
• Sales

Examples

The following C# example retrieves a shipping method object with the key value "OVERNIGHT". A message box displays the description.

** 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;
            ShippingMethodKey shippingMethodKey;
            ShippingMethod shippingMethod;

            // 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 shipping method key
            shippingMethodKey = new ShippingMethodKey();
            shippingMethodKey.Id = "OVERNIGHT";

            // Retrieve the shipping method object
            shippingMethod = wsDynamicsGP.GetShippingMethodByKey(shippingMethodKey, context);

            // Display the description property
            MessageBox.Show("Shipping method description: " + shippingMethod.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;
            ShippingMethodKey shippingMethodKey;
            ShippingMethod shippingMethod;

            // 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 shipping method key
            shippingMethodKey = new ShippingMethodKey();
            shippingMethodKey.Id = "OVERNIGHT";

            // Retrieve the shipping method object
            shippingMethod = wsDynamicsGP.GetShippingMethodByKey(shippingMethodKey, context);

            // Display the description property
            MessageBox.Show("Shipping method description: " + shippingMethod.Description);

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