Skip to main content
Anchor to ProductOptionUpdatePayload

ProductOptionUpdatePayload

payload

Return type for productOptionUpdate mutation.

•Product

The product with which the option being updated is associated.

•[ProductOptionUpdateUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Updates an option on a product, such as size, color, or material. Each option includes a name, position, and a list of values. The combination of a product option and value creates a product variant.

Use the productOptionUpdate mutation for the following use cases:

  • Update product choices: Modify an existing option, like "Size" (Small, Medium, Large) or "Color" (Red, Blue, Green), so customers can select their preferred variant.
  • Enable personalization features: Update an option (for example, "Engraving text") to let customers customize their purchase.
  • Offer seasonal or limited edition products: Update a value (for example, "Holiday red") on an existing option to support limited-time or seasonal variants.
  • Integrate with apps that manage product configuration: Allow third-party apps to update options, like "Bundle size", when customers select or customize product bundles.
  • Link options to metafields: Associate a product option with a custom metafield, like "Fabric code", for richer integrations with other systems or apps.

Note

The productOptionUpdate mutation enforces strict data integrity for product options and variants. All option positions must be sequential, and every option should be used by at least one variant.


After you update a product option, you can further manage a product's configuration using related mutations:

Learn more about the product model and adding product data.


Was this section helpful?