quickUpdateVariantField

Requires permission products:product:update.

Quick update a single variant field - optimized for spreadsheet editing

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation QuickUpdateVariantField($field: String!, $variantId: ID!) {
  quickUpdateVariantField(field: $field, variantId: $variantId)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation QuickUpdateVariantField($field: String!, $variantId: ID!) {\n  quickUpdateVariantField(field: $field, variantId: $variantId)\n}",
  "variables": {
    "field": "string",
    "variantId": "id"
  }
}
EOF

Variables:

{
  "field": "string",
  "variantId": "id"
}

Response:

{
  "data": {
    "quickUpdateVariantField": true
  }
}

quickUpdateVariantField(
  field: String!
  value: String
  variantId: ID!
): Boolean!

Arguments

quickUpdateVariantField.field ● String! non-null scalar

The name of the variant field to change.

quickUpdateVariantField.value ● String scalar

The new value. Send null to clear it.

quickUpdateVariantField.variantId ● ID! non-null scalar

The ID of the product variant.

Type

Boolean scalar

The Boolean scalar type represents true or false.