updateOption

mutation

Requires commerce.product:write.

Update an existing option.

Required headers

Header	Required	Description
`x-store-id`	Yes	ID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: `extensions.code: "UNAUTHENTICATED"`.

Go to Authentication for credential setup.

Arguments

id String! required
input MutationUpdateOptionInput! required
- description String optional
- htmlDescription String optional
- HTMLDescription String optional — Deprecated: Use htmlDescription instead.
- label String optional
- metafields [UpsertMetafieldInput!] optional
  - key String! required
  - namespace String! required
  - type String! required
  - value String! required
- name String optional
- position Int optional
- shareable Boolean optional
- type String optional — The type of the Option, one of TEXT, NUMBER, LIST. Option Values are only available on the 'LIST' type.
- validation CreateOptionValidationInput optional
  - max Int optional
  - min Int optional

Possible returns

Option Option

mutation RunUpdateOption($id: String!, $input: MutationUpdateOptionInput!) {  updateOption(id: $id, input: $input) {    __typename    ... on ListOption {      id      name      label      type    }    ... on NumericOption {      id      name      label      type    }    ... on TextOption {      id      name      label      type    }  }}

{  "data": {    "updateOption": {      "__typename": "ListOption",      "id": "ID_VALUE",      "name": "Example",      "label": "Example",      "type": "TYPE_VALUE"    }  }}

Last updated on