externalPartnerStorefrontDomainPublish

mutation

Requires write_domains access scope.

Publishes an external partner storefront hostname for the shop by creating or returning the domain ownership verification for the host. Never activates the domain.

Anchor to Arguments

Arguments

Anchor to hosthost •String! required: The host name of the storefront domain being published.

Was this section helpful?

Anchor to ExternalPartnerStorefrontDomainPublishPayload returnsExternalPartnerStorefrontDomainPublishPayload returns

Anchor to domaindomain •ExternalPartnerStorefrontDomain: The storefront domain and any required DNS changes.
Anchor to resourceCreatedresourceCreated •Boolean: Whether a new domain verification was created during the mutation.
Anchor to userErrorsuserErrors •[ExternalPartnerStorefrontDomainPublishUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

externalPartnerStorefrontDomainPublish reference

Mutation Reference

mutation externalPartnerStorefrontDomainPublish($host: String!) {

externalPartnerStorefrontDomainPublish(host: $host) {

domain {

# ExternalPartnerStorefrontDomain fields

}

resourceCreated

userErrors {

field

message

}

Input

{

"host": "<your-host>"

}