UpdateSalesOrder


Description

Updates the specified sales order object, storing the current values in the database.

Parameters

Parameter

Type

Description

salesOrder

SalesOrder

The sales order object that is being updated.

context

Context

Specifies information about how the method will be called.

policy

Policy

Specifies the set of behaviors and behavior options to be applied during the operation.


Interfaces

 

Examples

The following C# example retrieves the sales order with the sales document key value “ORDST2228” and sets the comment property to “Customer called about order status”. The UpdateSalesOrder operation saves the new comment and all the sales order object’s existing properties to the database.

 Legacy endpoint

using System;
using System.Collections.Generic;
using System.Text;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			SalesDocumentKey salesOrderKey;
			SalesOrder salesOrder;
			Policy salesOrderUpdatePolicy;

			// 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 sales document key
			salesOrderKey = new SalesDocumentKey();
			salesOrderKey.Id = "ORDST2228";

			// Retrieve the sales order
			salesOrder = wsDynamicsGP.GetSalesOrderByKey(salesOrderKey, context);

			// Set the comment property
			salesOrder.Comment = "Customer called about order status";

			// Retrieve the update policy for sales orders
			salesOrderUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdateSalesOrder", context);

			// Update the sales order object
			wsDynamicsGP.UpdateSalesOrder(salesOrder, context, salesOrderUpdatePolicy);
	}
}
}

 Native endpoint

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			SalesDocumentKey salesOrderKey;
			SalesOrder salesOrder;
			Policy salesOrderUpdatePolicy;

			// 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 sales document key
			salesOrderKey = new SalesDocumentKey();
			salesOrderKey.Id = "ORDST2228";

			// Retrieve the sales order
			salesOrder = wsDynamicsGP.GetSalesOrderByKey(salesOrderKey, context);

			// Set the comment property
			salesOrder.Comment = "Customer called about order status";

			// Retrieve the update policy for sales orders
			salesOrderUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdateSalesOrder", context);

			// Update the sales order object
			wsDynamicsGP.UpdateSalesOrder(salesOrder, context, salesOrderUpdatePolicy);

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


Documentation Feedback