LOGIN NAME:

PASSWORD:

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

LoadReceiptsByShopper SOAP Method

DESCRIPTION:

Returns all Orders by a specific shopper for which a 'Receipt' entry/node was created, in the reverse chronological order the records were entered into the system.

PARAMETER(S):

strShopperID - String. The Shopper identifier for which the data is to be returned.

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 all Order records by a specific shopper for which a 'Receipt' entry was created (the record's <Shopper_ID> value matches the input parameter's value). To view the validating XSD Schema, please click here. An example is provided here or below:

<Orders>
  <Order Order_ID="1b7c976da05b47cf9bba4b156f53162e">
   <Shipping>
    <First_Name>John</First_Name>
    <Middle_Name>Q.</Middle_Name>
    <Last_Name>Doe</Last_Name>
    <City>Las Vegas</City>
    <State>Nevada</State>
   </Shipping>
   <Billing>
    <First_Name>John</First_Name>
    <Middle_Name>Q.</Middle_Name>
    <Last_Name>Doe</Last_Name>
    <City>Las Vegas</City>
    <State>Nevada</State>
   </Billing>
   <Receipt Date_Created="2004-03-17T15:12:00">
    <Total>4.9900</Total>
   </Receipt>
  </Order>
  <Order Order_ID="59d0aa841bd64f6b9337b0dff9812386">
   <Shipping>
    <First_Name>John</First_Name>
    <Middle_Name>Q.</Middle_Name>
    <Last_Name>Doe</Last_Name>
    <City>Las Vegas</City>
    <State>Nevada</State>
   </Shipping>
   <Billing>
    <First_Name>John</First_Name>
    <Middle_Name>Q.</Middle_Name>
    <Last_Name>Doe</Last_Name>
    <City>Las Vegas</City>
    <State>Nevada</State>
   </Billing>
   <Receipt Date_Created="2004-02-09T18:20:00">
    <Total>19.9900</Total>
   </Receipt>
  </Order>
  ...
</Orders>

If the account does not contain any records for that particular shopper, the <Orders> root node will not contain any child elements. An example is provided below:

<Orders />

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