Bulk Query Task​

With the Bulk Query Task interface, you can submit a bulk query operation to SHOPLINE for processing complex data queries.

  • This operation is asynchronous, and the results will not be immediately returned.
  • After submitting a bulk query request, the time required for the request depends on the complexity of your task.
  • Once the task is completed, the results will be generated as a temporary file in JSONL format, which is valid for 12 hours.
  • You can use the Bulk Task Result Query interface to check the execution status and retrieve the results.
  • The execution results will be returned as a link to the JSONL file format in the HTTP response. You need to download the content of the file from the link to obtain the final task result data.
Note
  • Bulk query tasks at the store level are serialized. At any given time, each store can only have one ongoing bulk query task. Therefore, when an app submits a bulk query task for a store, SHOPLINE will reject other bulk query tasks from the same store until the task is completed, regardless of whether the task is from the same app.
  • If you don’t retrieve the results via the Bulk Task Result Query - If you don’t retrieve the results via the Bulk Task Result Query prior to running another bulk query task, the previous task results will be lost and will need to be run again.

Usage limits​

  1. A store can only submit one asynchronous query task, and during the processing phase, you cannot submit new queries.
  2. The app must have the write_bulkoperation and read_bulkoperation permissions.
  3. You can query up to 10,000 records.
  4. The API version must be greater than or equal to v20220901.

Usage example​

Suppose you want to export all product data from your SHOPLINE store for offline analysis. You can follow these steps:

Ensure that your app has the read_products, read_bulkoperation, and write_bulkoperation permissions.

  1. Submit a Bulk Query Task to retrieve all products in the current store.
curl --location --request POST 'https://{handle}.myshopline.com/admin/openapi/v20220901/bulk_operation_run_query.json' \
--header 'Authorization: {token}' \
--header 'Content-Type: app/json' \
--data-raw '{
"method": "GET",
"query_path": "https://{handle}.myshopline.com/admin/openapi/v20220901/products/products.json"
}'

Note: The query_path must include the complete path of the SHOPLINE REST API, which can include condition parameters defined in the API documentation. When the response HTTP status code

is 200, it indicates that the task was successfully submitted.

  1. Use the Bulk Task Result Query interface to check the status of the task for your current store.
curl --location -g --request GET 'https://{handle}.myshopline.com/admin/openapi/v20220901/current_bulk_operation.json?type=QUERY' \
--header 'Authorization: {token}' \
--header 'Content-Type: app/json' \
--data-raw ''

Note: Add type=QUERY to the request path to indicate that it is a bulk query task.

{
  "partialDataUrl": null,
  "createdAt": "2023-05-24T14:53:45+08:00",
  "expiredAt": null,
  "reason": null,
  "completedAt": null,
  "errorCode": null,
  "id": "gid://shopline/BulkOperation/XX",
  "type": "QUERY",
  "completedCount": 0,
  "storeId": "xx",
  "url": null,
  "status": "CREATED"
}

Downloading and processing files​

Once the task is completed, you can directly download the JSONL file in JSONL format by retrieving the file address from the url field returned by the Bulk Task Result Query interface.

If the task is interrupted, and not all data can be queried, the query task will fail.

In this case:

  1. Retrieve the address of the partial JSONL file in JSONL format from the partialDataUrl field returned by the Bulk Task Result Query interface.
  2. Directly download this partial JSONL file to obtain the executed pagination query results up to the point of interruption.
  3. Parse the last line of this result to retrieve the since_id of that line's data.
  4. Append since_id={since_id} to the end of the query_path parameter in the original bulk query task request.
  5. Resubmit the Bulk Query Task.

The URL and partialDataUrl of the JSONL files are valid for only 12 hours.

You can use any programming language to parse the JSONL file. Each line represents a valid JSON data segment.

For example:

{"products":[{"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524798825649163"},"body_html":"<p>women's coat</p>","images":[{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524798825649163"}],"created_at":"2021-01-15T16:01:01+08:00","template_path":null,"handle":null,"variants":[{"inventory_quantity":44,"image":null,"required_shipping":true,"compare_at_price":"8888.00","taxable":true,"option5":null,"weight":"0.00","title":null,"inventory_policy":"deny","weight_unit":"kg","inventory_item_id":"4703820546801691661","price":"8888.00","product_id":"16047038205454092052571954","option3":null,"option4":null,"inventory_tracker":true,"option1":null,"id":"18047038205456944179971954","option2":null,"position":1,"sku":"shopline-pre-000002","barcode":"shopline-pre-000002"}],"title":"women's coat","tags":"winter clothes","published_scope":"web","product_type":"NORMAL","updated_at":"2022-10-18T16:47:23+08:00","vendor":null,"subtitle":null,"options":[],"spu":null,"id":"16047038205454092052571954","published_at":"2021-01-15T00:00:00+08:00","product_behavior":"","product_category":null,"status":"active"},{"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524799529665633"},"body_html":"<p>woolen coatwoolen coatwoolen coat</p>","images":[{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524799529665633"}],"created_at":"2021-01-15T16:05:30+08:00","template_path":null,"handle":null,"variants":[{"inventory_quantity":12989,"image":null,"required_shipping":true,"compare_at_price":"12.00","taxable":true,"option5":null,"weight":"0.00","title":null,"inventory_policy":"deny","weight_unit":"kg","inventory_item_id":"4703825058429955139","price":"10.00","product_id":"16047038250581279877401954","option3":null,"option4":null,"inventory_tracker":true,"option1":null,"id":"18047038250582286510351954","option2":null,"position":1,"sku":"shopline-pre-000003","barcode":"shopline-pre-000003"}],"title":"woolen coat","tags":null,"published_scope":"web","product_type":"NORMAL","updated_at":"2022-10-09T10:54:57+08:00","vendor":null,"subtitle":null,"options":[],"spu":null,"id":"16047038250581279877401954","published_at":"2021-01-15T00:00:00+08:00","product_behavior":"","product_category":null,"status":"active"},{"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524804076860494"},"body_html":"\n No transaction fees. No design or technical skills required. Integrated with multiple payment and logistic options. With over 120,000 merchants online. Everything you need for your e-commerce store.\n","images":[{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524804076860494"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804227855397"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804378850369"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804513068056"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804664063031"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804798280754"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805033161772"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805251265575"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805402260546"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805553255504"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805687473245"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805855245357"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806006240293"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806140458063"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806291452929"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806442447877"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806610220088"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806777992252"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806928987159"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807063204924"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807214199831"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807348417575"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807482635364"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807633630248"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807767848028"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807935620136"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808086615081"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808220832823"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808355050529"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808506045509"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808640263253"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808740926532"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808891921424"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809042916445"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809328129050"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809512678433"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809663673411"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809814668294"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809982440540"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524810133435400"}],"created_at":"2021-01-18T10:09:38+08:00","template_path":null,"handle":"TestGoods23","variants":[{"inventory_quantity":998,"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/64a15e63737447dda83ca9668a64ddbd.jpeg?w=2000&h=682","alt":null,"id":"5759524810317984865"},"required_shipping":true,"compare_at_price":"23.00","taxable":true,"option5":null,"weight":"123.99","title":"green · L1","inventory_policy":"deny","weight_unit":"kg","inventory_item_id":"4707815481808813083","price":"23.00","product_id":"16047078154805505433761954","option3":null,"option4":null,"inventory_tracker":true,"option1":"green","id":"18047078154806512066751954","option2":"L1","position":1,"sku":"green_l1","barcode":null}],"title":"TestGoods23","tags":"123,abc,shopline","published_scope":"web","product_type":"NORMAL","updated_at":"2023-01-13T23:08:59+08:00","vendor":null,"subtitle":null,"options":[{"product_id":"16047078154805505433761954","values":["green"],"values_images":{},"name":"color","id":"16147078154806512066781954"},{"product_id":"16047078154805505433761954","values":["L1"],"values_images":{},"name":"custom_1","id":"16147078154806512066811954"}],"spu":null,"id":"16047078154805505433761954","published_at":"2021-01-18T00:00:00+08:00","product_behavior":"","product_category":null,"status":"active"}]}
{"products":[{"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524798825649163"},"body_html":"<p>women's coat</p>","images":[{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524798825649163"}],"created_at":"2021-01-15T16:01:01+08:00","template_path":null,"handle":null,"variants":[{"inventory_quantity":44,"image":null,"required_shipping":true,"compare_at_price":"8888.00","taxable":true,"option5":null,"weight":"0.00","title":null,"inventory_policy":"deny","weight_unit":"kg","inventory_item_id":"4703820546801691661","price":"8888.00","product_id":"16047038205454092052571954","option3":null,"option4":null,"inventory_tracker":true,"option1":null,"id":"18047038205456944179971954","option2":null,"position":1,"sku":"shopline-pre-000002","barcode":"shopline-pre-000002"}],"title":"women's coat","tags":"winter clothes","published_scope":"web","product_type":"NORMAL","updated_at":"2022-10-18T16:47:23+08:00","vendor":null,"subtitle":null,"options":[],"spu":null,"id":"16047038205454092052571954","published_at":"2021-01-15T00:00:00+08:00","product_behavior":"","product_category":null,"status":"active"},{"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524799529665633"},"body_html":"<p>woolen coat</p>","images":[{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524799529665633"}],"created_at":"2021-01-15T16:05:30+08:00","template_path":null,"handle":null,"variants":[{"inventory_quantity":12989,"image":null,"required_shipping":true,"compare_at_price":"12.00","taxable":true,"option5":null,"weight":"0.00","title":null,"inventory_policy":"deny","weight_unit":"kg","inventory_item_id":"4703825058429955139","price":"10.00","product_id":"16047038250581279877401954","option3":null,"option4":null,"inventory_tracker":true,"option1":null,"id":"18047038250582286510351954","option2":null,"position":1,"sku":"shopline-pre-000003","barcode":"shopline-pre-000003"}],"title":"woolen coat","tags":null,"published_scope":"web","product_type":"NORMAL","updated_at":"2022-10-09T10:54:57+08:00","vendor":null,"subtitle":null,"options":[],"spu":null,"id":"16047038250581279877401954","published_at":"2021-01-15T00:00:00+08:00","product_behavior":"","product_category":null,"status":"active"},{"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524804076860494"},"body_html":"\n No transaction fees. No design or technical skills required. Integrated with multiple payment and logistic options. With over 120,000 merchants online. Everything you need for your e-commerce store.\n","images":[{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524804076860494"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804227855397"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804378850369"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804513068056"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804664063031"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804798280754"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805033161772"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805251265575"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805402260546"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805553255504"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805687473245"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805855245357"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806006240293"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806140458063"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806291452929"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806442447877"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806610220088"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806777992252"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806928987159"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807063204924"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807214199831"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807348417575"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807482635364"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807633630248"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807767848028"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807935620136"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808086615081"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808220832823"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808355050529"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808506045509"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808640263253"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808740926532"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808891921424"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809042916445"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809328129050"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809512678433"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809663673411"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809814668294"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809982440540"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524810133435400"}],"created_at":"2021-01-18T10:09:38+08:00","template_path":null,"handle":"TestGoods23","variants":[{"inventory_quantity":998,"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/64a15e63737447dda83ca9668a64ddbd.jpeg?w=2000&h=682","alt":null,"id":"5759524810317984865"},"required_shipping":true,"compare_at_price":"23.00","taxable":true,"option5":null,"weight":"123.99","title":"green · L1","inventory_policy":"deny","weight_unit":"kg","inventory_item_id":"4707815481808813083","price":"23.00","product_id":"16047078154805505433761954","option3":null,"option4":null,"inventory_tracker":true,"option1":"green","id":"18047078154806512066751954","option2":"L1","position":1,"sku":"green_l1","barcode":null}],"title":"TestGoods23","tags":"123,abc,shopline","published_scope":"web","product_type":"NORMAL","updated_at":"2023-01-13T23:08:59+08:00","vendor":null,"subtitle":null,"options":[{"product_id":"16047078154805505433761954","values":["green"],"values_images":{},"name":"color","id":"16147078154806512066781954"},{"product_id":"16047078154805505433761954","values":["L1"],"values_images":{},"name":"custom_1","id":"16147078154806512066811954"}],"spu":null,"id":"16047078154805505433761954","published_at":"2021-01-18T00:00:00+08:00","product_behavior":"","product_category":null,"status":"active"}]}
{"products":[{"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524798825649163"},"body_html":"<p>women's coat</p>","images":[{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524798825649163"}],"created_at":"2021-01-15T16:01:01+08:00","template_path":null,"handle":null,"variants":[{"inventory_quantity":44,"image":null,"required_shipping":true,"compare_at_price":"8888.00","taxable":true,"option5":null,"weight":"0.00","title":null,"inventory_policy":"deny","weight_unit":"kg","inventory_item_id":"4703820546801691661","price":"8888.00","product_id":"16047038205454092052571954","option3":null,"option4":null,"inventory_tracker":true,"option1":null,"id":"18047038205456944179971954","option2":null,"position":1,"sku":"shopline-pre-000002","barcode":"shopline-pre-000002"}],"title":"women's coat","tags":"winter clothes","published_scope":"web","product_type":"NORMAL","updated_at":"2022-10-18T16:47:23+08:00","vendor":null,"subtitle":null,"options":[],"spu":null,"id":"16047038205454092052571954","published_at":"2021-01-15T00:00:00+08:00","product_behavior":"","product_category":null,"status":"active"},{"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524799529665633"},"body_html":"<p>woolen coat</p>","images":[{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524799529665633"}],"created_at":"2021-01-15T16:05:30+08:00","template_path":null,"handle":null,"variants":[{"inventory_quantity":12989,"image":null,"required_shipping":true,"compare_at_price":"12.00","taxable":true,"option5":null,"weight":"0.00","title":null,"inventory_policy":"deny","weight_unit":"kg","inventory_item_id":"4703825058429955139","price":"10.00","product_id":"16047038250581279877401954","option3":null,"option4":null,"inventory_tracker":true,"option1":null,"id":"18047038250582286510351954","option2":null,"position":1,"sku":"shopline-pre-000003","barcode":"shopline-pre-000003"}],"title":"woolen coat","tags":null,"published_scope":"web","product_type":"NORMAL","updated_at":"2022-10-09T10:54:57+08:00","vendor":null,"subtitle":null,"options":[],"spu":null,"id":"16047038250581279877401954","published_at":"2021-01-15T00:00:00+08:00","product_behavior":"","product_category":null,"status":"active"},{"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524804076860494"},"body_html":"\n No transaction fees. No design or technical skills required. Integrated with multiple payment and logistic options. With over 120,000 merchants online. Everything you need for your e-commerce store.\n","images":[{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/7e56419e366a44f5ac35d45c87b1e53c.jpeg?w=351&h=319","alt":null,"id":"5759524804076860494"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804227855397"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804378850369"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804513068056"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804664063031"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524804798280754"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805033161772"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805251265575"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805402260546"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805553255504"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805687473245"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524805855245357"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806006240293"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806140458063"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806291452929"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806442447877"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806610220088"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806777992252"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524806928987159"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807063204924"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807214199831"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807348417575"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807482635364"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807633630248"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807767848028"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524807935620136"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808086615081"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808220832823"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808355050529"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808506045509"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808640263253"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808740926532"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524808891921424"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809042916445"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809328129050"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809512678433"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809663673411"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809814668294"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524809982440540"},{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/49586ae18ad84ad5bd947cb8e0fff2c4.jpeg?w=500&h=686","alt":null,"id":"5759524810133435400"}],"created_at":"2021-01-18T10:09:38+08:00","template_path":null,"handle":"TestGoods23","variants":[{"inventory_quantity":998,"image":{"src":"https://img.myshopline.com/image/store/2000006509/1610418722314/64a15e63737447dda83ca9668a64ddbd.jpeg?w=2000&h=682","alt":null,"id":"5759524810317984865"},"required_shipping":true,"compare_at_price":"23.00","taxable":true,"option5":null,"weight":"123.99","title":"green · L1","inventory_policy":"deny","weight_unit":"kg","inventory_item_id":"4707815481808813083","price":"23.00","product_id":"16047078154805505433761954","option3":null,"option4":null,"inventory_tracker":true,"option1":"green","id":"18047078154806512066751954","option2":"L1","position":1,"sku":"green_l1","barcode":null}],"title":"TestGoods23","tags":"123,abc,shopline","published_scope":"web","product_type":"NORMAL","updated_at":"2023-01-13T23:08:59+08:00","vendor":null,"subtitle":null,"options":[{"product_id":"16047078154805505433761954","values":["green"],"values_images":{},"name":"color","id":"16147078154806512066781954"},{"product_id":"16047078154805505433761954","values":["L1"],"values_images":{},"name":"custom_1","id":"16147078154806512066811954"}],"spu":null,"id":"16047078154805505433761954","published_at":"2021-01-18T00:00:00+08:00","product_behavior":"","product_category":null,"status":"active"}]}

Failures and exceptions​

During the query process, there are various reasons that can cause SHOPLINE to stop running your task. Some common reasons include:

  • Insufficient permissions:

    You submitted a query but don't have the necessary permissions for the project. You need to apply for the required permissions first.

  • Internal exceptions:

    Your submitted query couldn't be processed for unpredictable reasons.

  • Token expiration:

    Your access token expired while executing the task. You will need to resubmit the task with a valid token.

Result Notification​

You can obtain the task execution results in two ways:

  • Periodically call the Bulk Task Result Query interface to check the progress of the task execution.
  • Once the bulk change task is completed, we will provide webhook notifications with the event type others/update. You can examine the status field in the notification result to determine the task progress, the type field to identify the task type, and the url field to retrieve the task results.
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.