post https://app.ecwid.com/api/v3//domains/purchase
Use this endpoint to send a domain purchase request.
Access scopes
Requires the following access scope: buy_domains
Request
A JSON object with the following fields:
Field | Type | Description |
---|---|---|
domainName | string | domain name for purchase |
firstName | string | First name of domain owner |
lastName | string | Last name of domain owner |
string | Email address of domain owner | |
street | string | Street address |
city | string | City address |
countryCode | string | A two-letter ISO code of country where domain owner lives |
postalCode | string | Postal code or ZIP code |
stateOrProvinceCode | string | State code (e.g. NY ) or a region name. See valid codes here: https://api-docs.ecwid.com/reference/list-of-state-codes |
phone | string | Phone number of domain owner |
companyName | string | The company name used in domain purchase |
Response
If the purchase was successful and a new domain has pending
or 'active' status, then you'll receive a JSON array with the following fields (similar to Get domains]):
Field | Type | Description |
---|---|---|
id | number | Internal ID of purchased domain |
name | string | Purchased domain name, e.g. "mysuperstore.com" |
status | string | Status of purchased domain |
connectedToInstantSite | boolean | Shows if this domain is connected to Instant Site. Available values: true , false |
primaryDomain | boolean | Shows if this domain is the main one. Available values: true , false |
redirectToPrimaryDomain | boolean | Shows if this domain redirects to the main one. Displays only if the "primaryDomain": false . Available values: true , false |
purchaseDate | string | Date of domain purchase |
expirationDate | string | Date of domain expiration |
renewalDate | string | Date of next charge for domain renewal |
autorenew | boolean | Shows if automatic renewal charge is enabled. Available values: true , false |
domainOwnerInfo | < DomainOwnerInfo> | Domain owner details specified in purchase process |
billingInfo | <DomainBillingInfo> | Domain billing information |
DomainOwnerInfo
Field | Type | Description |
---|---|---|
verificationStatus | string | "verified" if the verification is complete |
firstName | string | First name of domain owner |
lastName | string | Last name of domain owner |
string | Email address of domain owner | |
street | string | Street address |
city | string | City address |
countryCode | string | A two-letter ISO code of country where domain owner lives |
postalCode | string | Postal code or ZIP code |
stateOrProvinceCode | string | State code (e.g. NY ) or a region name. See valid codes here: https://api-docs.ecwid.com/reference/list-of-state-codes. |
phone | string | Phone number of domain owner |
companyName | string | The company name used in domain purchase |
DomainBillingInfo
Field | Type | Description |
---|---|---|
totalRenewalDomainPrice | number | Total price for domain renewal |
renewalDomainPrice | number | Price of domain |
renewalTax | number | Tax for domain price |
whoisPrivacyFeaturePrice | number | Price for the "whois Privacy" feature |
currency | string | Currency for domain renewal, e.g. "USD" |
totalRenewalDomainPriceFormatted | string | Formatted total price for domain renewal, e.g. "$99.00" |