Query store translation data in bulk

Requires read_translation access scope.
For more info, refer to:
access permission.
POST https://{handle}.myshopline.com/admin/openapi/v20260301/ugc/resources.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 .
Query a store's translation data in bulk.
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
  • outdated boolean
    Query outdated or up-to-date translation data. If the original content has been updated but the translation hasn't, the translation is marked as outdated.
    • true: Query outdated translation data.
    • false: Query up-to-date translation data.
    Example: true
  • resource_listobject[] required
    List of store resource information.
  • resource_type string required
    The type of the resource.
    Example: PRODUCT.
    Example: PRODUCT
  • resource_id string required
    The unique identifier for the resource.
    For example, when resource_type is PRODUCT, this parameter value is the product ID.
    Example: 1636453548928
  • locale string
    Language used in the market.
    For example: en.
    Example: en
  • market string
    A specific market for the store.
    Example: 2805652120189036673434
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.
  • resource_listobject[]
    List of store resource information.
  • content_listobject[]
    List of translation corpus corresponding to the resource.
  • resource_field string
    The attribute associated with the content of resource_content. For example, if resource_content returns a product title, resource_field returns title.
    Example: title
  • updated_at string
    Update time of corpus translation.
    Example: 2023-09-07T15:50:00Z
  • locale string
    Language used in the market.
    For example: en.
    Example: en
  • market string
    A specific market for the store.
    Example: 2805652120189036673434
  • outdated boolean
    Query outdated or up-to-date translation data. If the original content has been updated but the translation hasn't, the translation is marked as outdated.
    • true: Query outdated translation data.
    • false: Query up-to-date translation data.
  • resource_content string
    Translated resource content.
  • resource_content_type string
    The data type of the content returned by resource_content. For example, if resource_content returns the product title Multi-color stitching dress, resource_content_type returns STRING.
    Valid values are:
    • STRING: String
    • JSON_STRING: JSON string
    • LIST_MULTI_LINE_TEXT_FIELD: Multi-line text list
    • LIST_SINGLE_LINE_TEXT_FIELD: Single-line text list
    • LIST_URL: URL list
    • SINGLE_LINE_TEXT_FIELD: Single-line text
    • LIST_FILE_REFERENCE: File reference list
    • HTML: HTML
    • JSON: JSON data
    • URL: URL
    • FILE_REFERENCE: File Reference
    • MULTI_LINE_TEXT_FIELD: Multi-line text
    • RICH_TEXT_FIELD: Rich text
    • INLINE_RICH_TEXT: Inline rich text
  • default_content_listobject[]
    Original untranslated corpus content list.
  • resource_content string
    The original corpus of the resource.
    Example: Title content
  • resource_content_type string
    The data type of the content returned by resource_content. For example, if resource_content returns the product title Multi-color stitching dress, resource_content_type returns STRING.
    Valid values are:
    • STRING: String
    • JSON_STRING: JSON string
    • LIST_MULTI_LINE_TEXT_FIELD: Multi-line text list
    • LIST_SINGLE_LINE_TEXT_FIELD: Single-line text list
    • LIST_URL: URL list
    • SINGLE_LINE_TEXT_FIELD: Single-line text
    • LIST_FILE_REFERENCE: File reference list
    • HTML: HTML
    • JSON: JSON data
    • URL: URL
    • FILE_REFERENCE: File Reference
    • MULTI_LINE_TEXT_FIELD: Multi-line text
    • RICH_TEXT_FIELD: Rich text
    • INLINE_RICH_TEXT: Inline rich text
    Example: STRING
  • resource_field string
    The attribute associated with the content of resource_content. For example, if resource_content returns a product title, resource_field returns title.
    Example: title
  • resource_id string
    The identifier for resource object.
    Example: When resource_type is PRODUCT, it represents the product ID.
    Example: 1636453548928
  • resource_type string
    The type of the resource.
    Example: PRODUCT.
    Example: PRODUCT
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required

Body

required
{
  "locale": "en",
  "market": "2805652120189036673434",
  "outdated": true,
  "resource_list": [
    {
      "resource_type": "PRODUCT",
      "resource_id": "1636453548928"
    }
  ]
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/ugc/resources.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Query a store's translation data in bulk.
Request
{
  "resource_list": [
    {
      "resource_id": "16065430418665688337653510",
      "resource_type": "PRODUCT"
    }
  ]
}
Response
{
  "data": {
    "resource_list": [
      {
        "resource_id": "16065430418665688337653510",
        "resource_type": "PRODUCT",
        "content_list": [],
        "default_content_list": [
          {
            "resource_content": "content",
            "resource_content_type": "STRING",
            "resource_field": "title"
          },
          {
            "resource_field": "subtitle",
            "resource_content": "content",
            "resource_content_type": "STRING"
          },
          {
            "resource_content": "<p class=\"indIKd GW0XC cS4Vcb-pGL6qe-fwJd0c\">content</p>",
            "resource_content_type": "HTML",
            "resource_field": "body_html"
          },
          {
            "resource_content": "content",
            "resource_content_type": "STRING",
            "resource_field": "meta_title"
          },
          {
            "resource_content_type": "STRING",
            "resource_field": "meta_description",
            "resource_content": "content"
          }
        ]
      }
    ]
  }
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.