Deprecated feature

QUERYORDERS

The QUERYORDERS command returns a collection of PSOrder objects or order numbers.

Keywords Required Value
DTDPATH No ASCII character string. Path to the locally-stored DTD. The value of this parameter will be used in the XML document to specify the location of the external DTD. If this parameter is not specified, the complete DTD will be returned as an internal DTD. The length of the DTDPath must be from 1 to 254 bytes.
ETAPIVERSION Yes 3 (Indicates WebSphere Commerce Payments-or predecessor product-API version: Version 2.1.x, 2.2.x, 3.1.x, 5.5.x, and 5.6.x)
KEYSONLY No
1
Instead of returning the actual objects, only a list of order numbers and merchant numbers should be returned.
0
Complete objects will be returned.
OPERATION Yes ASCII character string "QueryOrders."
RETURNATMOST No Specifies the maximum number of objects or order numbers to return for this call. Enables the application to control the amount of data returned by a given query call. A 32-bit positive integer in ASCII characters.
WITHCREDITS No
1
All related PSCredit objects should be located and kept with the Order objects.
0
Credits will not be returned.
WITHPAYMENTS No
1
All related PSPayment objects should be located and kept with the Order objects.
0
Payments will not be returned.
Optional search modifiers Multiple allowed? Value
ACCOUNTNUMBER Y Merchant's account with its financial institution. Integer in ASCII characters. Must be from 1 to 999999999.
APPROVESALLOWED N Supported values are:
1
Approve command is allowed for this order
0
Approve command is not allowed for this order
BRAND Y Brand of customer's payment method. ASCII character string
CREATEBEGINTIME N A date and time to be used as the lower limit of the create time of the order. To be included in the query result. This value is specified in ASCII decimal digits as the number of milliseconds since midnight (00:00:00:000 on a 24 hour clock), 01 January 1970.
CREATEENDTIME N A date and time to be used as the upper limit of the create time of the order. To be included in the query result. This value is specified in ASCII decimal digits as the number of milliseconds since midnight (00:00:00:000 on a 24 hour clock), 01 January 1970.
CURRENCY N The ISO 4217 currency code for amount values. Integer in ASCII characters. Must be exactly 3 characters long and should include leading zeroes if necessary.
MAXAMOUNT N Maximum order amount. A Currency value must also be specified. A 32-bit positive integer in ASCII characters.
MAXUNAPPROVEDAMOUNT N Maximum order amount that has yet to be approved. A Currency value must also be specified. A 32-bit positive integer in ASCII characters.
MERCHANTNUMBER Y Merchant number. Integer must be in ASCII characters. Value must be from 1 to 999999999.
MINAMOUNT N Minimum order amount. A Currency value must also be specified. A 32-bit positive integer in ASCII characters.
MINUNAPPROVEDAMOUNT N Minimum order amount that has yet to be approved. A Currency value must also be specified. A 32-bit positive integer in ASCII characters.
MODIFYBEGINTIME N A date and time to be used as the lower limit of the modify time of the order. To be included in the query result. This value is specified in ASCII decimal digits as the number of milliseconds since midnight (00:00:00:000 on a 24 hour clock), 01 January 1970.
MODIFYENDTIME N A date and time to be used as the upper limit of the modify time of the order. To be included in the query result. This value is specified in ASCII decimal digits as the number of milliseconds since midnight (00:00:00:000 on a 24 hour clock), 01 January 1970.
ORDERDATA1 N Auxiliary data supplied by the user, specified as an ASCII character string between 1 and 254 bytes in length.
ORDERNUMBER Y Integer in ASCII characters. Must be from 1 to 99999999.
PAYMENTTYPE Y Payment type. Identifies the payment cassette or protocol. Integer in ASCII characters. Maximum length is 10 bytes
STATE Y An ASCII character string containing one of the following values:
  • "order_requested"
  • "order_ordered"
  • "order_refundable"
  • "order_rejected"
  • "order_pending"
TRANSACTIONID N Transaction identifier supplied by the user, specified as an ASCII character string from 1 to 128 bytes in length.