Element: getProductsQueryRequest

Description

A getProductsQueryRequest message contains an element of getProductsQueryRequestType.

Derived By

Type getProductsQueryRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
queryParams	productQueryParametersType	0..1	Required. See productQueryParametersType. Leave this element blank to return all products.
pageNumber	integer	1..1	Required. Starts at 1. Say the getProductCount operation using the same query parameters returns 100 records. If the batch size is 50 records and you want the second batch of 50, set pageNumber to 2.
batchSize	integer	1..1	Required. Maximum number of records to return in the response.
returnContainedObjects	boolean	1..1	Required. If true, return arrays of elements that are contained in the product.

Referenced By

Name	Type
getProductsQuery	Method

XML Example

The following XML fragment illustrates a getProductsQueryRequest message:

<getProductsQueryRequest>
   <queryParams>
      <productName>
         <value>Product</value>
         <searchType>STARTS_WITH</searchType>
      </productName>
      <version>
         <value>1</value>
         <searchType>STARTS_WITH</searchType>
      </version>
   </queryParams>
   <pageNumber>1</pageNumber>
   <batchSize>50</batchSize>
   <returnContainedObjects>false</returnContainedObjects>
</getProductsQueryRequest>