The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Requires
content
access scope.
The Article resource allows your app to create, publish, and edit articles on a shop's blog. Articles belong to a single blog, and can have any number of comments.
Was this section helpful?
Properties
author
->author
The name of the author of the article.
blog_id
->blogId
The ID of the blog containing the article.
body_html
->bodyHtml
The text of the body of the article, complete with HTML markup.
The ID of the article.
handle
->handle
A human-friendly unique string for the article that's automatically generated from the article's title.
The handle is used in the article's URL.
The additional information attached to an Article object. It has the following properties:
published
Whether the article is visible.
published_at
The date and time (ISO 8601 format) when the article was published.
summary_html
->summary
A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page.
tags
->tags
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
Was this section helpful?
api_version
string
required
blog_id
string
required
Was this section helpful?
Path parameters
string
required
Request body
Article resource
Was this section helpful?
api_version
string
required
Was this section helpful?
Was this section helpful?
api_version
string
required
limit
The maximum number of tags to retrieve.
popular
A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag.
Was this section helpful?
Was this section helpful?
Retrieves a list of all articles from a blog. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.
api_version
string
required
blog_id
string
required
author
Filter articles by article author.
created_at_max
Show articles created before date (format: 2014-04-25T16:15:47-04:00).
created_at_min
Show articles created after date (format: 2014-04-25T16:15:47-04:00).
fields
Show only certain fields, specified by a comma-separated list of field names.
handle
Retrieve an article with a specific handle.
limit
≤ 250
default 50
The maximum number of results to retrieve.
published_at_max
Show articles published before date (format: 2014-04-25T16:15:47-04:00).
published_at_min
Show articles published after date (format: 2014-04-25T16:15:47-04:00).
published_status
default any
Retrieve results based on their published status.
since_id
Restrict results to after the specified ID.
Was this section helpful?
Path parameters
string
required
Was this section helpful?
Retrieves a single article
api_version
string
required
article_id
string
required
blog_id
string
required
fields
Show only certain fields, specifed by a comma-separated list of field names.
Was this section helpful?
Was this section helpful?
api_version
string
required
blog_id
string
required
created_at_max
Count articles created before date (format: 2014-04-25T16:15:47-04:00).
created_at_min
Count articles created after date (format: 2014-04-25T16:15:47-04:00).
published_at_max
Count articles published before date (format: 2014-04-25T16:15:47-04:00).
published_at_min
Count articles published after date (format: 2014-04-25T16:15:47-04:00).
published_status
default any
Count articles with a given published status.
updated_at_max
Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).
updated_at_min
Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).
Was this section helpful?
Path parameters
string
required
Was this section helpful?
api_version
string
required
blog_id
string
required
limit
The maximum number of tags to retrieve.
popular
A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag.
Was this section helpful?
Was this section helpful?
api_version
string
required
article_id
string
required
blog_id
string
required
Was this section helpful?
Request body
Article resource
Was this section helpful?
api_version
string
required
article_id
string
required
blog_id
string
required
Was this section helpful?
Was this section helpful?