Bulk task status updated

Event Group	Event Identification
others	others/update

Occurs whenever the status of a bulk query task or bulk mutation task is updated.

Request Headers

X-Shopline-Topic string required

The unique identifier for the event.

Example: orders/edited
X-Shopline-Hmac-Sha256 string required

The signature of the request. Upon receiving the request, you must verify the signature to confirm the authenticity and integrity of the data.

Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
X-Shopline-Shop-Domain string required

The store domain.

Example: example.myshopline.com
X-Shopline-Shop-Id string required

The store ID.

Example: 1610418123456
X-Shopline-Merchant-Id string required

The merchant ID.

Example: 2000001234
X-Shopline-API-Version string required

The API version.

Example: v20250601
X-Shopline-Webhook-Id string required

The ID of this Webhook event.

Example: b54557e48a5fbf7d70bcd043

Request Body

completedAt string

The date and time when the bulk task was completed. Format: ISO 8601.
Example: 2023-04-06T10:48:29+08:00
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
expiredAt string

The expiration time of the bulk task. Files will become unavailable for download after this time. Format: ISO 8601.
Example: 2023-04-06T10:48:29+08:00
id string

The ID of the bulk task.
Example: gid://shopline/BulkOperation/f97a8c3304b98bcee17c12a0ceb85573
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
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

Status Codes

After receiving a webhook notification from SHOPLINE, you must respond with the following format:

HTTP/1.1 200 OK

For more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.

Was this article helpful to you?

SHOPLINE

SHOPLINE

Legal

Privacy