Add Order

addorder

Purpose

This command is used to add a new order to the system.

Attributes

  • clientid - client id for order
  • pid - product id
  • domain - domain name
  • billingcycle - onetime, monthly, quarterly, semiannually, etc..
  • domaintype - set for domain registration - register or transfer
  • regperiod = 1,2,3,etc...
  • eppcode - if domain transfer
  • nameserver1 - first nameserver (req for domain reg only)

Optional Attributes

  • customfields - a base64 encoded serialized array of custom field values
  • configoptions - a base64 encoded serialized array of configurable product options
  • priceoverride - allows you to pass in a custom price override for the product (domains are not products)
  • promocode - pass coupon code to apply to the order
  • promooverride - pass this to override the products a coupon applies to (like through the admin area)
  • affid - affiliate ID if you want to assign the order to an affiliate
  • noinvoice - set true to not generate an invoice for this order
  • noinvoiceemail - set true to generate but not send the invoice notification email
  • noemail - set true to surpress the order confirmation email
  • addons - comma seperated list of addon ids

For VPS

  • hostname - The hostname of the server. This will be added to domain automatically
  • ns1prefix - the prefix to be used for the NS1 nameserver
  • ns2prefix - the prefix to be used for the NS2 nameserver
  • rootpw - The root password for the server

For domain reg only

  • contactid - the ID of a contact to use for the domain registrant details
  • dnsmanagement - true to enable
  • domainfields - a base64 encoded serialized array of the TLD specific field values
  • emailforwarding - true to enable
  • idprotection - true to enable
  • nameserver2 - second nameserver
  • nameserver3 - third nameserver
  • nameserver4 - fourth nameserver

For domain renewal

  • domainrenewals - This is a name -> value array of domain -> regperiod
  • 1 Users Found This Useful
Was this answer helpful?

Related Articles

Get Products

getproducts Purpose This command can be used to retrieve product and domain details....

Get Orders

getorders Purpose This command is used to generate a list of orders Attributes Optional...

Cancel Order

cancelorder Purpose This command is used to cancel a pending order in the system. Attributes...

Get TLDs

gettlds Purpose This command can be used to retrieve available TLDs and prices. Optional...