Shops > Tasks > tasksModify
Commerce APIShopsTaskstasksModify
tasksModify
POST:tasks.json

Description

Modify shop task.

Permission bit: "tasks.modify"

Topic: Tasks

Arguments

data: [TaskModify!]!

Main argument for mutations.


ids: [String!]!

List of shop task ids. See also: Unique Identifiers

Example: ["ta_EQzGqWoY"]


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

add_lines: Int

Increment total amount of lines to work on

Example: 43

Valid when: add_lines is a non-negative integer


add_lines_complete: Int

Increment amount of lines successfully processed

Example: 31

Valid when: add_lines_complete is a non-negative integer


add_lines_skipped: Int

Increment amount of lines skipped

Example: 12

Valid when: add_lines_skipped is a non-negative integer


add_messages: [TaskMessageCreate!]

Add messages to the task


auto_done: Boolean

Automatically mark task as done when it reaches "lines" count

Example: false


is_done: Boolean

Whether the worker has finished working on a task or not

Example: false


lines: Int

Total amount of lines submitted

Example: 0

Valid when: lines is a non-negative integer


lines_complete: Int

Amount of lines successfully processed

Example: 0

Valid when: lines_complete is a non-negative integer


lines_skipped: Int

Amount of lines skipped

Example: 0

Valid when: lines_skipped is a non-negative integer


path: String

Path where the resulting file is stored

Example: "hello/123.txt"

Valid when: path's length doesn't exceed 250 characters


result_name: String

Name of the result

Example: "customers"

Valid when: result_name's length doesn't exceed 250 characters


Result

[Task!]

Preview (typescript)

Loading module