Actions218
- Batch Actions
- Country Actions
- Customer Actions
- Customer Address Actions
- Department Actions
- FAQ Actions
- FAQ Category Actions
- GraphQL Actions
- Markup Master Actions
- Master Option Range Actions
- Master Option Stock Actions
- Master Option Tag Actions
- Mutation Actions
- Add Proof Version
- Assign Options
- Modify Order Product (Beta)
- Set Additional Option (Beta)
- Set Additional Option Attributes (Beta)
- Set Batch
- Set Department
- Set FAQ Category
- Set Markup Master (Legacy Alias)
- Set Master Option
- Set Master Option Attribute Price
- Set Master Option Attributes
- Set Master Option Rules (Legacy Alias)
- Set Master Option Tags
- Set Option Formulas
- Set Option Group
- Set Order (Staging)
- Set Order Product
- Set Product
- Set Product Category
- Set Product Design
- Set Product Image Gallery
- Set Product Option Rules
- Set Product Pages
- Set Product Price
- Set Product Size
- Set Product SKU (Staging)
- Set Products Attribute Price (Beta)
- Set Quantity Based Attribute Price (Beta)
- Set Quote
- Set Shipment
- Set Store
- Set Store Address
- Set Store Markup
- Update Order Product Images
- Update Order Status
- Update Ziflow Link (Images)
- Upload Order Product Files From URLs
- Option Formula Actions
- Option Group Actions
- Order Actions
- Order Detail Actions
- Order Product Actions
- Order Shipment Actions
- Payment Term Actions
- Product Actions
- Get Category
- Get Detailed
- Get FAQs
- Get Many Categories
- Get Many Detailed
- Get Many FAQs
- Get Many Master Option Ranges (Legacy)
- Get Many Master Option Tags (Legacy)
- Get Many Master Options
- Get Many Option Groups (Legacy)
- Get Many Option Prices
- Get Many Options Rules
- Get Many Prices
- Get Many Simple
- Get Master Options
- Get Option Prices
- Get Options Rules
- Get Prices
- Get Simple
- Get SKU Matrix (Staging)
- Get Stock
- Set Product SKU (Staging)
- Update Stock
- Product Stock Actions
- Quote Actions
- Quote Product Actions
- Ship To Multiple Actions
- Status Actions
- Store Actions
- Store Address Actions
- Store Markup Actions
- Complete API Actions
- Account Summary
- Admin Extra Field Values
- Admin Extra Fields
- Attributes
- Authenticate Customer
- Customer Address Details
- Customers
- Faq
- Get Batch
- Get Countries
- Get Custom Formula
- Get Departments
- Get Faq Category
- Get Master Option Combination Matrix
- Get Master Option Range
- Get Master Option Stock Configs
- Get Master Option Stock History
- Get Master Option Tag
- Get Option Group
- Get Payment Term Master
- Get Product SKU Matrix
- Get Quote
- Get Store
- Get Store Locations
- Get Store Markup
- Get User Basket
- Order Billing Details
- Order Blind Details
- Order Delivery Details
- Order Products
- Order Shipment Details
- Order Status
- Order Summary
- Orders
- Product Additional Options
- Product Category
- Product Master Options
- Product Option Rules
- Product Options Price
- Product Price
- Product Size
- Product Stocks
- Products
- Products Attribute Price
- Products Details
- Products Image Gallery
- Quantity Based Attribute Price
- Quoteproduct
- Ship To Multiple Address
- Store Credit Summary
- Storeaddress
- Validate Customer Token
- Add Master Option Stock Config
- Delete Master Option Stock Config
- Modify Order Product
- Notify User
- Set Additional Option
- Set Additional Option Attributes
- Set Admin Extra Field
- Set Admin Extra Field Values
- Set Assign Options
- Set Batch
- Set Batch Job
- Set Custom Formula
- Set Customer
- Set Customer Address Detail
- Set Department
- Set Faq
- Set Faq Category
- Set Master Option
- Set Master Option Attribute Price
- Set Master Option Attributes
- Set Master Option Range
- Set Master Option Stock Settings
- Set Master Option Tag
- Set Option Group
- Set Order
- Set Order Product
- Set Order Product Image
- Set Order Product Image From URL
- Set Product
- Set Product Category
- Set Product Design
- Set Product Option Rules
- Set Product Pages
- Set Product Price
- Set Product Size
- Set Product SKU
- Set Products Attribute Price
- Set Products Image Gallery
- Set Quantity Based Attribute Price
- Set Quote
- Set Shipment
- Set Store
- Set Store Address
- Set Store Location
- Set Store Markup
- Set User Basket
- Update Master Option Stock
- Update Order Status
- Update Product Stock
Complete API → Set Additional Option
AI-generatedSummary
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.