Search store domains

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

Request and response example

Request:

curl --location 'https://app.ecwid.com/api/v3/1003/domains' \
--header 'Authorization: Bearer secret_ab***cd'

Response:

{
    "instantSiteDomain": {
        "primaryInstantSiteDomain": "1003",
        "ecwidSubdomain": "1003",
        "instantSiteIpAddress": "101.202.303.404",
        "instantSiteUrl": "https://1003.company.site"
    },
    "purchasedDomains": []
}

Required access scopes

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

Path params

All path params are required.

Param
Type
Description

storeId

number

Ecwid store ID.

Query params

All query params are optional.

Name
Type
Description

responseFields

string

Specify the exact fields to receive in response JSON. If not specified, the response JSON will have all available fields for the entity. For example: ?responseFields=instantSiteDomain(instantSiteIpAddress)

Example of using responseFields param:

curl --location 'https://app.ecwid.com/api/v3/1003/profile?responseFields=instantSiteDomain(instantSiteIpAddress)' \
--header 'Authorization: Bearer secret_ab***cd'

Headers

The Authorization header is required.

Header
Format
Description

Authorization

Bearer secret_ab***cd

Access token of the application.

Response JSON

A JSON object with the following fields:

Field
Type
Description

instantSiteDomain

Details for the currently enabled store domain.

purchasedDomains

array of objects purchasedDomains

List with details for each domain bought for the store.

instantSiteDomain

Field
Type
Description

primaryInstantSiteDomain

string

Main domain for the Instant Site, based on the ecwidSubdomain

primaryInstantSiteDomainStatus

string

Possible values: connected if the primaryInstantSiteDomain is connected to the Instant Site and works already, pending if the primaryInstantSiteDomain is still being configured

ecwidSubdomain

string

Subdomain of the default Instant Site URL.

instantSiteIpAddress

string

IP address used to connect a custom domain with the Instant Site. It's also available in the Control Panel on the #website-overview:section=mobile-domain page.

instantSiteUrl

string

Current Instant Site URL, based on the ecwidSubdomain

thirdPartyVendorDomain

string

Custom domain specified in the Control Panel settings. Has the same value as the customDomain in the Instant Site Info.

purchasedDomains

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

domainRegistrantInfo

Domain owner details specified in purchase process

billingInfo

Domain billing information

domainRegistrantInfo

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

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

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

Was this helpful?