🔒
Requires read_themes access scope. More access scope

The Get Theme List API allows developers to retrieve the count of metafields associated with specified definition IDs.

This API is especially useful for:

Analyzing metafield usage across your store
Identifying frequently used definitions
Monitoring custom field adoption

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Example	Description
`code`	`string`	`"success"`	Status code of the response
`message`	`string`	`"OK"`	Descriptive message of the response
`data.count`	`int32`	`5`	Total number of themes available
`data.themes`	`array[object]`	`[{...}]`	Array of theme objects

Theme Object Parameters

Parameter	Type	Example	Description
`id`	`string`	`"theme_123"`	Theme's unique identifier
`name`	`string`	`"Summer Collection"`	Theme name
`merchant_theme_id`	`string`	`"mth_456"`	Merchant theme ID
`merchant_theme_name`	`string`	`"Premium Theme"`	Merchant theme name
`merchant_theme_info`	`string`	`"v2.1.0"`	Theme version identifier
`locale`	`string`	`"en-US"`	Theme locale
`preset`	`string`	`"modern"`	Theme style preset
`type`	`string`	`"shoplazza"`	Theme type (`shoplazza` or `developer`)
`desc`	`string`	`"Summer collection theme"`	Multi-language description
`default`	`string`	`"1"`	Whether default theme (`0` or `1`)
`pc_cover_url`	`string`	`"https://example.com/pc"`	PC cover image URL
`mobile_cover_url`	`string`	`"https://example.com/mobile`	Mobile cover image URL
`published`	`string`	`"1"`	Whether theme is published (`0` or `1`)
`is_auto_upgrade`	`string`	`"0"`	Whether auto-upgraded (`0` or `1`)
`status`	`string`	`"active"`	Theme status
`updated_at`	`string`	`"2025-01-01T00:00:00Z"`	Last update timestamp
`publish_time`	`string`	`"2025-01-01T00:00:00Z"`	Publish timestamp
`auto_save_time`	`string`	`"2025-01-01T00:00:00Z"`	Auto-save time
`theme_save_time`	`string`	`"2025-01-01T00:00:00Z"`	Last manual save time
`version`	`string`	`"2.1.0"`	Current theme version
`c_version`	`string`	`"2.0.1"`	Current client version
`change_log`	`string`	`"Bug fixes"`	Theme changelog
`version_publish_time`	`string`	`"2025-01-01T00:00:00Z"`	Version publishing time
`newest_c_version`	`string`	`"2.0.2"`	Newest available client version
`has_newest_version`	`boolean`	`true`	Whether has newest version
`has_draft`	`boolean`	`false`	Whether has unpublished changes
`theme_version_id`	`string`	`"tvi_789"`	Theme version ID

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message

API Structure Overview

200OK