VTvtex
Multi-language specification

Get specification translation

Changed on

Retrieves language-specific information for a specification by its ID.

ℹ️ Learn more in the Catalog multi-language integration guide.

Permissions

Any user or application key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
CatalogContentCategories Management
get/api/catalog/pvt/specification/{specificationId}/language/{locale}

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/catalog/pvt/specification/{specificationId}/language/{locale}
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Path parameters

specificationIdinteger required
Example:7

Unique identifier of the specification.

localestring required
Example:en-US

Code used to filter translations by a given language. The format follows the IETF BCP 47 standard, such as 'en-US' for English (United States), 'en-ES' for Spanish (Spain), or 'pt-BR' for Portuguese (Brazil).

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

Idinteger

Unique identifier of the specification.

Localestring

The locale code for this translation. It follows the IETF BCP 47 standard, such as 'en-US' for English (United States), 'en-ES' for Spanish (Spain), or 'pt-BR' for Portuguese (Brazil).

Namestring

Translated name of the specification.

Valuesstring[] nullable

List of the translated specification values.

Changes