Version: 202701
List customization templates
GET/openapi/2027-01/customization/templates
Returns a paginated list of reusable customization templates for the current store.
Request
Query Parameters
cursor string
Cursor for pagination
page_size int32
A limit on the number of objects to return. Range: 1-100 (default is 20)
page int32
Page number (1-based). Mutually exclusive with cursor
name string
Filter templates by name (fuzzy match)
Responses
- 200
OK
- application/json
- Schema
- Example
Schema
- Array [
- ]
codestring
error code
messagestring
error message
data object
templates object[]
Template list
idstring
Template ID
namestring
Template name
image object
Template cover image
srcstring
Image URL
widthint32
Image width in pixels
heightint32
Image height in pixels
updated_atstring
Last updated time, ISO 8601
related_product_countint32
Number of customizable products linked to this template
cursorstring
Cursor for the next page; empty when there are no more pages
has_moreboolean
Whether more records follow this page
totalint32
Total number of templates across all pages
json
{
"code": "string",
"message": "string",
"data": {
"templates": [
{
"id": "string",
"name": "string",
"image": {
"src": "string",
"width": 0,
"height": 0
},
"updated_at": "string",
"related_product_count": 0
}
],
"cursor": "string",
"has_more": true,
"total": 0
}
}