Get files

Requires read_files access scope.

For more info, refer to:

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

Get a list of files.

Query Parameters

page_info string

The unique identifier for pagination queries, used to locate a specific page.

This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.

For example, if the link value you obtained is <https://{handle}.myshopline.com/admin/openapi/{version}/files/files.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" , the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 .

For more information on how to use pagination, refer to Paging Mechanism.
since_id string

The ID of a specific file. Start querying files from this specified ID.

Example: 5824341616684517429
content_type string
The type of the file. Valid values are:
- IMAGE：Represents a SHOPLINE image.
- VIDEO：Represents a SHOPLINE video.
- EXTERNAL_VIDEO：Represents an external video.
- FILE：Represents a SHOPLINE file that is neither an image nor a video.
Example: IMAGE
id_list string

The unique identifiers for files to query, with multiple IDs separated by commas.

Example: 5824341616684517429,5824341616684517428
limit string

The quantity limit of files to be queried.
Value range: 1-250
Default Value: 50

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

Status Codes

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

Response Headers

link

The URL link that provides the pagination data. You can obtain page_info from this parameter for subsequent pagination requests.

This parameter is returned when the requested page has a previous or next page.

For more information on how to use pagination, refer to Paging Mechanism.
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

filesobject[]

A list of files.
alt string

Words or phrases that share the characteristics or content of the image.
Example: This is an image alt
available boolean

Indicates whether the file is available. Valid values are:

ture：available

false：not available
content_type string

The type of the file. Valid values are:

IMAGE：Represents a SHOPLINE image.

VIDEO：Represents a SHOPLINE video.

EXTERNAL_VIDEO：Represents an external video.

FILE：Represents a SHOPLINE file that is neither an image nor a video.
cover_image string

The URL of the cover image.
id string

The unique identifier for the file.
Example: 5824341616684517429
url string

The URL of the file.
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

page_info — query

since_id — query

content_type — query

id_list — query

limit — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/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'

Was this article helpful to you?

SHOPLINE

Legal