Article
Create article
Endpoint
POST /admin/blogs/:blog_id/articles.json
Parameters
| Name | Description |
|---|---|
| article[title] required | article title |
| article[content] required | article content |
| article[notice] | notice for article |
| article[published_at] required | publication date, the article is invisible to users while publication date > current time |
| article[author] required | article author name |
| article[permalink] | permalink on blog/* |
| article[html_title] | html title tag content |
| article[meta_keywords] | html meta words on page |
| article[meta_description] | html meta description |
| article[image_attributes] | image for article |
| article[all_tags] | array of all tags for article, max 10 tags |
| article[pinned] | set to true to pin article: it will be always on the top of the blog; only one article can be pinned, so when you pin article, previously pinned article will be unpinned |
Request
Route
POST /admin/blogs/1/articles.json
Headers
Content-Type: application/json
Authorization: Basic ZGlnaXRhbC1nb29kczpjNTFjOTA3MDdhMTNjZTNmZmYyMTNhZmJiNWNkMTI3MA==Body
{
"article": {
"title": "new article",
"content": "<p>content of my article<p>",
"notice": "some notice",
"published_at": "2014-09-09",
"author": "My Name is panda",
"permalink": "first_article",
"html_title": "HTML TAG TITLE",
"meta_keywords": "new cool products",
"meta_description": "It's a article about our new products",
"image_attributes": {
"src": "https://abc.myinsales.ru/images/no_image_compact.jpg"
},
"all_tags": [
"test3",
"test4"
],
"pinned": true
}
}Response
Simulated Response
Status
201Headers
API-Usage-Limit: 1/500
Content-Type: application/json; charset=utf-8Body
{
"id": 6,
"created_at": "2024-11-21T00:57:20.000+03:00",
"updated_at": "2024-11-21T00:57:20.000+03:00",
"custom_template": null,
"published_at": "2014-09-09T00:00:00.000+04:00",
"pinned": true,
"title": "new article",
"author": "My Name is panda",
"permalink": "first_article",
"html_title": "HTML TAG TITLE",
"meta_keywords": "new cool products",
"meta_description": "It's a article about our new products",
"image": {
"id": 3,
"created_at": "2024-11-21T00:57:20.000+03:00",
"original_url": "http://minio.insales.io:9000/insales-test-sber/images/articles/1/3/3/no_image_compact.jpg?1732139839"
},
"tags": [
{
"title": "test3"
},
{
"title": "test4"
}
],
"related_products": [
],
"notice": "some notice",
"content": "<p>content of my article<p>"
}Delete article
Endpoint
DELETE /admin/blogs/:blog_id/articles/:article_id.json
Request
Route
DELETE /admin/blogs/1/articles/2.json
Headers
Authorization: Basic ZGlnaXRhbC1nb29kczpjNTFjOTA3MDdhMTNjZTNmZmYyMTNhZmJiNWNkMTI3MA==
Content-Type: application/x-www-form-urlencodedResponse
Simulated Response
Status
200Headers
API-Usage-Limit: 1/500
Content-Type: application/json; charset=utf-8Body
{
"status": "ok"
}Get article
Endpoint
GET /admin/blogs/:blog_id/articles/:article_id.json
Request
Route
GET /admin/blogs/1/articles/2.json
Headers
Authorization: Basic ZGlnaXRhbC1nb29kczpjNTFjOTA3MDdhMTNjZTNmZmYyMTNhZmJiNWNkMTI3MA==Response
Simulated Response
Status
200Headers
API-Usage-Limit: 1/500
Content-Type: application/json; charset=utf-8Body
{
"id": 2,
"created_at": "2024-11-21T00:55:56.000+03:00",
"updated_at": "2024-11-21T00:57:18.000+03:00",
"custom_template": null,
"published_at": "2017-03-01T07:53:15.000+03:00",
"pinned": false,
"title": "Второая Статья",
"author": "Ivan",
"permalink": "statya-2",
"html_title": null,
"meta_keywords": null,
"meta_description": null,
"image": {
"id": 1,
"created_at": "2024-11-21T00:55:56.000+03:00",
"original_url": "http://minio.insales.io:9000/insales-test-sber/images/articles/1/1/1/article_image_1.jpg"
},
"tags": [
{
"title": "test"
},
{
"title": "test2"
}
],
"related_products": [
{
"id": 1,
"category_id": 1,
"created_at": "2024-11-21T00:55:57.000+03:00",
"updated_at": "2015-07-27T17:05:35.000+03:00",
"is_hidden": false,
"main_image_id": null,
"account_id": 1,
"title_translations": [
"Cool t-shirt"
],
"available": false,
"archived": false,
"key": null,
"price_min_cached": "10.0",
"price_max_cached": "10.0",
"price_min_available_cached": null,
"price_max_available_cached": null,
"canonical_url_collection_id": 1,
"collections_id": [
1,
3,
8
],
"characteristics_id": [
7,
9,
12,
13
],
"custom_layout": null,
"custom_template": null,
"old_price_min_cached": null,
"old_price_max_cached": null,
"old_price_min_available_cached": null,
"old_price_max_available_cached": null,
"permalink": "футболка",
"unit": "pce",
"deleted": false,
"cost_price_min_cached": null,
"cost_price_max_cached": null,
"stock_currency_id": 1,
"sort_weight": null,
"bundle": null,
"ignore_discounts": null,
"vat": -1,
"dimensions": "10x20x30",
"fiscal_product_type": 1,
"popularity": null,
"available_at_warehouses": [
],
"auto_assign_bundle_price": null,
"demo": null,
"sales_channels_id": null,
"demo_thematic": null,
"title": "Cool t-shirt"
}
],
"notice": "Второй анонс",
"content": "Привет"
}Get articles list
Endpoint
GET /admin/blogs/:blog_id/articles.json
Request
Route
GET /admin/blogs/1/articles.json
Headers
Authorization: Basic ZGlnaXRhbC1nb29kczpjNTFjOTA3MDdhMTNjZTNmZmYyMTNhZmJiNWNkMTI3MA==Response
Simulated Response
Status
200Headers
API-Usage-Limit: 1/500
Content-Type: application/json; charset=utf-8Body
[
{
"id": 2,
"created_at": "2024-11-21T00:55:56.000+03:00",
"updated_at": "2024-11-21T00:57:18.000+03:00",
"custom_template": null,
"published_at": "2017-03-01T07:53:15.000+03:00",
"pinned": false,
"title": "Второая Статья",
"author": "Ivan",
"permalink": "statya-2",
"html_title": null,
"meta_keywords": null,
"meta_description": null,
"image": {
"id": 1,
"created_at": "2024-11-21T00:55:56.000+03:00",
"original_url": "http://minio.insales.io:9000/insales-test-sber/images/articles/1/1/1/article_image_1.jpg"
},
"tags": [
{
"title": "test"
},
{
"title": "test2"
}
],
"related_products": [
{
"id": 1,
"category_id": 1,
"created_at": "2024-11-21T00:55:57.000+03:00",
"updated_at": "2015-07-27T17:05:35.000+03:00",
"is_hidden": false,
"main_image_id": null,
"account_id": 1,
"title_translations": [
"Cool t-shirt"
],
"available": false,
"archived": false,
"key": null,
"price_min_cached": "10.0",
"price_max_cached": "10.0",
"price_min_available_cached": null,
"price_max_available_cached": null,
"canonical_url_collection_id": 1,
"collections_id": [
1,
3,
8
],
"characteristics_id": [
7,
9,
12,
13
],
"custom_layout": null,
"custom_template": null,
"old_price_min_cached": null,
"old_price_max_cached": null,
"old_price_min_available_cached": null,
"old_price_max_available_cached": null,
"permalink": "футболка",
"unit": "pce",
"deleted": false,
"cost_price_min_cached": null,
"cost_price_max_cached": null,
"stock_currency_id": 1,
"sort_weight": null,
"bundle": null,
"ignore_discounts": null,
"vat": -1,
"dimensions": "10x20x30",
"fiscal_product_type": 1,
"popularity": null,
"available_at_warehouses": [
],
"auto_assign_bundle_price": null,
"demo": null,
"sales_channels_id": null,
"demo_thematic": null,
"title": "Cool t-shirt"
}
],
"notice": "Второй анонс",
"content": "Привет"
},
{
"id": 1,
"created_at": "2024-11-21T00:55:56.000+03:00",
"updated_at": "2024-11-21T00:55:56.000+03:00",
"custom_template": null,
"published_at": "2009-03-18T07:53:15.000+03:00",
"pinned": false,
"title": "Статья",
"author": "Ivan",
"permalink": "statya",
"html_title": null,
"meta_keywords": null,
"meta_description": null,
"tags": [
],
"related_products": [
],
"notice": "Первый анонс",
"content": "Первая статья"
}
]Update article
Endpoint
PUT /admin/blogs/:blog_id/articles/:article_id.json
Parameters
| Name | Description |
|---|---|
| article[title] | article title |
| article[content] | article content |
| article[notice] | notice for article |
| article[author] | article author name |
| article[permalink] | permalink on blog/* |
| article[html_title] | html title tag content |
| article[meta_keywords] | html meta words on page |
| article[meta_description] | html meta description |
| article[published_at] | publication date, the article is invisible to users while publication date > current time |
| article[image_attributes] | image for article |
| article[all_tags] | array of tags for article, max 10 tags: to remove tags from list - pass the array without this tag, to add tag - pass a full list with a new tag added |
| article[pinned] | set to true to pin article: it will be always on the top of the blog; only one article can be pinned, so when you pin article, previously pinned article will be unpinned |
Request
Route
PUT /admin/blogs/1/articles/2.json
Headers
Content-Type: application/json
Authorization: Basic ZGlnaXRhbC1nb29kczpjNTFjOTA3MDdhMTNjZTNmZmYyMTNhZmJiNWNkMTI3MA==Body
{
"article": {
"title": "new title",
"image_attributes": {
"src": "https://abc.myinsales.ru/images/no_image_compact.jpg"
},
"all_tags": [
"test",
"test3"
],
"pinned": true
}
}Response
Simulated Response
Status
200Headers
API-Usage-Limit: 1/500
Content-Type: application/json; charset=utf-8Body
{
"pinned": true,
"id": 2,
"created_at": "2024-11-21T00:55:56.000+03:00",
"updated_at": "2024-11-21T00:57:21.000+03:00",
"custom_template": null,
"published_at": "2017-03-01T07:53:15.000+03:00",
"title": "new title",
"author": "Ivan",
"permalink": "statya-2",
"html_title": null,
"meta_keywords": null,
"meta_description": null,
"image": {
"id": 5,
"created_at": "2024-11-21T00:57:21.000+03:00",
"original_url": "http://minio.insales.io:9000/insales-test-sber/images/articles/1/5/5/no_image_compact.jpg?1732139841"
},
"tags": [
{
"title": "test"
},
{
"title": "test3"
}
],
"related_products": [
{
"id": 1,
"category_id": 1,
"created_at": "2024-11-21T00:55:57.000+03:00",
"updated_at": "2015-07-27T17:05:35.000+03:00",
"is_hidden": false,
"main_image_id": null,
"account_id": 1,
"title_translations": [
"Cool t-shirt"
],
"available": false,
"archived": false,
"key": null,
"price_min_cached": "10.0",
"price_max_cached": "10.0",
"price_min_available_cached": null,
"price_max_available_cached": null,
"canonical_url_collection_id": 1,
"collections_id": [
1,
3,
8
],
"characteristics_id": [
7,
9,
12,
13
],
"custom_layout": null,
"custom_template": null,
"old_price_min_cached": null,
"old_price_max_cached": null,
"old_price_min_available_cached": null,
"old_price_max_available_cached": null,
"permalink": "футболка",
"unit": "pce",
"deleted": false,
"cost_price_min_cached": null,
"cost_price_max_cached": null,
"stock_currency_id": 1,
"sort_weight": null,
"bundle": null,
"ignore_discounts": null,
"vat": -1,
"dimensions": "10x20x30",
"fiscal_product_type": 1,
"popularity": null,
"available_at_warehouses": [
],
"auto_assign_bundle_price": null,
"demo": null,
"sales_channels_id": null,
"demo_thematic": null,
"title": "Cool t-shirt"
}
],
"notice": "Второй анонс",
"content": "Привет"
}