OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Set Additional Option

AI-generated

Summary

Send a mutation request to the OnPrintShop API to create or update product additional options by specifying one or more AdditionalOptionInput objects.

Inputs

  • Inputs (required) — An array of AdditionalOptionInput objects representing the additional options to set or update. Each object can include various optional fields such as applicable_for, apply_multiplication, cover_option, custom_txtbox_opt_id, delete, description, display_above_size, display_in_calculator, exclude_price, exclude_setup_cost_reorder, hide_from_calc, hire_designer_option, master_option_id, min_default_value, multiplier, multiplier_type, option_key, options_code, options_type, price_calculate_type, prod_add_opt_export_group_id, prod_add_opt_group_id, prod_add_opt_id, product_option_desc_position, product_option_position, products_id, required, setup_cost, size_id, sort_order, status, and title.
  • Safe Mode — Boolean to block mutations in Complete API mode, preventing unintended writes.
  • Partial Response — Whether to fail on errors or return partial data if some items fail.
  • Return Fields Mode — Choose whether to return all fields or select specific fields from the response.
  • Return Fields — Specific fields to return if Return Fields Mode is set to Custom Selection.

Output shape

a flat array of response objects, each corresponding to an input AdditionalOptionInput object, containing fields such as index, result, message, and id indicating the outcome of the mutation for that input.

Supports batch processing by sending multiple additional option inputs. Errors will throw exceptions unless Continue On Fail is enabled. The response contains success or error details for each submitted additional option.

Examples

Example 1: Set or update a list of product additional options

Provide an array of AdditionalOptionInput objects with desired fields such as title, description, products_id, status, and other optional fields to define new or modified additional options on products. Enable Safe Mode to prevent changes if using Complete API mode.

Links

Discussion