取消一个批量任务

需要 write_bulkoperation 权限点。

更多权限点使用信息，请参考：

POST https://{handle}.myshopline.com/admin/openapi/v20260301/bulk_operation_run_cancel.json

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

取消一个正在执行的批量查询任务或批量变更任务。你可以直接通过响应信息获取取消结果或错误信息。

请求头

Content-Type string required

字段值固定为 application/json; charset=utf-8。
Authorization string required

资源的访问令牌。参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
例子:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

请求体

id string

批量任务 ID。

状态码

更多状态码信息，参考 HTTP 状态码。

响应头

traceId

请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。

响应体

completedAt string

批量任务的完成日期与时间。格式：ISO 8601。
例子: 2023-04-06T10:48:29+08:00
completedCount integer

批量操作的完成数量。
createdAt string

批量任务的创建日期与时间。格式：ISO 8601。
例子: 2023-04-06T10:48:29+08:00
errorCode string
批量任务错误码。有效枚举值包含：
- ACCESS_DENIED: 无访问权限
- TIMEOUT: 处理超时
- NO_DATA: 没有找到数据
expiredAt string

批量任务的过期时间，超过该时间文件将无法下载。格式：ISO 8601。
例子: 2023-04-06T10:48:29+08:00
id string

批量任务 ID。
partialDataUrl string

带有过期时间的文件 URL。文件格式：JSON Lines。当 status 是 COMPLETED 时，该字段值与 url 值一致。其他状态下，可能包含部分任务处理结果。
例子: https://sl-private-oss.oss-accelerate.example.com/task-jsonline/prod/1/9b0c0f04-53cb-4ae3-94db-79af6ec193bd.jsonl?Expires=1754059510
reason string

批量任务执行异常的原因。
status string
批量任务状态。有效枚举值包含：
- CANCELED：已取消
- CANCELING：取消中
- COMPLETED：已完成
- CREATED：已创建
- EXPIRED：已过期
- FAILED：已失败
- RUNNING：运行中
storeId string

店铺 ID。
type string
批量任务操作类型。有效枚举值包含：
- QUERY：查询操作
- MUTATION：变更操作，指通过创建一个批量变更任务（待废弃）接口执行的变更操作。
- MUTATION_GENERAL：变更操作
url string

带有过期时间的文件 URL，包含所有任务处理结果。文件格式：JSON Lines。
例子: https://sl-private-oss.oss-accelerate.example.com/task-jsonline/prod/1/9b0c0f04-53cb-4ae3-94db-79af6ec193bd.jsonl?Expires=1754059510

API Explorer

调试台

示例代码

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "id": null
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/bulk_operation_run_cancel.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议