Get Theme Task

get

https://{subdomain}.myshoplaza.com/openapi/2025-06/themes/task/{task_id}

🔒
Requires read_themes access scope. More access scope

The Get Theme Task API retrieve the status and details of a specific theme-related task.

This API is especially useful for:

Monitoring the progress of theme operations (publishing, updating, etc.)
Troubleshooting failed theme tasks
Building task status tracking interfaces

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Description	Example
`task_id`	`string`	Yes	Unique identifier of the theme task	`"task_123456789"`

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.task`	`object`	`{...}`	Detailed task object

Task Object

Parameter	Type	Example	Description
`id`	`string`	`"task_123456789"`	Unique task identifier
`store_id`	`int32`	`12345`	Store ID associated with the task
`type`	`string`	`"theme_publish"`	Type of task being performed
`status`	`int32`	`2`
`created_at`	`string`	`"2025-01-01T00:00:00Z"`	Task creation timestamp
`updated_at`	`string`	`"2025-01-01T00:05:00Z"`	Last update timestamp
`info`	`string`	`"Publishing theme v2.1"`	Additional task information
`message`	`string`	`"Publish successful"`	Status message
`manifest`	`string`	`"{\"version\":\"2.1.0\"}"`	JSON string with task details

Error Response

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

API Structure Overview

Language

Credentials

Header

URL

Click Try It! to start a request and see the response here!