--- title: "查询多个销售计划组" description: "分页查询销售计划组列表" doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/zh-hans-cn/docs/admin-rest-api/product/sales-plan-group/query-multiple-selling-programs' md: 'https://developer.shopline.com/zh-hans-cn/docs/admin-rest-api/product/sales-plan-group/query-multiple-selling-programs.md' --- # 查询多个销售计划组 分页查询销售计划组列表 - **Base URL:** `https://{handle}.myshopline.com/admin/openapi` - **Required Scopes:** `read_selling_plan_group` - **API Version:** v20270301 - **API Type:** Admin - **API Protocol:** RESTful ## Endpoint ```http GET /selling_plan_group/selling_plan_group.json ``` ## Base URL * `https://{handle}.myshopline.com/admin/openapi` * `{handle}`: `handle` ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 `open001.myshopline.com` 的店铺，其 `handle` 是 `open001` 。 ## Required Permissions * `read_selling_plan_group` ## Request ### Query Parameters * `create_at_max` string (optional) 创建时间在XXX前（格式见IOS8601） * `create_at_min` string (optional) 创建时间从XXX起（格式见IOS8601） * `limit` integer (optional) 查询数量限制，默认50，不能超过250 * `name` string (optional) 销售计划组名称，模糊查询 * `page_info` string (optional) 分页查询的唯一标识，用于定位特定页面。 该字段值需要在你已经查询完分页信息后，在该接口响应头中的 `link` 字段值中获取。例如，你获取到的 `link` 的值为 `; rel="next"` ，那么 `page_info` 的值为 `eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9` 。 关于更多如何使用分页信息，请参考 [分页机制](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/paging-mechanism.md)。 * `since_id` string (optional) 从指定销售计划组ID开始查询 ### Request Headers * `Content-Type` string (required) 字段值固定为 `application/json; charset=utf-8`。 * `Authorization` string (required) 资源的访问令牌。参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。 ## Response ### Status Codes * `200` 更多状态码信息，参考 [HTTP 状态码](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/http-status-code.md?lang=zh-hans-cn)。 * `401` * `429` ### Response Headers * `link` 提供分页数据的 URL 链接。你可以获取该字段值中的 `page_info` 信息用于下一次分页请求中。 当你请求的页面存在上一页或下一页的时候，该字段会被返回。关于更多如何使用分页信息，请参考 [分页机制](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/paging-mechanism.md)。 * `traceId` 请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。 ### Response Body #### 200 * `selling_plan_group_list` array 销售计划组列表 * `app_id` string 销售渠道ID * `description` string 描述 * `id` string 销售计划组ID * `merchant_code` string 展示给卖家看的名称 * `name` string 销售计划组名称 * `options` array 销售计划组选项列表 * `position` integer 展示位置 * `product_count` integer 关联的商品数量 #### 401 * `errors` string 错误描述。 #### 429 * `errors` string 错误描述。 ## OpenAPI Definition ```json { "description": "分页查询销售计划组列表", "externalDocs": { "description": "接口使用的权限点: `read_selling_plan_group` ，更多权限点使用信息，请参考:", "url": "ec20/3cv5d7wpfgr6a8z5/xabczf5442284vkq?lang=zh-hans-cn", "errorTableDescription": "" }, "operationId": "mT6wk4by", "parameters": [ { "name": "create_at_max", "in": "query", "description": "创建时间在XXX前（格式见IOS8601）", "style": "form", "explode": true, "schema": { "name": "create_at_max", "description": "创建时间在XXX前（格式见IOS8601）", "type": "string", "example": "2022-01-07T14:38:25.734+08:00" }, "example": "2022-01-07T14:38:25.734+08:00", "examples": { "指定时间": { "value": "2023-09-07T14:38:25.734+08:00" } } }, { "name": "create_at_min", "in": "query", "description": "创建时间从XXX起（格式见IOS8601）", "style": "form", "explode": true, "schema": { "name": "create_at_min", "description": "创建时间从XXX起（格式见IOS8601）", "type": "string", "example": "2022-01-07T14:38:25.734+08:00" }, "example": "2022-01-07T14:38:25.734+08:00", "examples": { "指定时间": { "value": "2023-08-07T14:38:25.734+08:00" } } }, { "name": "limit", "in": "query", "description": "查询数量限制，默认50，不能超过250", "style": "form", "explode": true, "schema": { "name": "limit", "description": "查询数量限制，默认50，不能超过250", "type": "integer", "example": 50 }, "example": 50, "examples": { "指定SinceID": { "value": "50" }, "指定名称": { "value": "50" }, "指定时间": { "value": "50" }, "指定PageInfo": { "value": "2" } } }, { "name": "name", "in": "query", "description": "销售计划组名称，模糊查询", "style": "form", "explode": true, "schema": { "name": "name", "description": "销售计划组名称，模糊查询", "type": "string", "example": "折扣" }, "example": "折扣", "examples": { "指定名称": { "value": "name" } } }, { "name": "page_info", "in": "query", "description": "分页查询的唯一标识，用于定位特定页面。\n\n该字段值需要在你已经查询完分页信息后，在该接口响应头中的 `link` 字段值中获取。例如，你获取到的 `link` 的值为 `; rel=\"next\"` ，那么 `page_info` 的值为 `eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9` 。\n\n关于更多如何使用分页信息，请参考 [分页机制](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/paging-mechanism.md)。", "style": "form", "explode": true, "schema": { "name": "page_info", "description": "调用方不需要使用和关注此字段，由Shopline自动封装\n", "type": "string", "example": "eyJzaW5jZUlkIjoiMTQwNTYyMDAyNDU4NDQzNzI0NDExMDAwMDkiLCJkaXJlY3Rpb24iOiJuZXh0In0=" }, "example": "eyJzaW5jZUlkIjoiMTQwNTYyMDAyNDU4NDQzNzI0NDExMDAwMDkiLCJkaXJlY3Rpb24iOiJuZXh0In0=", "examples": { "指定PageInfo": { "value": "eyJzaW5jZUlkIjoiMTQwNjA4ODEyNjA1MjQ1Mzg0ODUxOTMxNDQiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjIsImFwcEtleSI6IjExMWFmZTJmOWJhY2ViOTMwMDRhZjkyYjEyNzY1ODI2MTlmMWRiMjYifQ" } } }, { "name": "since_id", "in": "query", "description": "从指定销售计划组ID开始查询", "style": "form", "explode": true, "schema": { "name": "since_id", "description": "从指定销售计划组ID开始查询", "type": "string", "example": "14056200245844372441100009" }, "example": "14056200245844372441100009", "examples": { "指定SinceID": { "value": "14060881260524538485193144" } } }, { "name": "Content-Type", "in": "header", "description": "字段值固定为 `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": "资源的访问令牌。参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。", "required": true, "style": "string", "schema": { "name": "Authorization", "description": "资源的访问令牌。请参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入", "type": "string", "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" }, "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" } ], "responses": { "200": { "description": "更多状态码信息，参考 [HTTP 状态码](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/http-status-code.md?lang=zh-hans-cn)。", "headers": { "link": { "description": "提供分页数据的 URL 链接。你可以获取该字段值中的 `page_info` 信息用于下一次分页请求中。\n\n当你请求的页面存在上一页或下一页的时候，该字段会被返回。关于更多如何使用分页信息，请参考 [分页机制](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/paging-mechanism.md)。", "example": "; rel=\"previous\",; rel=\"next\"" }, "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "selling_plan_group_list": { "name": "selling_plan_group_list", "description": "销售计划组列表", "type": "array", "items": { "name": "selling_plan_group_list", "description": "销售计划组列表", "type": "object", "properties": { "app_id": { "name": "app_id", "description": "销售渠道ID", "type": "string", "example": "c41ac9e6736785502d2333d1b1153aca795075c4" }, "description": { "name": "description", "description": "描述", "type": "string", "example": "This is a description" }, "id": { "name": "id", "description": "销售计划组ID", "type": "string", "example": "14056200245844372441100009" }, "merchant_code": { "name": "merchant_code", "description": "展示给卖家看的名称", "type": "string", "example": "Subscription plan group default name" }, "name": { "name": "name", "description": "销售计划组名称", "type": "string", "example": "Subscription plan group default name\t" }, "options": { "name": "options", "description": "销售计划组选项列表", "type": "array", "items": { "name": "options", "description": "销售计划组选项列表", "type": "string", "example": "[\"delivery every 1 months\", \"delivery every 2 months\", \"delivery every 3 months\"]" }, "example": [ "[\"delivery every 1 months\", \"delivery every 2 months\", \"delivery every 3 months\"]" ] }, "position": { "name": "position", "description": "展示位置", "type": "integer", "example": 1 }, "product_count": { "name": "product_count", "description": "关联的商品数量", "type": "integer", "example": 10 } }, "example": { "description": "This is a description", "id": "14056200245844372441100009", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name\t", "options": [ "[\"delivery every 1 months\", \"delivery every 2 months\", \"delivery every 3 months\"]" ], "position": 1, "product_count": 10, "app_id": "c41ac9e6736785502d2333d1b1153aca795075c4" } }, "example": [ { "position": 1, "product_count": 10, "app_id": "c41ac9e6736785502d2333d1b1153aca795075c4", "description": "This is a description", "id": "14056200245844372441100009", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name\t", "options": [ "[\"delivery every 1 months\", \"delivery every 2 months\", \"delivery every 3 months\"]" ] } ] } }, "example": { "selling_plan_group_list": [ { "name": "Subscription plan group default name\t", "options": [ "[\"delivery every 1 months\", \"delivery every 2 months\", \"delivery every 3 months\"]" ], "position": 1, "product_count": 10, "app_id": "c41ac9e6736785502d2333d1b1153aca795075c4", "description": "This is a description", "id": "14056200245844372441100009", "merchant_code": "Subscription plan group default name" } ] } }, "examples": { "指定名称": { "value": { "selling_plan_group_list": [ { "id": "14060881232364316992673144", "merchant_code": "Subscriptionplangroupdefaultname", "name": "Subscriptionplangroupdefaultname", "options": [ "deliveryevery1months" ], "position": 1, "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "Thisisadescription" }, { "position": 1, "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881260524538485193144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name", "options": [ "delivery every 1 months" ] }, { "options": [ "delivery every 1 months" ], "position": 1, "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881274779635621973144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name 3" }, { "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881275356100764933144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name 4", "options": [ "delivery every 1 months" ], "position": 1, "product_count": 1 }, { "options": [ "delivery every 1 months" ], "position": 1, "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881275906728976533144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name 5" } ] } }, "指定时间": { "value": { "selling_plan_group_list": [ { "merchant_code": "Subscriptionplangroupdefaultname", "name": "Subscriptionplangroupdefaultname", "options": [ "deliveryevery1months" ], "position": 1, "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "Thisisadescription", "id": "14060881232364316992673144" }, { "position": 1, "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881260524538485193144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name", "options": [ "delivery every 1 months" ] }, { "id": "14060881274779635621973144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name 3", "options": [ "delivery every 1 months" ], "position": 1, "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description" }, { "position": 1, "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881275356100764933144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name 4", "options": [ "delivery every 1 months" ] }, { "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881275906728976533144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name 5", "options": [ "delivery every 1 months" ], "position": 1, "product_count": 1 } ] } }, "指定PageInfo": { "value": { "selling_plan_group_list": [ { "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881274779635621973144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name 3", "options": [ "delivery every 1 months" ], "position": 1 }, { "position": 1, "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881275356100764933144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name 4", "options": [ "delivery every 1 months" ] } ] } }, "指定SinceID": { "value": { "selling_plan_group_list": [ { "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881274779635621973144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name 3", "options": [ "delivery every 1 months" ], "position": 1, "product_count": 1 }, { "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881275356100764933144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name 4", "options": [ "delivery every 1 months" ], "position": 1 }, { "options": [ "delivery every 1 months" ], "position": 1, "product_count": 1, "app_id": "111afe2f9baceb93004af92b1276582619f1db26", "description": "This is a description", "id": "14060881275906728976533144", "merchant_code": "Subscription plan group default name", "name": "Subscription plan group default name 5" } ] } } } } } }, "401": { "headers": { "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "错误描述。", "type": "string" } }, "required": [ "errors" ] } } } }, "429": { "headers": { "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "错误描述。", "type": "string" } }, "required": [ "errors" ] } } } } }, "security": [ { "oauth2": [] } ], "method": "get", "path": "/selling_plan_group/selling_plan_group.json", "servers": [ { "url": "https://{handle}.myshopline.com/admin/openapi", "variables": { "handle": { "default": "openapiceshidianpu", "description": "`handle` ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 `open001.myshopline.com` 的店铺，其 `handle` 是 `open001` 。" } } } ], "info": { "title": "查询多个销售计划组", "version": "v20270301" }, "authIndexes": [ "read_selling_plan_group" ] } ```