draftOrderBulkAddTags

mutation

Requires write_draft_orders access scope. Also: The user must have access to manage draft orders.

Adds tags to multiple draft orders.

Arguments

Anchor to idsids • [ID!]: The IDs of the draft orders to add tags to.
Anchor to savedSearchIdsavedSearchId • ID: The ID of the draft order saved search for filtering draft orders on.
Anchor to searchsearch • String: The conditions for filtering draft orders on. See the detailed search syntax.
Anchor to tagstags • [String!]!required: List of tags to be added.

Was this section helpful?

Anchor to DraftOrderBulkAddTagsPayload returnsDraftOrderBulkAddTagsPayload returns

Anchor to jobjob • Job: The asynchronous job for adding tags to the draft orders.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation draftOrderBulkAddTags($ids: [ID!], $savedSearchId: ID, $search: String, $tags: [String!]!) {
2  draftOrderBulkAddTags(ids: $ids, savedSearchId: $savedSearchId, search: $search, tags: $tags) {
3    job {
4      # Job fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "ids": [
3    "gid://shopify/<objectName>/10079785100"
4  ],
5  "savedSearchId": "gid://shopify/<objectName>/10079785100",
6  "search": "<your-search>",
7  "tags": [
8    "<your-tags>"
9  ]
10}

{
  "ids": [
    "gid://shopify/<objectName>/10079785100"
  ],
  "savedSearchId": "gid://shopify/<objectName>/10079785100",
  "search": "<your-search>",
  "tags": [
    "<your-tags>"
  ]
}