创建文件

需要 write_files 权限点。

更多权限点使用信息，请参考：

POST https://{handle}.myshopline.com/admin/openapi/v20260601/files/files.json

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

创建文件。

请求头

Content-Type string required

字段值固定为 application/json; charset=utf-8。
Authorization string required

资源的访问令牌。参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
例子:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

请求体

alt string

具有图片特征或内容的单词或短语。
最大长度限制：255
例子: This is a file alt
content_type string required
文件的类型。有效枚举值包含：
- IMAGE：表示一个 SHOPLINE 图像。
- VIDEO：表示一个 SHOPLINE 视频。
- EXTERNAL_VIDEO：表示一个外部视频。
- FILE：表示一个 SHOPLINE 文件，非图片和视频。
例子: IMAGE
cover_imageobject

视频封面图配置。当 content_type 为 VIDEO 或 EXTERNAL_VIDEO 时，该参数必传。
imageobject

自定义封面图信息。当 source 为 UPLOADED 时该参数必传。支持的图片格式：GIF、JPG、JPEG、PNG、WebP、和 SVG。
src string

自定义封面图的链接，以 URL 形式展示。
最大长度限制：255
例子: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
source string

封面图来源类型。有效枚举值包含：

VIDEO_FRAME_CAPTURE：使用视频单帧截取。

UPLOADED：传入封面图。
video_frame_ms integer

视频单帧截取的毫秒数。仅当 source 为 VIDEO_FRAME_CAPTURE 时该传参有效。

默认值：0（表示截取视频首帧，图片格式默认为 PNG）。
duplicate_resolution_mode string
文件名称冲突解决策略。有效枚举值包含：
- APPEND_UUID：自动重命名模式。如果文件名已被使用，则在原文件名后附加一个 UUID。
- RAISE_ERROR：报错模式。如果文件名已被使用，则抛出一个错误。
默认值：APPEND_UUID
file_name string

文件的名称。
最大长度限制：255
例子: This is a file name
original_source string required

一个外部链接（仅适用于图像）或一个预占文件访问链接。
例子: https://sl-resource-tmp-sg.s3-ap-southeast-1.xxx.com/temp%2Ffile%2Fstore%2F1672369729606%2F6995259736342668404%2Fimage.png?Expires=1747882880&OSSAccessKeyId=LTAI5tNjm7fr4EUCoEps4UPE&Signature=kLIWPCVwWTQMZcHUWyszjoH4DPM%3D

状态码

更多状态码信息，参考 HTTP 状态码。

响应头

traceId

请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。

响应体

alt string

具有图片特征或内容的单词或短语。
最大长度限制：255
例子: This is an image alt
content_type string
文件的类型。有效枚举值包含：
- IMAGE：表示一个 SHOPLINE 图像。
- VIDEO：表示一个 SHOPLINE 视频。
- EXTERNAL_VIDEO：表示一个外部视频。
- FILE：表示一个 SHOPLINE 文件，非图片和视频。
file_name string

文件的名称。
例子: This is a file name
id string

文件的唯一标识 ID。
例子: 5824341616684517429

API Explorer

调试台

示例代码

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "alt": "This is a file alt",
  "content_type": "IMAGE",
  "cover_image": {
    "image": {
      "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
    },
    "source": null,
    "video_frame_ms": 0
  },
  "duplicate_resolution_mode": null,
  "file_name": "This is a file name",
  "original_source": "https://sl-resource-tmp-sg.s3-ap-southeast-1.xxx.com/temp%2Ffile%2Fstore%2F1672369729606%2F6995259736342668404%2Fimage.png?Expires=1747882880&OSSAccessKeyId=LTAI5tNjm7fr4EUCoEps4UPE&Signature=kLIWPCVwWTQMZcHUWyszjoH4DPM%3D"
}

Language

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

这篇文章对你有帮助吗？

SHOPLINE

条款协议