Create or update a theme file

Requires write_themes access scope.

For more info, refer to:

PUT https://{handle}.myshopline.com/admin/openapi/v20260301/themes/:theme_id/assets.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Create or update a specified theme asset file. If the file does not exist, a new one is created using the provided information.

Path Parameters

theme_id string required

The unique ID of the theme.

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

assetobject required

The theme asset file information to be created or modified. Specify one of the fields: value, src, attachment, or source_key. They cannot be used simultaneously or left all empty.
attachment string

Image in Base64 encoding format. Format: base64. Specify one of the fields: value, src, attachment, or source_key. They cannot be used simultaneously or left all empty.
Example: base64_content
key string required

The name of the theme asset file to be created or modified.
Example: assets/copied-image-store-close.png
source_key string

The name of the existing theme asset file to be copied. Specify one of the fields: value, src, attachment, or source_key. They cannot be used simultaneously or left all empty.
Example: assets/original-image-store-close.png
src string

The download URL of the theme asset file. Specify one of the fields: value, src, attachment, or source_key. They cannot be used simultaneously or left all empty.
Example: https://cdn-theme.myshopline.com/cdn/shop/prev/example/example/assets/component-blog.css
value string

The textual content of the theme asset file. Specify one of the fields: value, src, attachment, or source_key. They cannot be used simultaneously or left all empty.
Example: <p>an example</p>

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

assetobject

The information of the theme asset file.
checksum string

The MD5 checksum of the theme asset file. Format: MD5.
Example: 21cd91752e4cb57fda60099becd5ce3a224fc7fe62ba7409233a5dc5ab9556ce
content_type string

The MIME type of the theme asset file, including a type and subtype indicating the file's format. Format: MIME.
Example: application/json
created_at long

The creation time of the theme asset file, formatted as a 13-digit millisecond timestamp.
Example: 1625688873000
key string

The name of the theme asset file.
Example: config/settings_data.json
public_url string

The public URL of the theme asset file.
Example: https://cdn-theme.myshopline.com/cdn/shop/prev/example/example/assets/component-blog.css
size integer

The size of the theme asset file. Unit: bytes.
Example: 204800
theme_id string

The unique ID of the theme.
Example: 671f4c96d2682a1f5407536e
updated_at long

The update time of the theme asset file, formatted as a 13-digit millisecond timestamp.
Example: 1625688873000
check_errorsobject[]

Validation error result.
filename string

The name of the error file.
Example: assets/blog.css
message array

Error message.
Example: ["error content"]
type string

Error type.
Example: FILE

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

theme_id — path required

Authorization — header required

Body

Body required

{
  "asset": {
    "attachment": "base64_content",
    "key": "assets/copied-image-store-close.png",
    "source_key": "assets/original-image-store-close.png",
    "src": "https://cdn-theme.myshopline.com/cdn/shop/prev/example/example/assets/component-blog.css",
    "value": "<p>an example</p>"
  }
}

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/themes/theme_id/assets.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal