TP_CreateOrder

command

string

Required

TP_CreateOrder

uid

string

Required

Your Account ID

pw

string

Required

Your API Token

PreConfig

string

Optional; default is 0

Set PreConfig=1 to create, but not send, the order at this time. Using PreConfig=1 allows you to use TP_UpdateOrderDetail to modify DomainPassword, Lock, Renew, contacts, and extended attributes before submitting the order. When you are ready to submit the order, call TP_SubmitOrder.

OrderType

string

Required

Permitted values are Fax or Autoverification

CustomerSuppliedPrice

int

Optional

For premium domain(s), the exact price for this domain must be declared in this parameter. Use the PE_GetPremiumPricing command to retrieve the price.

IncludeIDP

int

Optional

Includes ID Protect on domain transfers for TLDs that support ID Protect. Permitted values are 1 = include ID Protect, and 0 = Do not include ID Protect

IDPPrice

int

Optional; required if IncludeIDP = 1

Price of ID Protect (the price can be retrieved from the appropriate price command)

DomainCount

int

Required

The number of domain names to be submitted on the order. This number must match the actual number of names submitted.

SLDX X=1 to DomainCount

string

Required

Second-level domain name (for example, enom in enom.com)

TLDX

string

Required

Top-level domain name (extension)

AuthInfoX

string

Required

EPP TLDs Current (“losing”) registrar’s authorization key

DomainPassword

string

Optional

Set a domain access password on the domain name

Lock

int

Optional

Set Lock=1 to turn on RegistrarLock option

Renew

int

Optional

Set Renew=1 to turn on Auto-Renew option

AuthString

string

Optional

Authorization string for automated transfer order entries (approved accounts only)

ExtendedAttributes

string

Required for TLDs that use extended attributes

Extended attributes, required for some country code TLDs. You can retrieve a list of required extended attributes for any TLD using the GetExtAttributes command.

RegistrantAddress1

string

Optional; Required for Fax orders or TLDs that require extended attributes.

Registrant address

RegistrantAddress2

string

Optional; Required for Fax orders or TLDs that require extended attributes.

Registrant additional address info

RegistrantCity

string

Optional; Required for Fax orders or TLDs that require extended attributes.

Registrant city

RegistrantCountry

string

Optional; Required for Fax orders or TLDs that require extended attributes.

Registrant country

RegistrantEmailAddress

string

Optional; Required for Fax orders or TLDs that require extended attributes.

Registrant email address

RegistrantFax

string

Optional

Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters and the + is URLencoded as a plus sign (%2B).

RegistrantFirstName

string

Optional; Required for Fax orders or TLDs that require extended attributes.

Registrant first name

RegistrantLastName

string

Optional; Required for Fax orders or TLDs that require extended attributes.

Registrant last name

RegistrantJobTitle

string

Optional

Registrant job title

RegistrantOrganizationName

string

Optional; Required for Fax orders or TLDs that require extended attributes.

Registrant organization

RegistrantPhone

string

Optional; Required for Fax orders or TLDs that require extended attributes.

Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters and the + is URLencoded as a plus sign (%2B).

RegistrantPostalCode

string

Optional; Required for Fax orders or TLDs that require extended attributes.

Registrant postal code

RegistrantStateProvince

string

Optional; Required for Fax orders or TLDs that require extended attributes.

Registrant state or province

RegistrantStateProvinceChoice

string

Optional

Registrant state or province choice:
S state
P province

UseCreditCard

boolean

Optional for resellers who use our credit card processing AND want to charge this transaction to the credit card included in this query string

Permitted values are yes and no. The credit card supplied in this query string is charged only if UseCreditCard=yes. If this param is omitted or if UseCreditCard=no, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the Registrant contact and credit card information. When you pass credit card information with this command, you must use the secure HTTPS protocol.

EndUserIP

string

Required if using our CC processing

End user’s IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.

CardType

string

Required if using our CC processing

Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover

CreditCardNumber

int

Required if using our CC processing

Credit card number

CreditCardExpMonth

int

Required if using our CC processing

Expiration month of the credit card, in format MM

CreditCardExpYear

int

Required if using our CC processing

Expiration year of the credit card, in format YYYY

CVV2

int

Required if using our CC processing

Credit card verification code

CCName

string

Required if using our CC processing

Cardholder’s name

CCAddress

string

Required if using our CC processing

Credit card billing street address

CCCity

string

Required if using our CC processing

Credit card billing city

CCStateProvince

string

Required if using our CC processing

Credit card billing state or province

CCCountry

string

Required if using our CC processing

Credit card billing country. Two-character country code is a permitted format

CCZip

string

Required if using our CC processing

Credit card billing postal code

CCPhone

string

Required if using our CC processing

Credit card billing phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters and the + is URL- encoded as a plus sign (%2B).

ChargeAmount

int

Required if using our CC processing

Amount to charge this credit card. Required format is DD.cc

ResponseType

string

Optional

Format of response. Permitted values are

• Text (default)
• HTML
• XML

Command

string

Name of command executed

TransferOrderID

int

Transfer order number.

ErrCount

int

The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

ErrX

string

Error messages explaining the failure. These can be presented as is back to the client.

Done

boolian

"True" indicates this entire response has reached you successfully.