getOrdersAsXML Web Service

The getOrdersAsXML Web service will look up orders for a particular user. The possible search types are:

incomplete - return the orders that are incomplete
open - return the orders that are in one of the configured open states
closed - return the orders that are in one of the configured closed states.

Servlet Name

getOrdersAsXML

Input Parameters

profileId – The ID of the user whose orders are returned.
startIndex – Which order should be the first order returned. If you want to start at the beginning, use 0.
numOrders – How many orders should be returned. If all orders, use -1.
searchType – Which orders should be returned: incomplete, open, or closed. See above description for details.
sortProperty – (Optional) Which property should the results should be sorted on. If null, the orders are not sorted.
ascending – Which direction should the orders be sorted in. If true, then orders are sorted in ascending order. If false, then orders are sorted in descending order.

Output

An array of XML strings, each representing an order.

Web Service Class

atg.commerce.order.OrderServices

Nucleus Component

/atg/commerce/order/OrderServices

Method

getOrdersAsXML(String pProfileId, int pStartIndex, int pEndIndex, String pSearchType, String pSortProperty, Boolean pAscending)

Executes within a session

Yes

WSDL URL

http://hostname:port/commerce/order/getOrdersAsXML?WSDL

Endpoint URL

http://hostname:port/commerce/order/getOrdersAsXML/getOrdersAsXML

Security FunctionalName

orderLookupOperation

Repository Component

/atg/commerce/order/OrderRepository

Item Descriptor

order (b2c)
b2bOrder (b2b)

 
loading table of contents...