Initiate a file staged upload

Requires write_files access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20260301/files/upload.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 .

Initiate a staged upload for multiple files. This API will return the upload credentials necessary for future upload operations.

Caution: This API is undergoing internal testing. If you need to access this API, contact your account manager to apply for whitelist inclusion.

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

file_infoobject[] required

A list of information about the files.
file_name string required

The name of the file.
Maximum length: 255
Example: file_name
file_size long

The size of the file, in bytes. Required when the file type is a video.
Example: 300
mime_type string required

The MIME type of the file. Valid values are:

image/jpeg

image/png

image/bmp

image/webp

image/svg+xml

image/x-icon

video/mp4

video/webm

video/quicktime

application/pdf

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

text/csv

application/vnd.openxmlformats-officedocument.wordprocessingml.document

font/ttf

font/woff

font/otf

font/sfnt

application/font-sfnt

audio/mpeg

text/html

text/javascript

application/javascript

text/css

application/json

application/xml

text/xml

text/plain

application/octet-stream

application/x-rar-compressed

application/zip

Example: string

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

signsobject[]

A list of signature information for the files.
access_id string

Access key for the upload signature.
Example: LTAI5tRrVqCocJKdSpEovixm
call_back string

Callback parameters for the file load.
Example: eyJjYWxsYmFja0JvZHkiOiJidWNrZXQ9JHtidWNrZXR9Jm9iamVjdD0ke29iamVjdH0mc2l6ZT0ke3NpemV9JmNvbnRlbnRUeXBlVHlwZT0ke2NvbnRlbnRUeXBlVHlwZX0mZm9ybWF0PSR7aW1hZ2VJbmZvLmZvcm1hdH0mYml6dHlwZT1cIm9wZW5hcGlTdGFzaENoYW5nZUxpbmtcIiIsImNhbGxiYWNrQm9keVR5cGUiOiJhcHBsaWNhdGl
host string

The base URL endpoint where the file will be uploaded.
Example: https://sl-resource-tmp-sg.s3.xxx.com
key string

Relative path for storing the file, including the filename.
Example: temp/file/store/1626235806828/6991265004189666341/image.jpg
policy string

Signature policy information for the file upload.
Example: eyJleHBpcmF0aW9uIjoiMjAyNi0wNS0xMlQwODo1Mjo1NloiLCJjb25kaXRpb25zIjpbWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsMCwyMDk3MTUyMF0sWyJlcSIsIiRrZXkiLCJ0ZW1wL2ZpbGUvc3RvcmUvMTYyNjIzNTgwNjgyOC82OTkxMjY1MDA0MTg5NjY2MzQxLzAwMDQ5ZWEzNDQ4ZTQzMWM4YTRiYzVh
signature string

Signature for the upload request.
Example: 6+YHcWnLhu0YofPIzAQUaZ9kKZI=
url string

A staged upload URL.
Example: 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

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "file_info": [
    {
      "file_name": "file_name",
      "file_size": 300,
      "mime_type": "string"
    }
  ]
}

Language

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

Examples

Initiate a file staged upload

Request

{
  "file_info": [
    {
      "file_name": "my video",
      "file_size": "2000",
      "mime_type": "video/mp4"
    },
    {
      "file_name": "my image",
      "file_size": "50",
      "mime_type": "image/png"
    }
  ]
}

Response

{
  "signs": [
    {
      "access_id": "LTAI5tNjm7fr4EUCoEps4UPE",
      "call_back": "eyJjYWxsYmFja0JvZHkiOiJidWNrZXQ9JHtidWNrZXR9Jm9iamVjdD0ke29iamVjdH0mbWltZVR5cGU9JHttaW1lVHlwZX0mc2l6ZT0ke3NpemV9JmNvbnRlbnRUeXBlVHlwZT0ke2NvbnRlbnRUeXBlVHlwZX0mZm9ybWF0PSR7aW1hZ2VJbmZvLmZvcm1hdH0mYml6dHlwZT1cIm9wZW5hcGlTdGFzaENoYW5nZUxpbmtcIiIsImNhbGxiYWNrQm9keVR5cGUiOiJhcHBsaWNhdGlvbi9qc29uIiwiY2FsbGJhY2tVcmwiOiJodHRwczovL2FwaS1vc3Nub3RpZnktc2ctcHJldmlldy5teXNob3BsaW5lLmNvbS9hcGkvc2lnbmF0dXJlL29zcy9wb3N0L25vdGlmeSJ9Cg==",
      "host": "https://sl-resource-tmp-sg.s3.xxx.com",
      "key": "temp/file/store/1672369729606/6995259736325891187/video.mp4",
      "policy": "eyJleHBpcmF0aW9uIjoiMjAyNS0wNS0yMlQwMzowMToyMFoiLCJjb25kaXRpb25zIjpbWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsMCwyMDk3MTUyMF0sWyJlcSIsIiRrZXkiLCJ0ZW1wL2ZpbGUvc3RvcmUvMTY3MjM2OTcyOTYwNi82OTk1MjU5NzM2MzI1ODkxMTg3L3ZpZGVvLm1wNCJdLFsiaW4iLCIkY29udGVudC10eXBlIixbInZpZGVvL21wNCJdXSxbImVxIiwiJGNhbGxCYWNrIiwiZXlKallXeHNZbUZqYTBKdlpIa2lPaUppZFdOclpYUTlKSHRpZFdOclpYUjlKbTlpYW1WamREMGtlMjlpYW1WamRIMG1iV2x0WlZSNWNHVTlKSHR0YVcxbFZIbHdaWDBtYzJsNlpUMGtlM05wZW1WOUptTnZiblJsYm5SVWVYQmxWSGx3WlQwa2UyTnZiblJsYm5SVWVYQmxWSGx3WlgwbVptOXliV0YwUFNSN2FXMWhaMlZKYm1adkxtWnZjbTFoZEgwbVltbDZkSGx3WlQxY0ltOXdaVzVoY0dsVGRHRnphRU5vWVc1blpVeHBibXRjSWlJc0ltTmhiR3hpWVdOclFtOWtlVlI1Y0dVaU9pSmhjSEJzYVdOaGRHbHZiaTlxYzI5dUlpd2lZMkZzYkdKaFkydFZjbXdpT2lKb2RIUndjem92TDJGd2FTMXZjM051YjNScFpua3RjMmN0Y0hKbGRtbGxkeTV0ZVhOb2IzQnNhVzVsTG1OdmJTOWhjR2t2YzJsbmJtRjBkWEpsTDI5emN5OXdiM04wTDI1dmRHbG1lU0o5Q2c9PSJdLFsiaW4iLCIkeC1vc3MtY29udGVudC10eXBlIixbImZvcm0tZmllbGQtbnVsbCJdXV19Cg==",
      "signature": "yZ7+COvtdMCuVlTLJNcjZWsiONw=",
      "url": "https://sl-resource-tmp-sg.s3-ap-southeast-1.xxx.com/temp%2Ffile%2Fstore%2F1672369729606%2F6995259736325891187%2Fvideo.mp4?Expires=1747882880&OSSAccessKeyId=LTAI5tNjm7fr4EUCoEps4UPE&Signature=PfJxZps6aSlO7%2FROX3r9ePiBAls%3D"
    },
    {
      "access_id": "LTAI5tNjm7fr4EUCoEps4UPE",
      "call_back": "eyJjYWxsYmFja0JvZHkiOiJidWNrZXQ9JHtidWNrZXR9Jm9iamVjdD0ke29iamVjdH0mbWltZVR5cGU9JHttaW1lVHlwZX0mc2l6ZT0ke3NpemV9JmNvbnRlbnRUeXBlVHlwZT0ke2NvbnRlbnRUeXBlVHlwZX0mZm9ybWF0PSR7aW1hZ2VJbmZvLmZvcm1hdH0mYml6dHlwZT1cIm9wZW5hcGlTdGFzaENoYW5nZUxpbmtcIiIsImNhbGxiYWNrQm9keVR5cGUiOiJhcHBsaWNhdGlvbi9qc29uIiwiY2FsbGJhY2tVcmwiOiJodHRwczovL2FwaS1vc3Nub3RpZnktc2ctcHJldmlldy5teXNob3BsaW5lLmNvbS9hcGkvc2lnbmF0dXJlL29zcy9wb3N0L25vdGlmeSJ9Cg==",
      "host": "https://sl-resource-tmp-sg.s3.xxx.com",
      "key": "temp/file/store/1672369729606/6995259736342668404/image.png",
      "policy": "eyJleHBpcmF0aW9uIjoiMjAyNS0wNS0yMlQwMzowMToyMFoiLCJjb25kaXRpb25zIjpbWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsMCwxMDQ4NTc2MF0sWyJlcSIsIiRrZXkiLCJ0ZW1wL2ZpbGUvc3RvcmUvMTY3MjM2OTcyOTYwNi82OTk1MjU5NzM2MzQyNjY4NDA0L2ltYWdlLnBuZyJdLFsiaW4iLCIkY29udGVudC10eXBlIixbImltYWdlL3BuZyJdXSxbImVxIiwiJGNhbGxCYWNrIiwiZXlKallXeHNZbUZqYTBKdlpIa2lPaUppZFdOclpYUTlKSHRpZFdOclpYUjlKbTlpYW1WamREMGtlMjlpYW1WamRIMG1iV2x0WlZSNWNHVTlKSHR0YVcxbFZIbHdaWDBtYzJsNlpUMGtlM05wZW1WOUptTnZiblJsYm5SVWVYQmxWSGx3WlQwa2UyTnZiblJsYm5SVWVYQmxWSGx3WlgwbVptOXliV0YwUFNSN2FXMWhaMlZKYm1adkxtWnZjbTFoZEgwbVltbDZkSGx3WlQxY0ltOXdaVzVoY0dsVGRHRnphRU5vWVc1blpVeHBibXRjSWlJc0ltTmhiR3hpWVdOclFtOWtlVlI1Y0dVaU9pSmhjSEJzYVdOaGRHbHZiaTlxYzI5dUlpd2lZMkZzYkdKaFkydFZjbXdpT2lKb2RIUndjem92TDJGd2FTMXZjM051YjNScFpua3RjMmN0Y0hKbGRtbGxkeTV0ZVhOb2IzQnNhVzVsTG1OdmJTOWhjR2t2YzJsbmJtRjBkWEpsTDI5emN5OXdiM04wTDI1dmRHbG1lU0o5Q2c9PSJdLFsiaW4iLCIkeC1vc3MtY29udGVudC10eXBlIixbImZvcm0tZmllbGQtbnVsbCJdXV19Cg==",
      "signature": "yOdrzcc5TybeOmasArln98Z/Fi4=",
      "url": "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"
    }
  ]
}

Was this article helpful to you?

SHOPLINE

Legal