latestOpenAPI 3.1.02026-07-26102336742.6 KB

ef273312f051

Analytics Reports2

BETA: Memberships3

Carts2

Collections7

Customizations1

Design Pipeline3

Digital Products5

DNS2

postValidate DNS records
getGet DNS configuration status

Donations2

External Orders6

Fulfillment1

Gifting5

Giveaway links3

Giveaways4

Integrations5

Mailing Lists1

Media Library3

Orders4

Payouts2

Platform Tokens1

Pro Subscription1

Product Templates9

Products (offers)7

Promotions4

Sample Credits2

Shop3

Streaming3

Thank yous3

Twitch gift purchases1

Webhooks7

Webhooks

Cart Events3

Collection Events1

Giveaway Events2

Membership Events3

Newsletter Events1

Order Events4

Platform Events1

Product Events2

Promotion Events3

Thank You Events1

DNS

Get DNS configuration status

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Returns the cached DNS configuration and record status for the shop's custom domain

get/open-api/v1.0/dns

Response

domainstring

status'CONNECTED' | 'NOT_CONNECTED' | 'PARTIALLY_CONNECTED' | 'SYNCING_YOUR_DOMAIN' | 'REMOVAL_IN_PROGRESS'

dnsProviderstring

dnsProviderModestring

sslSyncedboolean