LogoLogo
Build appsContact API support
  • Build apps
  • Site Templates
  • API Reference
  • Changelog
  • REST API
    • REST API overview
    • Store Profile
      • Get store profile
      • Update store profile
      • Upload store logo image
      • Delete store logo image
      • Store reports
        • Get store reports
        • Get latest store update stats
        • Get deleted items history
    • Orders
      • Search orders
      • Get order
      • Get last order
      • Calculate order details
      • Update order
      • Create order
      • Delete order
      • Get repeat order URL
      • Order invoices
        • Get order receipt PDF
        • Get tax invoices for order
        • Generate tax invoice for order
      • Order statuses
        • Search order statuses
        • Get order status
        • Update custom order status
      • Order extra fields
        • Search order extra fields
        • Update order extra field
        • Add extra fields to order
        • Delete order extra field
      • Abandonned carts
        • Search abandoned carts
        • Get abandoned cart
        • Update abandoned cart
        • Convert abandoned cart to order
      • Recurring subscriptions
        • Search recurring subscriptions
        • Get recurring subscription
        • Update recurring subscription
    • Products
      • Search products
      • Get product
      • Update product
      • Create product
      • Delete product
      • Delete all products
      • Adjust product stock
      • Get product filters
      • Get recently used product swatches
      • Search product brands
      • Product images and videos
        • Upload main product image
        • Upload main product image (async)
        • Upload gallery product image
        • Upload gallery product image (async)
        • Delete main product image
        • Delete gallery product image
        • Delete all gallery product images
        • Upload main product video
        • Upload gallery product video
        • Upload cover for gallery video
        • Delete main product video
        • Delete gallery product video
        • Download gallery product video
        • Bulk update product images and videos
      • Product files
        • Upload product file
        • Download product file
        • Delete product file
        • Delete all product files
        • Change product file description
      • Product variations
        • Search product variations
        • Get product variation
        • Update product variation
        • Create product variation
        • Delete product variation
        • Delete all product variations
        • Adjust product variation stock
        • Upload product variation image
        • Upload product variation image (async)
        • Delete product variation image
      • Product types and attributes
        • Search product types
        • Get product type
        • Update product type and attributes
        • Create product type
        • Delete product type
      • Product reviews
        • Search product reviews
        • Get product reviews stats
        • Update product review status
        • Bulk update/delete product reviews
        • Delete product review
    • Categories
      • Search categories
      • Search categories by path
      • Get category
      • Update category
      • Create category
      • Delete category
      • Category images
        • Upload category image
        • Upload category image (async)
        • Delete category image
      • Manage order of categories in the store
        • Get order of categories
        • Update order of categories
      • Manage order of products in the category
        • Get order of products
        • Update order of products
        • Assign products to the category
        • Unassign products from the category
    • Customers
      • Search customers
      • Get customer
      • Update customer
      • Create customer
      • Delete customer
      • Customer groups
        • Search customer groups
        • Get customer group
        • Update customer group name
        • Create customer group
        • Delete customer group
      • Customer contacts
        • Search customer contacts
        • Get customer contact
        • Update customer contact
        • Create customer contact
        • Delete customer contact
      • Customer extra fields
        • Search customer extra fields
        • Get customer extra field
        • Update customer extra field
        • Create customer extra field
        • Delete customer extra field
    • Discounts
      • Promotions
        • Search promotions
        • Update promotion
        • Create promotion
        • Delete promotion
      • Discount coupons
        • Search discount coupons
        • Get discount coupon
        • Update discount coupon
        • Create discount coupon
        • Delete discount coupon
    • Domains
      • Search store domains
      • Update store domains
      • Search domains for purchase
      • Purchase domain
      • Send domain verification email
      • Reset domain password
    • Dictionaries
      • Country codes
      • Currency codes
      • Currency codes by country
      • State codes by country
      • Tax classes by country
    • Staff accounts
      • Search staff accounts
      • Get staff account
      • Get staff account scopes
      • Update staff account
      • Create staff account
      • Delete staff account
      • Resend staff account invite
      • Cancel staff account invite
    • Application
      • Get app subscription status
      • Cancel app subscription
      • Get all app storage data
      • Get specific app storage data
      • Update specific app storage data
      • Delete specific app storage data
      • Add app storage data
      • Custom charge with Ecwid billing
    • Batch requests
      • Create batch request
      • Get batch status
      • Search batch requests by status
      • Stop batch request
      • Stop and delete batch request
    • Shipping options
      • Search shipping options
      • Update shipping option
      • Create shipping option
      • Delete shipping option
    • Payment options
      • Search payment options
      • Get payment option
      • Update payment option
      • Create payment option
      • Delete payment option
    • Checkout extra fields
      • Add checkout extra fields with JavaScript
      • Manage checkout extra fields with REST API
        • Search checkout extra fields
        • Get checkout extra field
        • Update checkout extra field
        • Create checkout extra field
        • Delete checkout extra field
    • Storefront widget details
      • Get page slug and static code
      • Set base URL for storefront widgets
      • Optimize custom website SEO with better URLs
        • Enable Clean Store URLs on a custom website
        • Set Custom Page Slugs on a custom website
      • Dynamic loading for storefront widget
      • SSO (Single-Sign-On) for websites
        • Add SSO to the website
        • Customize SSO on the website
        • SSO code examples
      • Static store pages
        • Static code for home page
        • Static code for category page
        • Static code for product page

Lightspeed® 2025

On this page
  • Required access scopes
  • Path params
  • Request JSON
  • Response JSON

Was this helpful?

  1. REST API
  2. Domains

Purchase domain

POST https://app.ecwid.com/api/v3/{storeId}/domains/purchase

Required access scopes

Your app must have the following access scopes to make this request: buy_domains

Path params

All path params are required.

Param
Type
Description

storeId

number

Ecwid store ID.

Request JSON

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.

email

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.

phone

string

Phone number of domain owner.

companyName

string

The company name used in domain purchase.

Response JSON

A JSON object with the following fields:

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

object domainOwnerInfo

Domain owner details specified in purchase process

billingInfo

object billingInfo

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

email

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

phone

string

Phone number of domain owner

companyName

string

The company name used in domain purchase

billingInfo

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"

Last updated 3 months ago

Was this helpful?

State code (e.g. NY) or a region name. See valid codes here: .

https://api-docs.ecwid.com/reference/list-of-state-codes