get
https://{subdomain}.myshoplaza.com/openapi/2025-06/themes//doc
Retrieve details of a specific theme's doc file using its unique identifier
Requiresread_themesaccess scope. More access scope
The Get Theme File API retrieves the content of a specific theme file. This enables users to view or manipulate the file content of their selected theme.
This API is especially useful for:
- Retrieving theme-specific layout or template files.
- Accessing and updating theme file content.
- Verifying the structure and settings of theme files.
Request Parameters
Public Request Parameters
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
|
| Yes | The unique identifier of the theme whose doc file you want to retrieve. |
|
|
| No | The type of file to retrieve. |
|
|
| No | The file's location path. Defaults to |
|
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "200" | The response status code. |
message | string | "Success" | The response message. |
data. theme_file.id | string | "file_123456789" | The ID of the retrieved theme file. |
data. theme_file.theme_id | string | "theme_123456789" | The ID of the theme this file belongs to. |
data. theme_file.type | string | "layout" | The type of the retrieved file. |
data. theme_file.location | string | "theme.liquid" | The path location of the file. |
data. theme_file.remote_url | string | "https://example.com/ files/theme.liquid" | The remote URL where the file can be accessed. |
data.theme_file.content | string | "<!DOCTYPE html>..." | The full content of the retrieved file. |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |