Services such as Google Search Console, Google Merchant Center, Meta and Pinterest confirm that a merchant owns a store by looking for a <meta> tag on its home page. Each tag added here is shown on the home page of every storefront in the store, on all of its domains, as soon as it is added.
Only the listed providers are accepted, and only plain tokens: the storefront writes the tag itself, so markup sent to this API is never rendered. Send provider and token, or send the whole <meta> tag a service shows in tag and the provider is read from it.
An app token owns the tags it adds. Adding the same tag again returns it unchanged, so setup can be retried safely; an app can remove only its own tags, while the merchant can remove any tag in Store Admin. Uninstalling an app removes its tags. Most services re-check ownership from time to time, so remove a tag only when the service no longer needs it.
Endpoints#
List site verification tags
List the store's site verification tags and the services they can verify.
Every tag is shown as a <meta> tag on the home page of every storefront in the store, on all of its domains. providers is the closed list of services a tag can name. source is merchant or app; source_label says who added it in the request's language. max is the store's limit.
Headers
| Name | Type | Description |
|---|---|---|
Authorization
required
|
string |
Bearer Store API token. |
Errors
-
401UNAUTHORIZEDAuthorization header missing, malformed, or token invalid/expired.
-
402SUBSCRIPTION_REQUIREDThe store does not have an active or trialing subscription.
-
403STORE_API_SCOPE_REQUIREDToken is valid but lacks the required scope for this call.
-
429RATE_LIMITEDThe token's request allowance is exhausted. Retry after the Retry-After header.
Add a site verification tag
Add one verification tag to every storefront home page.
Send provider and token, or only tag with the whole <meta name="…" content="…"> the service gave you. Only listed providers and plain tokens are accepted; markup is never rendered. Adding a tag your app already added returns the existing tag. The tag appears on storefront home pages at once.
Headers
| Name | Type | Description |
|---|---|---|
Authorization
required
|
string |
Bearer Store API token. |
Body parameters
| Name | Type | Description |
|---|---|---|
provider
|
string |
Tag name of a listed service, for example google-site-verification. Required unless |
token
|
string |
The verification token. Required unless |
tag
|
string |
The whole tag the service shows, instead of provider and token. |
Errors
-
401UNAUTHORIZEDAuthorization header missing, malformed, or token invalid/expired.
-
402SUBSCRIPTION_REQUIREDThe store does not have an active or trialing subscription.
-
403STORE_API_SCOPE_REQUIREDToken is valid but lacks the required scope for this call.
-
429RATE_LIMITEDThe token's request allowance is exhausted. Retry after the Retry-After header.
-
400SITE_VERIFICATION_PROVIDER_UNKNOWNThe provider is not one of the listed services.
-
400SITE_VERIFICATION_PROVIDER_MISMATCHA pasted tag names a different provider than
provider. -
400SITE_VERIFICATION_TOKEN_INVALIDThe token is empty, too long, or contains characters other than letters, digits and _ - . : = + /.
-
409SITE_VERIFICATION_LIMIT_REACHEDThe store already has the maximum number of tags.
Remove a site verification tag
Remove one verification tag.
App tokens can remove only the tags their app added; the merchant can remove any tag in Store Admin. Remove a tag only after the service no longer needs it: most services re-check ownership from time to time.
Path parameters
| Name | Type | Description |
|---|---|---|
tagId
required
|
uuid |
Verification tag id. |
Headers
| Name | Type | Description |
|---|---|---|
Authorization
required
|
string |
Bearer Store API token. |
Errors
-
401UNAUTHORIZEDAuthorization header missing, malformed, or token invalid/expired.
-
402SUBSCRIPTION_REQUIREDThe store does not have an active or trialing subscription.
-
403STORE_API_SCOPE_REQUIREDToken is valid but lacks the required scope for this call.
-
429RATE_LIMITEDThe token's request allowance is exhausted. Retry after the Retry-After header.
-
403SITE_VERIFICATION_NOT_OWNERAn app token may only remove tags that app added.
-
404SITE_VERIFICATION_NOT_FOUNDNo tag with this id exists in the store.