LOGIN NAME:

PASSWORD:

:: Web Services :: XWebCheckOut ::
:: Documentation (Version 1) ::

LoadReceiptsPaged SOAP Method

DESCRIPTION:

Returns "paginated" Order records, for which a 'Receipt' entry/node was created, in the reverse chronological order the records were entered into the system. Paginated is the ability to return a specific number of records at a time, similar to how search engines display results (i.e. Google's 10 search results on a page).

PARAMETER(S):

intPageNumber - Positive Integer. Indicates the page number for which the data is to be returned.
intPageSize - Positive Integer. The number of records you want displayed on a page.

SOAP HEADERS:

LoginName - String. The "Login Name" you chose during the registration process.
Password - String. Your account's "Password".

NOTE***: SOAP Headers are required for authentication.

RETURNS:

XML String, representing the Order records requested. To view the validating XSD Schema, please click here. An example is provided here or below:

<Orders Total_Record_Count="32">
  <Order Order_ID="1b7c976da05b47cf9bba4b156f53162e">
   <Shopper_ID>test11</Shopper_ID>
   <Shipping>
    <First_Name>Adam</First_Name>
    <Middle_Name>A.</Middle_Name>
    <Last_Name>Tester</Last_Name>
    <City>Seattle</City>
    <State>Washington</State>
   </Shipping>
   <Billing>
    <First_Name>Suzan</First_Name>
    <Middle_Name></Middle_Name>
    <Last_Name>Tester</Last_Name>
    <City>Seattle</City>
    <State>Washington</State>
   </Billing>
   <Receipt Date_Created="2004-04-01T11:11:00">
    <Total>10.0000</Total>
   </Receipt>
  </Order>
  <Order Order_ID="59d0aa841bd64f6b9337b0dff9812386">
   <Shopper_ID>test10</Shopper_ID>
   <Shipping>
    <First_Name>Mike</First_Name>
    <Middle_Name></Middle_Name>
    <Last_Name>Tester</Last_Name>
    <City>New York</City>
    <State>New York</State>
   </Shipping>
   <Billing>
    <First_Name>Mike</First_Name>
    <Middle_Name></Middle_Name>
    <Last_Name>Tester</Last_Name>
    <City>New York</City>
    <State>New York</State>
   </Billing>
   <Receipt Date_Created="2004-03-30T14:02:00">
    <Total>10.0000</Total>
   </Receipt>
  </Order>
  ...
</Orders>

If the account does not contain any records, the <Orders> root node will not contain any child elements and the Total_Record_Count attribute will have a value of 0 (zero). An example is provided below:

<Orders Total_Record_Count="0" />

All non-XML strings returned by this method should be considered errors.

ERROR(S):

If the system encounters an error, the method will return one the following messages instead of the expected XML string:

Error: Unable to authenticate. Your username and/or password are invalid. - authentication errors.
Error: You have not yet registered for this service. - authorization errors.
Error: A database error has occurred. Please try again later. - catastrophic database errors.
Error: System error. Unable to process the request. - catastrophic system errors.

ADDITIONAL SUPPORT RESOURCES:

• Frequently Asked Questions specific to this web service
• Developer community supported Online Forum
• "How-to" Implementation Guides