Get the ugc corpus

Requires read_translation access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/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 .

[]

Query User-Generated Content (UGC)

Query Parameters

locale string
[]
Business multi-language value
[]
Example: en
market string
[]
Business market value
[]
Example: 2805652120189036673434
outdated boolean
[]
The state of the state of the state
[]
Example: true
resource_id string required
[]
Business multi language resources unique master key
[]
Example: 1636453548928
resource_type string required
[]
Business multi-language resource type
[]
Example: PRODUCT

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

dataobject
[]
Response results
content_listobject[]
[]
List of translated post-it
locale string
[]
Business multi-language value
[]
Example: en
market string
[]
Business market value
[]
Example: 2805652120189036673434
outdated boolean
[]
Obsolete
resource_content string
[]
Resources content
[]
Example: The content of the key to the key of the cot
resource_content_type string
[]
Detailed breakdown of field types corresponding to resources.
[]
Example: If resource_content_type returns Html, then the field type breakdown for the resource is in HTML format.
resource_field string
[]
Business multi-language resources fields
[]
Example: title
updated_at string
[]
Cotton core update time
[]
Example: 2023-09-07T15:50:00Z
default_content_listobject[]
[]
Default post list of the post
resource_content string
[]
Resources content
[]
Example: Title content
resource_content_type string
[]
Detailed breakdown of field types corresponding to resources.
[]
Example: If resource_content_type returns Html, then the field type breakdown for the resource is in HTML format.
resource_field string
[]
Business multi-language resources fields
[]
Example: title
resource_id string
[]
Business multi language resources unique master key
[]
Example: 1636453548928
resource_type string
[]
Business multi-language resource type
[]
Example: PRODUCT

API Explorer

Debugger

Base URL

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

ParamOptions

resource_id — query required

resource_type — query required

Authorization — header required

locale — query

market — query

outdated — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/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