Product Translations API v2

Products may be translated into other languages with optional regional variances. 

Scopes

Access to the Product Translations API requires that the client have the following scopes granted:

  • products - Permits write access to add, update or remove product translations.
  • products.readonly - Read only access to search or get product translation data.

The Product Translation object

Translation property values are optional and default to null. When null , a translation's property will inherit data from the Product object's property with the same name.

alias
The translation of the Product's alias.
country
Accepts an ISO 3166 country code (e.g. CA) or null.
Use the country to target the translation with a language's regional variance. For example, Canadian French.
Defaults to null.
createdBy read-only
An integer representing the ID of the user who created the object.
This may be set to null if the object was created by an App or via import.
createdOn read-only
The date and time the object was created.
description
The translation of the Product's description. 
discontinuedReason
The translation of the Product's discontinuedReason. 
id
The ID for the translation.
language required
Accepts an ISO 639-1 country code (e.g. fr)
metaDescription
The translation of the Product's metaDescription. 
metaKeywords
The translation of the Product's metaKeywords. 
metaTitle
The translation of the Product's metaTitle. 
model
The translation of the Product's model. 
modifiedBy read-only
An integer representing the ID of the user who last modified the object.
This may be set to null if the object was created by an App or via import.
modifiedOn read-only
The date and time the object was last modified.
productId
The ID of the Product the translation relates to.
range
The translation of the Product's range. 
title
The translation of the Product's title. 

List/search Translations for a given Product

GET /api/v2/products/{productId}/translations.json

Get or search for one or more translations associated with a Product using a range of accepted query parameters.

Requires either the products or products.readonly OAuth scope.

URL parameters

productId required
The product ID is required.


Query Parameters

id:in
Return translations for a product by a comma-separated list of translation IDs.
id:min
Return translations with an ID greater than or equal to that specified.
id:max
Return translations with an ID less than or equal to that specified.
id:after
Return translations with an ID greater than that specified.
id:before
Return translations with an ID less than that specified.
language
Return translations matching a language code (e.g. fr)
country
Return translations matching a country code (e.g. CA).


JSON response

Evance will return a JSON object containing the following properties:

success
A successful search request containing zero or more results will always return a true value.
status
An integer matching the HTTP response code. A successful request will have a status of 200.
data
An array containing zero or more Product Translation data objects.
pagination
Search results include a pagination object contain information about the current page, total pages, the limit per page and the total number of results available.
  • limit - the number of results to return per page
  • page - the current page number
  • total - the total number of available results
  • totalPages - the total number of available pages of results
links
An object containing links to traverse available search results.
  • self - the URL for the current search.
  • previous - a URL for the previous results page, or null if there isn't one.
  • next - a URL for the next results page, or null if there isn't one


Example JSON response

In the example below you're able to see examples of a product translation returned in this API.

{
    "success": true,
    "status": 200,
    "data": [
        {
            "id": 14,
            "productId": 108961,
            "title": "Test product translation 6a59310f2c5f4",
            "alias": null,
            "description": null,
            "metaTitle": null,
            "metaDescription": null,
            "metaKeywords": null,
            "range": null,
            "model": null,
            "discontinuedReason": null,
            "language": "es",
            "country": null,
            "createdOn": "2026-07-16T19:29:19+00:00",
            "createdBy": null,
            "modifiedOn": "2026-07-16T19:29:19+00:00",
            "modifiedBy": null
        }
    ],
    "pagination": {
        "page": 1,
        "limit": 100,
        "total": 1,
        "totalPages": 1
    },
    "links": {
        "self": "https://examples.evance.me/api/v2/products/3066/translations.json",
        "previous": null,
        "next": null
    }
}

Get a single Product Translation

GET /api/v2/products/{productId}/translations/{id}.json

Retrieve a single Product Translation using its ID.

Requires either the products or products.readonly OAuth scope.

URL parameters

id required
The ID of the Product Translation is supplied as a path parameter.
productId required
The ID of the Product is supplied as a path parameter.


Response

Returns an object with the following properties:

success
A boolean where a value of true represents a successful request.
status
The HTTP status code e.g. 200 for a successful request.
data
Contains the Product Translation object.


Example JSON response

{
    "success": true,
    "status": 200,
    "data": {
        "id": 14,
        "productId": 108961,
        "title": "Test product translation 6a59310f2c5f4",
        "alias": null,
        "description": null,
        "metaTitle": null,
        "metaDescription": null,
        "metaKeywords": null,
        "range": null,
        "model": null,
        "discontinuedReason": null,
        "language": "es",
        "country": null,
        "createdOn": "2026-07-16T19:29:19+00:00",
        "createdBy": null,
        "modifiedOn": "2026-07-16T19:29:19+00:00",
        "modifiedBy": null
    }
}


Add a Product Translation

POST /api/v2/products/{productId}/translations.json

Add a Translation for a Product.

Requires the products OAuth scope.

URL parameters

productId required
The ID of the Product is supplied as a path parameter.


Request body

Your request body must contain an object including:

data required
Containing a Product Translation object.


Example: minimum requirements

A translation requires a language and any one of the translation properties. In the example below we'll add a Spanish translation for a Product titled "Raspberry Gin".

{
    "data": {
        "language": "es",
        "title": "Ginebra de frambuesa" 
    } 
}

Success response

If the Product Translation was created successfully you should receive a response with a 201 status code:

success
A boolean where a value of true means the object was created successfully.
status
The HTTP status code e.g. 201 means the object was created successfully.
data
Contains the Product Translation object you created including its new id.


Error responses

If the Translation could not be created you will encounter a response with a 422 status code:

success
A boolean where a value of false means the object could not be created.
status
A response code of 422 means the object could not be created and you should check the errors property for further information.
context
The context property indicates where the error occurred. For a 422 error this will typically contain a value of data, indicating that there was an error with the data object supplied.
errors

Contains an array of error objects, each will have the following properties:

  • name - The property name that encountered an error.
  • message - A human readable error message.
  • ref - An error reference string (e.g. error.not-unique if the alias supplied is already in use).


Update a Product Translation

PUT /api/v2/products/{productId}/translations/{id}.json

Update an existing Product Translation by its ID.

Requires the products OAuth scope.

URL parameters

id required
The ID of your Product Translation object
productId required
The ID of your Product object


Request body

Your request body must contain an object including:

data required
Containing updates to your Product Translation object.


Example JSON request

To update a Product Translation you must PUT JSON to this resource within a data object. You do not need to supply all properties and may choose to only supply properties that require modifying. In the example below, we'll add a regional preference of Spain to a translation.

{
    "data": {
        "country": "ES"
    }
}


Success response

If the Translation was updated successfully you should receive a response with a 200 status code:

success
A boolean where a value of true means the object was saved successfully.
status
The HTTP status code e.g. 200 means the object was updated successfully.
data
Contains the Product Translation object you updated.


Error responses

If the Translation could not be updated you will encounter a response with either a 400, 404or 422status code:

success
A boolean where a value of false means the object could not be updated.
status
  • 400 may indicate that the ID was not provided.
  • 404 means Product or Translation could not be found by the IDs provided.
  • 422 means the Translation could not be updated due to errors in the data.
context
  • parameters means the error is with the required id URL parameter.
  • data indicates an error within the Translation object data.
errors

Contains an array of error objects, each will have the following properties:

  • name - The property name that encountered an error.
  • message - A human readable error message.
  • ref - An error reference string.


Delete a Product Translation

DELETE /api/v2/products/{productId}/translations/{id}.json

Delete a Product Translation by its ID.

Requires the products OAuth scope.

URL parameters

id required
The ID of your Product Translation object
productId required
The ID of your Product object


Request body

Does not require a payload

Success response

If the Translation was deleted successfully you should receive a response with a 204 status code and no body.

Error responses

If the Translation could not be deleted you may encounter a response with a 400, or 404 status code:

success
A boolean where a value of false means the object could not be deleted.
status
  • 400 may indicate that the ID was not provided, or the object could not be deleted for an unknown reason.
  • 404 indicates that the ID was provided, but the translation or product could not be found.