--- title: "Query blog collection list" description: "Ask for the collection list of the style of the collection" doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/docs/admin-rest-api/online-store/blog-collection/query-blog-collection-list' md: 'https://developer.shopline.com/docs/admin-rest-api/online-store/blog-collection/query-blog-collection-list.md' --- # Query blog collection list Ask for the collection list of the style of the collection - **Base URL:** `https://{handle}.myshopline.com/admin/openapi` - **Required Scopes:** `read_content` - **API Version:** v20270301 - **API Type:** Admin - **API Protocol:** RESTful ## Endpoint ```http GET /store/blogs.json ``` ## Base URL * `https://{handle}.myshopline.com/admin/openapi` * `{handle}`: `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` . ## Required Permissions * `read_content` ## Request ### Query Parameters * `handle` string (optional) The handle of blog collection * `limit` integer (optional) Query of query quantity , default 50 , can not exceed 1000 * `since_id` string (optional) Show blog collection after this 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](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ## Response ### Status Codes * `200` For the complete list of codes and messages, see [Http status code](https://developer.shopline.com/docs/apps/api-instructions-for-use/http-status-code.md?lang=en). * `401` * `429` ### 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 #### 200 * `blogs` array Blog collection list * `id` string blog collection id * `template_suffix` string The template name of the blog collection * `title` string Title of blog collection * `updated_at` string Update time ISO 8601 * `commentable` string Comment configuration , post value : no ( can not post reviews ) ; moderate ( default , can post reviews , but need to review ) ; yes ( can post reviews and do not need to review automatic posting success ) * `created_at` string Create time ISO 8601 * `handle` string The handle of the blog collection #### 401 * `errors` string Error message. #### 429 * `errors` string Error message. ## OpenAPI Definition ```json { "description": "Ask for the collection list of the style of the collection", "externalDocs": { "description": "Permission point used by the interface is `read_content` , For more information about the use of permission points, see", "url": "ec20/3cv5d7wpfgr6a8z5/xabczf5442284vkq?lang=en", "errorTableDescription": "" }, "operationId": "EKsOVEvY", "parameters": [ { "name": "handle", "in": "query", "description": "The handle of blog collection", "style": "form", "explode": true, "schema": { "name": "handle", "description": "The handle of blog collection", "type": "string", "example": "demo-blogs" }, "example": "demo-blogs", "examples": { "Query blog collection list-specify handle": { "value": "demo-blogs" } } }, { "name": "limit", "in": "query", "description": "Query of query quantity , default 50 , can not exceed 1000", "style": "form", "explode": true, "schema": { "name": "limit", "description": "Query of query quantity , default 50 , can not exceed 1000", "type": "integer", "example": 50 }, "example": 50 }, { "name": "since_id", "in": "query", "description": "Show blog collection after this id", "style": "form", "explode": true, "schema": { "name": "since_id", "description": "Show blog collection after this id", "type": "string", "example": "63a50a79cec17b0b728a3b69" }, "example": "63a50a79cec17b0b728a3b69", "examples": { "Query blog collection list-specify since_id": { "value": "633456618c5d1d25c6502e06" } } }, { "name": "Content-Type", "in": "header", "description": "The field must be set to the fixed value `application/json; charset=utf-8`.", "required": true, "style": "string", "schema": { "name": "Content-Type", "type": "string", "example": "application/json; charset=utf-8" } }, { "name": "Authorization", "in": "header", "description": " The access token for the API resource. Refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ", "required": true, "style": "string", "schema": { "name": "Authorization", "description": " The access token for the API. Please refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.", "type": "string", "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" }, "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" } ], "responses": { "200": { "description": "For the complete list of codes and messages, see [Http status code](https://developer.shopline.com/docs/apps/api-instructions-for-use/http-status-code.md?lang=en).", "headers": { "traceId": { "description": "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." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "blogs": { "name": "blogs", "description": "Blog collection list", "type": "array", "items": { "name": "blogs", "description": "Blog collection list", "type": "object", "properties": { "id": { "name": "id", "description": "blog collection id", "type": "string", "example": "63a9a344609552261f00f23e" }, "template_suffix": { "name": "template_suffix", "description": "The template name of the blog collection", "type": "string", "example": "templates/blogs/list.json" }, "title": { "name": "title", "description": "Title of blog collection", "type": "string", "example": "demo blogs" }, "updated_at": { "name": "updated_at", "description": "Update time ISO 8601", "type": "string", "example": "2022-08-03T10:45:00+08:00\t\n" }, "commentable": { "name": "commentable", "description": "Comment configuration , post value : no ( can not post reviews ) ; moderate ( default , can post reviews , but need to review ) ; yes ( can post reviews and do not need to review automatic posting success )", "type": "string", "example": "moderate" }, "created_at": { "name": "created_at", "description": "Create time ISO 8601", "type": "string", "example": "2022-08-03T10:45:00+08:00\t\n" }, "handle": { "name": "handle", "description": "The handle of the blog collection", "type": "string", "example": "demo-blogs" } }, "example": { "updated_at": "2022-08-03T10:45:00+08:00\t\n", "commentable": "moderate", "created_at": "2022-08-03T10:45:00+08:00\t\n", "handle": "demo-blogs", "id": "63a9a344609552261f00f23e", "template_suffix": "templates/blogs/list.json", "title": "demo blogs" } }, "example": [ { "id": "63a9a344609552261f00f23e", "template_suffix": "templates/blogs/list.json", "title": "demo blogs", "updated_at": "2022-08-03T10:45:00+08:00\t\n", "commentable": "moderate", "created_at": "2022-08-03T10:45:00+08:00\t\n", "handle": "demo-blogs" } ] } }, "example": { "blogs": [ { "title": "demo blogs", "updated_at": "2022-08-03T10:45:00+08:00\t\n", "commentable": "moderate", "created_at": "2022-08-03T10:45:00+08:00\t\n", "handle": "demo-blogs", "id": "63a9a344609552261f00f23e", "template_suffix": "templates/blogs/list.json" } ] } }, "examples": { "Query blog collection list": { "value": { "blogs": [ { "template_suffix": "templates/blogs/list.html", "title": "demo-blog-collection", "updated_at": "2023-09-27T13:03:18+08:00", "commentable": "moderate", "created_at": "2023-09-27T13:03:18+08:00", "handle": "demo-blog-collection", "id": "6513b796cefe85764377984d" }, { "handle": "spring-demo", "id": "6513b7e04dc5005591ec25ce", "template_suffix": "templates/blogs/list.html", "title": "spring-demo", "updated_at": "2023-09-27T13:04:32+08:00", "commentable": "moderate", "created_at": "2023-09-27T13:04:32+08:00" } ] } }, "Query blog collection list-specify handle": { "value": { "blogs": [ { "template_suffix": "templates/blogs/list.json", "title": "demo blogs", "updated_at": "2022-12-26T21:36:04+08:00", "commentable": "moderate", "created_at": "2022-12-26T21:36:04+08:00", "handle": "demo-blogs", "id": "63a9a344609552261f00f23e" } ] } }, "Query blog collection list-specify since_id": { "value": { "blogs": [ { "handle": "news-5-1", "id": "63345662840927149ba620cd", "title": "News", "updated_at": "2022-09-28T22:12:50+08:00", "commentable": "moderate", "created_at": "2022-09-28T22:12:50+08:00" }, { "commentable": "moderate", "created_at": "2022-12-26T21:36:04+08:00", "handle": "demo-blogs", "id": "63a9a344609552261f00f23e", "template_suffix": "templates/blogs/list.json", "title": "demo blogs", "updated_at": "2022-12-26T21:36:04+08:00" } ] } } } } } }, "401": { "headers": { "traceId": { "description": "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." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "Error message. ", "type": "string" } }, "required": [ "errors" ] } } } }, "429": { "headers": { "traceId": { "description": "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." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "Error message. ", "type": "string" } }, "required": [ "errors" ] } } } } }, "security": [ { "oauth2": [] } ], "method": "get", "path": "/store/blogs.json", "servers": [ { "url": "https://{handle}.myshopline.com/admin/openapi", "variables": { "handle": { "default": "openapiceshidianpu", "description": "`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` ." } } } ], "info": { "title": "Query blog collection list", "version": "v20270301" }, "authIndexes": [ "read_content" ] } ```