Get a valid bulk task

Requires read_bulkoperation access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20260301/current_bulk_operation.json

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 .

Get a valid bulk query task or bulk mutation task.

Query Parameters

type string
The operation type of the bulk task. Valid values are:
- QUERY: Query operation
- MUTATION: Mutation operation

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 to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Status Codes

For the complete list of codes and messages, see Http status code.

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

completedAt string

The date and time when the bulk task was completed. Format: ISO 8601.
completedCount integer

The count of the completed bulk operations.
createdAt string

The date and time when the bulk task was created. Format: ISO 8601.
Example: 2023-04-06T10:48:29+08:00
errorCode string
The error code of the bulk task. Valid values are:
- ACCESS_DENIED: No access permission
- TIMEOUT: Process timeout
- NO_DATA: No data found
expiredAt string

The expiration time of the bulk task. Files will become unavailable for download after this time. Format: ISO 8601.
id string

The ID of the bulk task.
partialDataUrl string

A URL to a file containing task processing results with an expiration time. Format: JSON Lines.
When status is COMPLETED, this value is identical to the url value. For other statuses, it may contain partial processing results.
Example: https://sl-private-oss.oss-accelerate.example.com/task-jsonline/prod/1/9b0c0f04-53cb-4ae3-94db-79af6ec193bd.jsonl?Expires=1754059510
reason string

The reason for the bulk task execution exception.
status string
The status of the bulk task. Valid values are:
- CANCELED：Canceled
- CANCELING：Canceling
- COMPLETED：Completed
- CREATED：Created
- EXPIRED：Expired
- FAILED：Failed
- RUNNING：Running
storeId string

The ID of the store.
type string
The type of the bulk task. Valid values are:
- QUERY: Query operation
- MUTATION: Mutation operation, which refers to mutation operations executed through the Bulk operation mutation (to be Deprecated) API.
- MUTATION_GENERAL: Mutation operation
url string

A URL to a file containing all task processing results with an expiration time. Format: JSON Lines.
Example: https://sl-private-oss.oss-accelerate.example.com/task-jsonline/prod/1/9b0c0f04-53cb-4ae3-94db-79af6ec193bd.jsonl?Expires=1754059510

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

type — query

Language

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

Was this article helpful to you?

SHOPLINE

Legal