GetSalesFulfillmentOrderList


Description

Retrieves a list of sales fulfillment order summary objects that match the specified criteria.

Parameters

Parameter

Type

Description

criteria

SalesFulfillmentOrderCriteria

A sales fulfillment order criteria object that specifies which sales fulfillment order summary objects are returned.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetSalesFulfillmentOrderListResult

ArrayOfSalesFulfillmentOrderSummary

The list of sales fulfillment order summary objects that match the specified criteria.


Interfaces

 

Examples

The following C# example retrieves the list of sales fulfillment order summary objects where the CustomerId begins with “A”. The customer name and total amount from each sales invoice summary object 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;
			LikeRestrictionOfString customerIdRestriction;
			SalesFulfillmentOrderCriteria fulfillmentOrderCriteria;
			SalesFulfillmentOrderSummary[] salesFulfillmentOrderSummaries;

			// 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 restriction object
			// Retrieve all sales fulfillment orders with a customer Id that begin with 'A'
			customerIdRestriction = new LikeRestrictionOfString();
			customerIdRestriction.Like = "A%";

			// Create a criteria object
			fulfillmentOrderCriteria = new SalesFulfillmentOrderCriteria();
			fulfillmentOrderCriteria.CustomerId = customerIdRestriction;

			// Retrieve the list of sales fulfillment order summary objects
			salesFulfillmentOrderSummaries = wsDynamicsGP.GetSalesFulfillmentOrderList(
			fulfillmentOrderCriteria, context);

			// Display the customer name and total order amount for each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (SalesFulfillmentOrderSummary a in salesFulfillmentOrderSummaries)
			{
				summaryList.AppendLine("Customer name: " + a.CustomerName + "  Fulfillment order amount: " +
				a.TotalAmount.Value.ToString("C"));
		}
			MessageBox.Show(summaryList.ToString());
	}
}
}

 Native endpoint

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

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			LikeRestrictionOfstring customerIdRestriction;
			SalesFulfillmentOrderCriteria fulfillmentOrderCriteria;
			SalesFulfillmentOrderSummary[] salesFulfillmentOrderSummaries;

			// 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 restriction object
			// Retrieve all sales fulfillment orders with a customer Id that begin with 'A'
			customerIdRestriction = new LikeRestrictionOfstring();
			customerIdRestriction.Like = "A%";

			// Create a criteria object
			fulfillmentOrderCriteria = new SalesFulfillmentOrderCriteria();
			fulfillmentOrderCriteria.CustomerId = customerIdRestriction;

			// Retrieve the list of sales fulfillment order summary objects
			salesFulfillmentOrderSummaries = wsDynamicsGP.GetSalesFulfillmentOrderList(
			fulfillmentOrderCriteria, context);

			// Display the customer name and total order amount for each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (SalesFulfillmentOrderSummary a in salesFulfillmentOrderSummaries)
			{
				summaryList.AppendLine("Customer name: " + a.CustomerName + "  Fulfillment order amount: " +
				a.TotalAmount.Value.ToString("C"));
		}
			MessageBox.Show(summaryList.ToString());

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


Documentation Feedback