post
https://{subdomain}.myshoplaza.com/openapi/2025-06/themes//doc
Requireswrite_themesaccess scope. More access scope
The Create Theme File API allows developers to create a new documentation file within a specific theme in store. It enables you to add new layout templates, snippet files, or other document types to customize your theme's structure and functionality.
This API is especially useful for:
- Adding new template files to extend your theme's functionality.
- Creating custom snippet files for reusable components.
- Uploading new theme documentation files for better organization.
- Extending your theme's capabilities with additional file types.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
theme_id | string | Yes | 1500021b-88ed-4750-bbc5-97ec98351dc0 | Theme's unique identifier. |
Body Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
|
| Yes | The document object containing file details. |
|
|
| Yes | The type of file. |
|
|
| Yes | The path location where the file should be created. |
|
Response Explanation
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 |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |