Save Custom Option

PUT /V1/products/options/{optionId}

Save Custom Option

Path parameters

optionId string Required

Body

option object Required
Hide option attributes Show option attributes object
- product_sku string Required
  
  Product SKU
- option_id integer
  
  Option id
- title string Required
  
  Option title
- type string Required
  
  Option type
- sort_order integer Required
  
  Sort order
- is_require boolean Required
  
  Is require
- price number
  
  Price
- price_type string
  
  Price type
- sku string
  
  Sku
- file_extension string
- max_characters integer
- image_size_x integer
- image_size_y integer
- values array[object]
  Hide values attributes Show values attributes object
  
  title string Required
  
  Option title
  
  sort_order integer Required
  
  Sort order
  
  price number Required
  
  Price
  
  price_type string Required
  
  Price type
  
  sku string
  
  Sku
  
  option_type_id integer
  
  Option type id
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductCustomOptionInterface

Responses

200

200 Success.
Hide response attributes Show response attributes object
- product_sku string Required
  
  Product SKU
- option_id integer
  
  Option id
- title string Required
  
  Option title
- type string Required
  
  Option type
- sort_order integer Required
  
  Sort order
- is_require boolean Required
  
  Is require
- price number
  
  Price
- price_type string
  
  Price type
- sku string
  
  Sku
- file_extension string
- max_characters integer
- image_size_x integer
- image_size_y integer
- values array[object]
  
  Hide values attributes Show values attributes object
  
  title string Required
  
  Option title
  
  sort_order integer Required
  
  Sort order
  
  price number Required
  
  Price
  
  price_type string Required
  
  Price type
  
  sku string
  
  Sku
  
  option_type_id integer
  
  Option type id
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductCustomOptionInterface
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

PUT /V1/products/options/{optionId}

curl \
 -X PUT https://magento2.winkelstraat.mac/rest/all/V1/products/options/{optionId} \
 -d '{"option":{"product_sku":"string","option_id":42,"title":"string","type":"string","sort_order":42,"is_require":true,"price":42.0,"price_type":"string","sku":"string","file_extension":"string","max_characters":42,"image_size_x":42,"image_size_y":42,"values":[{"title":"string","sort_order":42,"price":42.0,"price_type":"string","sku":"string","option_type_id":42}],"extension_attributes":{}}}'

Request examples

{
  "option": {
    "product_sku": "string",
    "option_id": 42,
    "title": "string",
    "type": "string",
    "sort_order": 42,
    "is_require": true,
    "price": 42.0,
    "price_type": "string",
    "sku": "string",
    "file_extension": "string",
    "max_characters": 42,
    "image_size_x": 42,
    "image_size_y": 42,
    "values": [
      {
        "title": "string",
        "sort_order": 42,
        "price": 42.0,
        "price_type": "string",
        "sku": "string",
        "option_type_id": 42
      }
    ],
    "extension_attributes": {}
  }
}

Response examples (200)

{
  "product_sku": "string",
  "option_id": 42,
  "title": "string",
  "type": "string",
  "sort_order": 42,
  "is_require": true,
  "price": 42.0,
  "price_type": "string",
  "sku": "string",
  "file_extension": "string",
  "max_characters": 42,
  "image_size_x": 42,
  "image_size_y": 42,
  "values": [
    {
      "title": "string",
      "sort_order": 42,
      "price": 42.0,
      "price_type": "string",
      "sku": "string",
      "option_type_id": 42
    }
  ],
  "extension_attributes": {}
}

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}