---
title: "Bulk task status updated"
description: >
  Occurs whenever the status of a [bulk query task](https://developer.shopline.com/docs/admin-rest-api/bulk-operations/create-a-bulk-query-task.md) or [bulk mutation task](https://developer.shopline.com/docs/admin-rest-api/bulk-operations/create-a-bulk-mutation-task.md) is updated.
doc_type: openapi
doc_category: openapi
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/webhook/batch-operation/bulk-task-status-updated'
  md: 'https://developer.shopline.com/docs/webhook/batch-operation/bulk-task-status-updated.md'
---
# Bulk task status updated

Occurs whenever the status of a [bulk query task](https://developer.shopline.com/docs/admin-rest-api/bulk-operations/create-a-bulk-query-task.md) or [bulk mutation task](https://developer.shopline.com/docs/admin-rest-api/bulk-operations/create-a-bulk-mutation-task.md) is updated.

- **API Version:** v20270301
- **API Type:** Webhook
- **API Protocol:** RESTful

## Request

### Request Headers

* `X-Shopline-Topic`

  string (required)

  The unique identifier for the event.

* `X-Shopline-Hmac-Sha256`

  string (required)

  The signature of the request. Upon receiving the request, you must [verify the signature](https://developer.shopline.com/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-requests) to confirm the authenticity and integrity of the data.

* `X-Shopline-Shop-Domain`

  string (required)

  The store domain.

* `X-Shopline-Shop-Id`

  string (required)

  The store ID.

* `X-Shopline-Merchant-Id`

  string (required)

  The merchant ID.

* `X-Shopline-API-Version`

  string (required)

  The API version.

* `X-Shopline-Webhook-Id`

  string (required)

  The ID of this Webhook event.

### Request Body

* `completedAt`

  string

  The date and time when the bulk task was completed. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).
  

* `completedCount`

  integer

  The count of the completed bulk operations. 

* `createdAt`

  string

  The date and time when the bulk task was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).
  

* `expiredAt`

  string

  The expiration time of the bulk task. Files will become unavailable for download after this time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).
  

* `id`

  string

  The ID of the bulk task.

* `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)](https://developer.shopline.com/docs/admin-rest-api/bulk-operations/create-a-change-type-bulk-task-to-be-deprecated.md) API.
  - `MUTATION_GENERAL`: Mutation operation
  

* `url`

  string

  A URL to a file containing all task processing results with an expiration time. Format: [JSON Lines](https://jsonlines.org/).

## Response

### Status Codes

* `200`

  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](https://developer.shopline.com/docs/apps/api-instructions-for-use/webhooks/overview.md).

### Response Body

#### 200

_No response body_

## OpenAPI Definition

```json
{
  "description": "Occurs whenever the status of a [bulk query task](https://developer.shopline.com/docs/admin-rest-api/bulk-operations/create-a-bulk-query-task.md) or [bulk mutation task](https://developer.shopline.com/docs/admin-rest-api/bulk-operations/create-a-bulk-mutation-task.md) is updated.",
  "externalDocs": {
    "description": "| Event Group | Event Identification |\n| :------: | :------: |\n|others        |others/update        |\n",
    "url": "",
    "errorTableDescription": ""
  },
  "operationId": "v75i2o32",
  "parameters": [
    {
      "name": "X-Shopline-Topic",
      "in": "header",
      "description": "The unique identifier for the event.",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Topic",
        "description": "The unique identifier for the event.",
        "type": "string",
        "example": "orders/edited"
      },
      "example": "orders/edited"
    },
    {
      "name": "X-Shopline-Hmac-Sha256",
      "in": "header",
      "description": "The signature of the request. Upon receiving the request, you must [verify the signature](https://developer.shopline.com/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-requests) to confirm the authenticity and integrity of the data.",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Hmac-Sha256",
        "description": "The signature of the request. Upon receiving the request, you must [verify the signature](https://developer.shopline.com/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-requests) to confirm the authenticity and integrity of the data.",
        "type": "string",
        "example": "XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM="
      },
      "example": "XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM="
    },
    {
      "name": "X-Shopline-Shop-Domain",
      "in": "header",
      "description": "The store domain.",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Shop-Domain",
        "description": "The store domain.",
        "type": "string",
        "example": "example.myshopline.com"
      },
      "example": "example.myshopline.com"
    },
    {
      "name": "X-Shopline-Shop-Id",
      "in": "header",
      "description": "The store ID.",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Shop-Id",
        "description": "The store ID.",
        "type": "string",
        "example": "1610418123456"
      },
      "example": "1610418123456"
    },
    {
      "name": "X-Shopline-Merchant-Id",
      "in": "header",
      "description": "The merchant ID.",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Merchant-Id",
        "description": "The merchant ID.",
        "type": "string",
        "example": "2000001234"
      },
      "example": "2000001234"
    },
    {
      "name": "X-Shopline-API-Version",
      "in": "header",
      "description": "The API version.",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-API-Version",
        "description": "The API version.",
        "type": "string",
        "example": "v20250601"
      },
      "example": "v20250601"
    },
    {
      "name": "X-Shopline-Webhook-Id",
      "in": "header",
      "description": "The ID of this Webhook event.",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Webhook-Id",
        "description": "The ID of this Webhook event.",
        "type": "string",
        "example": "b54557e48a5fbf7d70bcd043"
      },
      "example": "b54557e48a5fbf7d70bcd043"
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "completedAt": {
              "name": "completedAt",
              "description": "The date and time when the bulk task was completed. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).\n",
              "type": "string",
              "example": "2023-04-06T10:48:29+08:00"
            },
            "completedCount": {
              "name": "completedCount",
              "description": "The count of the completed bulk operations. ",
              "type": "integer",
              "example": 0
            },
            "createdAt": {
              "name": "createdAt",
              "description": "The date and time when the bulk task was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).\n",
              "type": "string",
              "example": "2023-04-06T10:48:29+08:00"
            },
            "expiredAt": {
              "name": "expiredAt",
              "description": "The expiration time of the bulk task. Files will become unavailable for download after this time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).\n",
              "type": "string",
              "example": "2023-04-06T10:48:29+08:00"
            },
            "id": {
              "name": "id",
              "description": "The ID of the bulk task.",
              "type": "string",
              "example": "gid://shopline/BulkOperation/f97a8c3304b98bcee17c12a0ceb85573"
            },
            "status": {
              "name": "status",
              "description": "The status of the bulk task. Valid values are:  \n\n- `CANCELED`：Canceled   \n- `CANCELING`：Canceling     \n- `COMPLETED`：Completed    \n- `CREATED`：Created   \n- `EXPIRED`：Expired  \n- `FAILED`：Failed  \n- `RUNNING`：Running  \n",
              "type": "string",
              "example": ""
            },
            "type": {
              "name": "type",
              "description": "The type of the bulk task. Valid values are:   \n- `QUERY`: Query operation  \n- `MUTATION`: Mutation operation, which refers to mutation operations executed through the [Bulk operation mutation (to be Deprecated)](https://developer.shopline.com/docs/admin-rest-api/bulk-operations/create-a-change-type-bulk-task-to-be-deprecated.md) API.\n- `MUTATION_GENERAL`: Mutation operation\n",
              "type": "string",
              "example": ""
            },
            "url": {
              "name": "url",
              "description": "A URL to a file containing all task processing results with an expiration time. Format: [JSON Lines](https://jsonlines.org/).",
              "type": "string",
              "example": "https://sl-private-oss.oss-accelerate.example.com/task-jsonline/prod/1/9b0c0f04-53cb-4ae3-94db-79af6ec193bd.jsonl?Expires=1754059510"
            }
          },
          "example": {
            "completedAt": "2023-04-06T10:48:29+08:00",
            "completedCount": 0,
            "createdAt": "2023-04-06T10:48:29+08:00",
            "expiredAt": "2023-04-06T10:48:29+08:00",
            "id": "gid://shopline/BulkOperation/f97a8c3304b98bcee17c12a0ceb85573",
            "status": "",
            "type": "",
            "url": "https://sl-private-oss.oss-accelerate.example.com/task-jsonline/prod/1/9b0c0f04-53cb-4ae3-94db-79af6ec193bd.jsonl?Expires=1754059510"
          }
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "After receiving a webhook notification from SHOPLINE, you must respond with the following format: \n\n``` HTTP/1.1 200 OK ```\n\nFor more information about how to subscribe to webhooks and webhook response rules, refer to [Webhook overview](https://developer.shopline.com/docs/apps/api-instructions-for-use/webhooks/overview.md)."
    }
  },
  "info": {
    "title": "Bulk task status updated",
    "version": "v20270301"
  }
}
```