Custom options

Custom product options: text fields (like engraving), drop-down choices and variable pricing per option.

Field Drop-down Pricing

Overview

Create, update, query and delete custom product options. Each option supports specific settings like fixed or percentage pricing, maximum length and derived SKU.

POST/api2/products/customOption

Create a field-type custom option.

{
  "sku": "PRODUTO-001",
  "title": "Engraving name",
  "type": "field",
  "is_require": 1,
  "config": {
    "price": 5,
    "price_type": "fixed",
    "sku": "GRAVACAO",
    "max_characters": 30
  }
}

POST/api2/products/customOption

Create a drop-down custom option.

{
  "sku": "PRODUTO-001",
  "title": "Choose the size",
  "type": "drop_down",
  "is_require": 1,
  "values": [
    {"title": "Small", "price": 0, "price_type": "fixed", "sku": "TAM-P"},
    {"title": "Medium", "price": 10, "price_type": "fixed", "sku": "TAM-M"}
  ]
}

PATCH/api2/products/customOption

Update metadata of a custom option.

{
  "option_id": 18,
  "title": "New title",
  "is_require": 0,
  "sort_order": 2
}

GET/api2/products/customOption?option_id=19

Get a custom option by ID.

DELETE/api2/products/customOption

Delete a custom option from a product.

{
  "option_id": 19
}