In this guide, you'll learn how to overwrite an automatic message translation from the catalog, such as a product name or a product description, with a more specific and representative content of your store.

Catalog messages are translatable text strings related to a store catalog, stored as external data in the Catalog API, which manages a store's sales channels, categories, brands, products, SKUs, and specifications.

The following list includes the translatable Catalog API settings, which can be automatically translated into different languages based on the user locale.

• Category: Name, keywords (similar words), page title (tag title), meta tag description, and the URL slug (cross-border stores only).
• Brand: Name, keywords (similar words), page title (tag title), meta tag description, and the URL slug (cross-border stores only).
• Product: Name, keywords (similar words), page title (tag title), description, short description, meta tag description, and the URL slug (cross-border stores only).
• SKU: Name.
• SKU or product specification: Name, description, and values.
• Category group: Name.

Considering literal translations and cultural factors, you may want to overwrite automatic translations with content that is specific and representative of your store. This can be done through the catalog-graphql app, which is the GraphQL interface of the Catalog API, by following the instructions below.

To translate text messages from your store catalog, follow these steps:

1. Install the vtex.admin-graphql-ide@3.x app using your terminal.
2. In the Admin VTEX, go to Store Settings > Storefront > GraphQL IDE.
3. From the dropdown list, choose the vtex.catalog-graphql app.
4. Click Query variables at the bottom of the page.

5. Based on your scenario, check the sections (category, brand, product, SKU, SKU or product specification, specification values) for orientations on how to complete the main text box and the Query variables section.
6. After adjusting your query, click the play button to run the declared mutation. The expected response is a boolean value indicating true.

Below is an example of the complete process of the automatic translation of a product name:

See how to complete the main text box and the Query variables section when configuring your catalog translation.

Mutation

Complete the main text box with the following mutation command:

Query variables

Complete the Query variables section with the desired translations for each parameter.

• id: Category ID. Every category in your store has a unique ID, which can be found under Catalog > Categories in the VTEX Admin.

• name: Category name.

• title: Meta title for the category page.

• description: Detailed description of the category.

• keywords: Object containing the translations of each similar word for the category.

• linkId: The textLink (must not be translated unless your store is cross-border).

• locale: Target translation locale.

  If you have a cross-border store, the linkId serves as the category URL slug. The Rewriter app will automatically create an alias using the translated slug for each target locale and store it in the resolveAs field for that locale's internal route. For example, a category with the slug eletronics at http://{storename}.com/us/eletronics/d could have the translated slug eletronicos for the pt-BR binding, as in http://{storename}.com/br/eletronicos/d.

Mutation

Complete the main text box with the following mutation command:

Query variables

Complete the Query variables section with the desired translations for each parameter.

• id: Brand ID. Every brand in your store has a unique ID that can be found under Catalog > Brands in the VTEX Admin.
• name: Brand name.
• text: Brand description (meta tag description).
• siteTitle: Brand page title (tag title).
• keywords: Object containing the translations of each similar word for the brand.
• locale: Target translation locale.

Mutation

Complete the main text box with the following mutation command:

Query variables

Complete the Query variables section with the desired translations for each parameter.

• id: Product ID. Every product in your store has a unique ID, which can be found under Catalog > Products and SKUs in the VTEX Admin.

• name: Product name.

• description: Product description.

• shortDescription: Additional short description.

• title: Page title (tag title)

• metaTagDescription: Description (meta tag description).

• keywords: Object containing the translations of each similar word for the product.

• linkId: The textLink (must not be translated unless your store is cross-border).

• locale: Target translation locale.

  If you have a cross-border store, the linkId serves as the product URL slug. The Rewriter app will automatically create an alias using the translated slug for each target locale and store it in the resolveAs field for that locale's internal route. For example, a product with the slug blue-top-retro-camera at http://{storename}.com/us/blue-top-retro-camera/p could have the translated slug camera-retro-azul for the pt-BR binding, as in http://{storename}.com/br/camera-retro-azul/p.

Mutation

Complete the main text box with the following mutation command:

Query variables

Complete the Query variables section with the desired translations for each parameter.

• id: SKU ID. Every product in your store has a unique ID, which can be found under Catalog > Products and SKUs in the VTEX Admin.
• name: SKU name.
• locale: Target translation locale.

Mutation

Complete the main text box with the following mutation command:

Query variables

Complete the Query variables section with the desired translations for each parameter.

• fieldId: The ID for a product or SKU specification. Every product or SKU specification in your store has a unique ID, which can be found following the instructions for SKU specifications or product specifications.
• name: Specification name.
• locale: Target translation locale.

Mutation

Complete the main text box with the following mutation command:

Query variables

Complete the Query variables section with the desired translations for each parameter.

• fieldId: The ID for a product or SKU specification. Every product or SKU specification in your store has a unique ID, which can be found following the instructions for SKU specifications or product specifications.

• fieldValuesNames: An object containing:

• id: Specification value ID.

• name: Specification value name.

• locale: Target translation locale.

  You can retrieve ID values by running the following query:

  
  

  _10

  query{

  _10

  fieldValues(fieldId:"24"){

  _10

  fieldValueId

  _10

  value

  _10

  }

  _10

  }

  
  

  Where fieldId is the specification ID, which you can find following the guide Products and SKU Specifications.

Mutation

Complete the main text box with the following mutation command:

Query variables

Complete the Query variables section with the desired translations for each parameter.

• groupId: Category group ID.

• name: Category group name.

• locale: Target translation locale.

  You can retrieve category group IDs by running the following query:

  
  

  _10

  query{

  _10

  groupsByCategory(categoryId:1){

  _10

  id

  _10

  name

  _10

  }

  _10

  }

  
  

  Where categoryId is the ID of the category related to that group.