Query blog post list

Requires read_content access scope.

For more info, refer to:

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

Query blog list (return custom route)

Path Parameters

blog_collection_id string required

The id of the blog collection

Query Parameters

author string

Blog Author

Example: "Alvin"
created_at_max string

Show blogs created before this date

Example: 2014-04-25T16:15:47-04:00
created_at_min string

Show blogs created after this date

Example: 2014-04-25T16:15:47-04:00
fields string

Comma-delimited list of fields to include in the response

Example: id,handle
handle string

Blog handle

Example: "update-handle"
limit integer

The default query limit is 50 and cannot exceed 1000.

Example: 1000
published_at_max string

Show blogs published before this date

Example: 2014-04-25T16:15:47-04:00
published_at_min string

Show blogs published after this date

Example: 2014-04-25T16:15:47-04:00
published_status string

Publishing status, enumeration value: any (all); published (published); unpublished (unpublished)

Example: published
since_id string

Show blogs after this id

Example: "66718d010588d64ef7d15c96"
updated_at_max string

Show blogs updated before this date

Example: 2014-04-25T16:15:47-04:00
updated_at_min string

Show blogs updated after this date

Example: 2014-04-25T16:15:47-04:00

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

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

blogsobject[]

Blog list information
template_name string

The name of the associated template
Example: "templates/blogs/detail.a2c29192484301fa.json"
title string

Blog Title
Example: "70626title"
created_at string

Creation time ISO 8601
Example: "2024-06-18T13:34:57+00:00"
updated_at string

Updated ISO 8601
Example: "2024-06-19T12:42:55+00:00",
author string

Blog Author
Example: "Alvin"
blog_collection_id string

The id of the blog collection
Example: "64e313c4cd5956279e61d150"
handle string

Blog handle
Example: "update-handle"
custom_urlobject

Custom URLs for products on your store
is_customized string

Whether to customize
Example: true
url string

The product URL on the store, greater than or equal to 0 characters and less than or equal to 512 characters
Example: "/custom-url"
id string

Blog id
Example: "66718d010588d64ef7d15c96"
user_id string

Operator's ID
Example: "3400001642"
digest string

Blog Summary
Example: "28086digest"
imageobject

Blog cover information
alt string

Image alt
Example: "21933Alt"
src string

image link
Example: "https://img-preview-va.myshopline.com/image/store/3400001642/1624538086300/30e35c9beb4e4be5b3ef336954dcdc14.jpg?w=626&h=417"
published_at string

Release time ISO 8601
Example: "2024-06-25T11:15:47+08:00"

API Explorer

Debugger

Base URL

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

ParamOptions

blog_collection_id — path required

Authorization — header required

author — query

created_at_max — query

created_at_min — query

fields — query

handle — query

limit — query

published_at_max — query

published_at_min — query

published_status — query

since_id — query

updated_at_max — query

updated_at_min — query

Language

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