Install market theme

POST 
/openapi/2026-01/themes/merchant-themes/:remote_theme_id/install

Install a theme from the theme market into the current store by its market theme id. Supports specifying the theme name and style preset, and setting it as the store's default theme; if the store has no default theme yet, the installed theme becomes the default automatically.

Request

Path Parameters

remote_theme_id stringrequired

Remote theme id of the market theme to install

application/json

Body

Bodyrequired

namestring

Theme display name

defaultboolean

Set as the store default theme

presetstring

Style/preset name (from the market theme's presets)

versionstring

Theme version to install; defaults to the market theme's current version (c_version)

sourcesstring

Business source tag recorded on the installed theme. Unrelated to CopyThemeRequest.sources

admin_hiddenboolean

Hide the installed theme in the merchant admin

ext_suffixstring

Suffix appended to the extension theme's name; keep it to 15 characters or fewer

product_id_mapobject[]

Product id mappings

collection_id_mapobject[]

Collection id mappings

page_id_mapobject[]

Custom page id mappings

Example

json

{
  "name": "string",
  "default": true,
  "preset": "string",
  "version": "string",
  "sources": "string",
  "admin_hidden": true,
  "ext_suffix": "string",
  "product_id_map": [
    {}
  ],
  "collection_id_map": [
    {}
  ],
  "page_id_map": [
    {}
  ]
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

dataobject

The installed theme

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "data": {}
  }
}