Create blog articles for the collection

Requires write_content access scope.

For more info, refer to:

POST 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 .

Create a blog in a specified blog collection (supports specifying handle and url)

Path Parameters

blog_collection_id string required

Blog collection id

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

blogobject

Blog Information
handle string required

Blog handle
Example: "create-handle"
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"
title string required

Blog Title
Example: "70626title"
digest string

Blog Summary
Example: "28086digest"
template_name string

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

Blog Author
Example: "Alvin"
content_html string

The text of the blog post, with HTML tags, limited to 5M
Example: "content of the blog"
published boolean

Whether to publish, optional values: true (publish); false (not publish)
Example: true
url string

Custom route, maximum 512 characters, eg: "/custom-url"
Example: "/custom-url"

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

blogobject

Blog Information
digest string

Blog Summary
Example: "28086digest"
published_at string

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

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

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

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

Blog handle
Example: "create-handle"
title string

Blog Title
Example: "70626title"
content_html string

The text of the blog post, with HTML tags
Example: "content of the blog"
id string

Blog id
Example: "66718d010588d64ef7d15c96"
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"
author string

Blog Author
Example: "Alvin"

API Explorer

Debugger

Base URL

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

ParamOptions

blog_collection_id — path required

Authorization — header required

Body

Body required

{
  "blog": {
    "image": {
      "alt": "\"21933Alt\"",
      "src": "\"https://img-preview-va.myshopline.com/image/store/3400001642/1624538086300/30e35c9beb4e4be5b3ef336954dcdc14.jpg?w=626&h=417\""
    },
    "published_at": "\"2024-06-25T11:15:47+08:00\"",
    "url": "\"/custom-url\"",
    "author": "\"Alvin\"",
    "published": true,
    "template_name": "\"templates/blogs/detail.a2c29192484301fa.json\"",
    "content_html": "\"content of the blog\"",
    "digest": "\"28086digest\"",
    "title": "\"70626title\"",
    "handle": "\"create-handle\""
  }
}

Language

curl --request POST \
     --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