> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ResolveItemSeoTags # Package: viewer # Namespace: SeoTagsService # Method link: https://dev.wix.com/docs/api-reference/site/viewer/seo-tags/resolve-item-seo-tags.md ## Permission Scopes: View SEO Settings: SCOPE.PROMOTE.VIEW-SEO ## Introduction Resolves SEO tags for a Wix product using its slug and item type. --- ## REST API ### Schema ``` Method: resolveItemSeoTags Description: Resolves SEO tags for a Wix product using its slug and item type. URL: https://www.wixapis.com/promote/seo/v1/resolve-item-seo-tags Method: GET Method parameters: param name: itemType | type: ItemType | description: Enum representing different types of items that can have SEO tags resolved. Each item type corresponds to a specific Wix product and determines which product-specific optimization rules and schema are applied during SEO tag generation. - enum: UNKNOWN_ITEM_TYPE - Unknown item type. This value isn't used. STORES_PRODUCT - Item type for e-commerce products. Generates SEO tags optimized for product pages including product schema, pricing information, availability status, and e-commerce specific metadata. BOOKINGS_SERVICE - Item type for service-based businesses. Generates SEO tags optimized for service pages including service schema, booking information, business hours, and service specific metadata. STORES_CATEGORY - Item type for e-commerce categories. Generates SEO tags optimized for category pages including category schema, category metadata, and e-commerce specific metadata. query param name: pageUrl | type: pageUrl | description: Full canonical URL of the item page where the SEO tags are applied. param name: pagination | type: Pagination - name: prevUrl | type: string | description: URL for the previous page - name: nextUrl | type: string | description: URL for the next page - name: totalPages | type: integer | description: Total number of pages - name: currentPage | type: integer | description: Current page number query param name: slug | type: slug | description: URL-friendly version of the item's name or title. For example, if the site URL is `https://www.nike.com/shoes/air-jordans`, then the slug is `air-jordans`. Return type: ResolveItemSeoTagsResponse - name: seoTags | type: SeoTags | description: The resolved SEO tags entity containing product-specific optimized metadata. - name: id | type: string | description: Unique identifier for the SEO tags collection. - name: tags | type: array | description: Collection of SEO tags containing the complete set of metadata for the page. - name: type | type: string | description: SEO tag type. Supported values: `title`, `meta`, `script`, `link`. - name: props | type: object | description: A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value. For example: `{"name": "description", "content": "the description itself"}`. - name: meta | type: object | description: SEO tag metadata. For example, `{"height": 300, "width": 240}`. - name: children | type: string | description: SEO tag inner content. For example, ` inner content `. - name: custom | type: boolean | description: Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). - name: disabled | type: boolean | description: Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. ``` ### Examples ### Resolve Item SEO Tags ```curl curl -X GET "https://www.wixapis.com/promote/seo/v1/resolve-item-seo-tags?pageUrl=https://sneakers.com/about&itemType=STORES_PRODUCT&slug=about" \ -H 'Authorization: ' \ -H 'Content-Type: application/json' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.viewer.SeoTagsService.resolveItemSeoTags(options) Description: Resolves SEO tags for a Wix product using its slug and item type. Method parameters: param name: options | type: ResolveItemSeoTagsOptions none - name: pageUrl | type: string | description: Full canonical URL of the item page where the SEO tags are applied. - name: itemType | type: ItemType | description: Item type identifier specifying the product and content type for SEO tag generation. This determines which product-specific optimization rules and schema are applied. - enum: - UNKNOWN_ITEM_TYPE: Unknown item type. This value isn't used. - STORES_PRODUCT: Item type for e-commerce products. Generates SEO tags optimized for product pages including product schema, pricing information, availability status, and e-commerce specific metadata. - BOOKINGS_SERVICE: Item type for service-based businesses. Generates SEO tags optimized for service pages including service schema, booking information, business hours, and service specific metadata. - STORES_CATEGORY: Item type for e-commerce categories. Generates SEO tags optimized for category pages including category schema, category metadata, and e-commerce specific metadata. - name: slug | type: string | description: URL-friendly version of the item's name or title. For example, if the site URL is `https://www.nike.com/shoes/air-jordans`, then the slug is `air-jordans`. - name: pagination | type: Pagination | description: Pagination information for the item page - name: prevUrl | type: string | description: URL for the previous page - name: nextUrl | type: string | description: URL for the next page - name: totalPages | type: integer | description: Total number of pages - name: currentPage | type: integer | description: Current page number Return type: PROMISE - name: seoTags | type: SeoTags | description: The resolved SEO tags entity containing product-specific optimized metadata. - name: _id | type: string | description: Unique identifier for the SEO tags collection. - name: tags | type: array | description: Collection of SEO tags containing the complete set of metadata for the page. - name: type | type: string | description: SEO tag type. Supported values: `title`, `meta`, `script`, `link`. - name: props | type: object | description: A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value. For example: `{"name": "description", "content": "the description itself"}`. - name: meta | type: object | description: SEO tag metadata. For example, `{"height": 300, "width": 240}`. - name: children | type: string | description: SEO tag inner content. For example, ` inner content `. - name: custom | type: boolean | description: Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). - name: disabled | type: boolean | description: Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. ``` ### Examples ### resolveItemSeoTags ```javascript import { seoTags } from '@wix/seo'; async function resolveItemSeoTags(options) { const response = await seoTags.resolveItemSeoTags(options); }; ``` ### resolveItemSeoTags (with elevated permissions) ```javascript import { seoTags } from '@wix/seo'; import { auth } from '@wix/essentials'; async function myResolveItemSeoTagsMethod(options) { const elevatedResolveItemSeoTags = auth.elevate(seoTags.resolveItemSeoTags); const response = await elevatedResolveItemSeoTags(options); } ``` ### resolveItemSeoTags (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { seoTags } from '@wix/seo'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { seoTags }, // Include the auth strategy and host as relevant }); async function resolveItemSeoTags(options) { const response = await myWixClient.seoTags.resolveItemSeoTags(options); }; ``` ---