Update store translation data

Requires write_translation access scope.

For more info, refer to:

PUT https://{handle}.myshopline.com/admin/openapi/v20260301/ugc/resource.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Update a store's translation data.

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

resource_listobject[] required

List of store resource information to be updated.
Maximum size: 200.
resource_type string required

The type of the resource.
content_listobject[] required

List of translation corpus corresponding to the resource.
Maximum size: 100.
resource_content string required

Translated resource content.
Example: The content of the key to the key of the cot
resource_field string required

The attribute associated with the content of resource_content. For example, if resource_content is a product title, resource_field is title.
locale string required

Language used in the market.
Example: en
market string

The primary market for the store.
Example: 2805652120189036673434
resource_id string required

The unique identifier for the resource.
For example, when resource_type is PRODUCT, this parameter value is the product ID.

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

dataobject

Response data.
fail_listobject[]

A list of updated failure information for store translation data.
resource_field string

The attribute associated with the content of resource_content. For example, if resource_content is a product title, resource_field is title.
Example: title
resource_id string

The unique identifier for the resource.
For example, when resource_type is PRODUCT, this parameter value is the product ID.
resource_type string

The type of the resource.
Example: PRODUCT
fail_cause string

Error code for the update failure.
Example: VERIFY_RESOURCE_FAIL
locale string

Language used in the market.
Example: en
market string

The primary market for the store.
Example: 2805652120189036673434
resource_content string

Translated resource content.
Example: The content of the key to the key of the cot
resource_listobject[]

A list of store transaction data that was successfully updated.
resource_content string

Translated resource content.
Example: The content of the key to the key of the cot
resource_field string

The attribute associated with the content of resource_content. For example, if resource_content is a product title, resource_field is title.
resource_id string

The unique identifier for the resource.
For example, when resource_type is PRODUCT, this parameter value is the product ID.
resource_type string

The type of the resource.
Example: PRODUCT
updated_at string

The date and time when the translation data was last updated. Format: ISO 8601.
Example: 2023-09-07T15:50:00Z
locale string

Language used in the market.
Example: en
market string

The primary market for the store.
Example: 2805652120189036673434
outdated boolean

Whether the translation data is outdated or up-to-date. If the original content has been updated but its translation has not, the translation data is considered to be outdated.

true: The translation data is outdated.

false: The translation data is up-to-date.

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

Body

Body required

{
  "resource_list": [
    {
      "resource_id": "",
      "resource_type": "",
      "content_list": [
        {
          "resource_content": "The content of the key to the key of the cot",
          "resource_field": ""
        }
      ],
      "locale": "en",
      "market": "2805652120189036673434"
    }
  ]
}

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/ugc/resource.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal