eBay::API::XML::Call::GetOrders::GetOrdersResponseType(3)

NAME
eBay::API::XML::Call::GetOrders::GetOrdersResponseType

DESCRIPTION
Returns the set of orders that match the order IDs or filter criteria specified.

SYNOPSIS

INHERITANCE
eBay::API::XML::Call::GetOrders::GetOrdersResponseType inherits from the eBay::API::XML::ResponseDataType class

Subroutines:

  setHasMoreOrders()
Applies only to Half.com. If true, there are more orders yet to be retrieved. Additional GetOrders calls with higher page numbers or more entries per page must be made to retrieve these orders. If false, no more orders are available or no orders match the request (based on the input filters).

# Argument: 'xs:boolean'

  isHasMoreOrders()
  Returned: Always
  Details: DetailLevel: none
#    Returns: 'xs:boolean'

  setOrderArray()
The set of orders that match the order IDs or filter criteria specified. Also applicable to Half.com (only returns orders that have not been marked as shipped).

# Argument: 'ns:OrderArrayType'

  getOrderArray()
  Returned: Always
  Details: DetailLevel: none
#    Returns: 'ns:OrderArrayType'

  setOrdersPerPage()
Applies only to Half.com. Indicates the number of orders that can be returned per page of data (i.e., per call). This is the same as the value specified in the Pagination.EntriesPerPage input (or the default value, if EntriesPerPage was not specified). This is not necessarily the actual number of orders returned per page (see ReturnedOrderCountActual).

# Argument: 'xs:int'

  getOrdersPerPage()
  Returned: Always
  Details: DetailLevel: none
#    Returns: 'xs:int'

  setPageNumber()
Applies only to Half.com. Indicates which page of data holds the current result set. Will be the same as the value specified in the Pagination.PageNumber input. If orders are returned, the first page is 1.

# Argument: 'xs:int'

  getPageNumber()
  Returned: Always
  Details: DetailLevel: none
#    Returns: 'xs:int'

  setPaginationResult()
Applies only to Half.com. Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries.

# Argument: 'ns:PaginationResultType'

  getPaginationResult()
  Returned: Always
  Details: DetailLevel: none
#    Returns: 'ns:PaginationResultType'

  setReturnedOrderCountActual()
Applies only to Half.com. Indicates the total number of orders returned.

# Argument: 'xs:int'

  getReturnedOrderCountActual()
  Returned: Always
  Details: DetailLevel: none
#    Returns: 'xs:int'