API:Get Orders

From WHMCS Documentation

Jump to: navigation, search

This command is used to generate an XML list of orders

Attributes

limitstart - Which User ID to start at (default = 0)
limitnum - Limit by number (default = 25)

Example Command

$postfields["action"] = "getorders";

Returned Variables

Always returned in XML

<whmcsapi version="4.1.2"> 
 <action>getorders</action> 
  <result>success</result> 
  <totalresults>1</totalresults> 
  <startnumber>0</startnumber> 
  <numreturned>1</numreturned> 
  <orders> 
   <order> 
    <id>1</id> 
    <ordernum>5031802290</ordernum> 
    <userid>1</userid> 
    <contactid>0</contactid> 
    <date>2010-01-22 18:09:02</date> 
    <nameservers></nameservers> 
    <transfersecret></transfersecret> 
    <promocode></promocode> 
    <promotype></promotype> 
    <promovalue></promovalue> 
    <amount>0.00</amount> 
    <paymentmethod>iveri</paymentmethod> 
    <invoiceid>0</invoiceid> 
    <status>Active</status> 
    <ipaddress>127.0.0.1</ipaddress> 
    <fraudmodule></fraudmodule> 
    <fraudoutput></fraudoutput> 
    <notes></notes> 
    <paymentmethodname>PayPal</paymentmethodname> 
    <paymentstatus></paymentstatus> 
    <name>A Testclient</name> 
   </order> 
 </orders> 
</whmcsapi>

About the API System · Example API Usage · API Functions

API Functions
Add Client - Update Client - Delete Client - Get Clients - Get Clients Details - Get Clients Products - Get Clients Password - Send Email
Get Support Departments - Get Support Statuses - Get Tickets - Get Ticket - Get Ticket Predefined Cats - Get Ticket Predefined Replies
Open Ticket - Reply Ticket - Add Ticket Note - Delete Ticket
Module Create - Module Suspend - Module Unsuspend - Module Terminate
Create Quote - Update Quote - Delete Quote - Send Quote - Accept Quote
Get Orders - Get Order Statuses - Add Order - Accept Order - Pending Order - Cancel Order - Fraud Order - Delete Order
Get Invoice - Get Payment Methods - Create Invoice - Add Billable Item - Add Invoice Payment
Add Transaction - Add Credit - Capture Payment
Domain WHOIS Lookup - Get Activity Log - Get Admin Details - Update Admin Notes - Get Currencies - Get Email Templates
Get To-Do Items - Get To-Do Item Statuses - Get Staff Online - Get Stats - Encrypt Password - Decrypt Password