GetOrderList


Definition

Get a list of the orders placed through this account.

Usage

Use this command to retrieve a list of orders, identified by order number.

Availability

All resellers have access to this command.

Implementation on eNom.com

Log on to resellertest.enom.com with Login ID resellid, password resellpw.

http://www.enom.com/myaccount/newreports.asp

In the Report Categories menu, select the view orders option. Clicking the view report button calls the GetOrderList command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.

Input parameters

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
Start Optional; default is 1 Return sets of 25 records in reverse chronological order. For example, Start=26 returns the 26th through 50th most recent orders. 4
BeginDate Optional; if omitted, six months of orders are returned Beginning date of orders to return. Must be no more than six months before EndDate. Permitted format is MM/DD/YYYY 10
EndDate Optional; if omitted, EndDate is today End date of orders to return. Must be no more than six months after BeginDate. Permitted format is MM/DD/YYYY 10
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
OrderID Order identification number, in nine-digit format.
OrderDate Date on which the order was placed. Time stamp indicates the time at which our database received the order.
StatusDesc Overall status of the order. Options are: 0 New 1 Authorization Succeeded 2 Authorization Failed 3 Processing 5 Ready for billing 6 Order complete 7 Order canceled
OrderProcessFlag True/False -- True indicates the order has been processed.
ShowPreviousAndNext Yes/No -- Yes gives user access to previous and next transactions.
ShowPreviousLink Yes/No -- Yes displays a link that calls the previous block of transactions.
PreviousStartPosition First transaction to include in the response, counting back from the most recent, if user clicks a Previous link on your Web page.
ShowStart First transaction to include in the response, counting back from the most recent.
ShowEnd Last transaction to include in the response, counting back from the most recent.
ShowNextLink Yes/No -- Yes displays a link that calls the next block of transactions.
RecordCount Total number of orders stored for this account.
Command Name of command executed
ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
ErrX Error messages explaining the failure. These can be presented as is back to the client.
Done True indicates this entire response has reached you successfully.

 

Notes

  • The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
  • Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.

Example