Add new option for bundle product

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://magento2.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

      
          mcp.json

"Magento2 MCP server": {
  "url": "https://magento2.doc.winkelstraat.nl/mcp"
}

PUT /V1/bundle-products/options/{optionId}

Add new option for bundle product

Path parameters

optionId string Required

Body

option object Required

Interface OptionInterface
Hide option attributes Show option attributes object
- option_id integer
  
  Option id
- title string
  
  Option title
- required boolean
  
  Is required option
- type string
  
  Input type
- position integer
  
  Option position
- sku string
  
  Product sku
- product_links array[object]
  
  Product links
  Hide product_links attributes Show product_links attributes object
  
  Interface LinkInterface
  
  id string
  
  The identifier
  
  sku string
  
  Linked product sku
  
  option_id integer
  
  Option id
  
  qty number
  
  Qty
  
  position integer
  
  Position
  
  is_default boolean Required
  
  Is default
  
  price number Required
  
  Price
  
  price_type integer Required
  
  Price type
  
  can_change_quantity integer
  
  Whether quantity could be changed
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\LinkInterface
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionInterface

Body

option object Required

Interface OptionInterface
Hide option attributes Show option attributes object
- option_id integer
  
  Option id
- title string
  
  Option title
- required boolean
  
  Is required option
- type string
  
  Input type
- position integer
  
  Option position
- sku string
  
  Product sku
- product_links array[object]
  
  Product links
  Hide product_links attributes Show product_links attributes object
  
  Interface LinkInterface
  
  id string
  
  The identifier
  
  sku string
  
  Linked product sku
  
  option_id integer
  
  Option id
  
  qty number
  
  Qty
  
  position integer
  
  Position
  
  is_default boolean Required
  
  Is default
  
  price number Required
  
  Price
  
  price_type integer Required
  
  Price type
  
  can_change_quantity integer
  
  Whether quantity could be changed
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\LinkInterface
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionInterface

Responses

200

application/json

application/json application/xml

200 Success.
401

application/json

application/json application/xml

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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
400

application/json

application/json application/xml

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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

application/json

application/json application/xml

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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/bundle-products/options/{optionId}

curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/bundle-products/options/{optionId}' \
 --header "Content-Type: application/json" \
 --data '{"option":{"option_id":42,"title":"string","required":true,"type":"string","position":42,"sku":"string","product_links":[{"id":"string","sku":"string","option_id":42,"qty":42.0,"position":42,"is_default":true,"price":42.0,"price_type":42,"can_change_quantity":42,"extension_attributes":{}}],"extension_attributes":{}}}'

curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/bundle-products/options/{optionId}' \
 --header "Content-Type: application/xml"

Request examples

{
  "option": {
    "option_id": 42,
    "title": "string",
    "required": true,
    "type": "string",
    "position": 42,
    "sku": "string",
    "product_links": [
      {
        "id": "string",
        "sku": "string",
        "option_id": 42,
        "qty": 42.0,
        "position": 42,
        "is_default": true,
        "price": 42.0,
        "price_type": 42,
        "can_change_quantity": 42,
        "extension_attributes": {}
      }
    ],
    "extension_attributes": {}
  }
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <option>
    <option-id type="integer">42</option-id>
    <title>string</title>
    <required type="boolean">true</required>
    <type>string</type>
    <position type="integer">42</position>
    <sku>string</sku>
    <product-links type="array">
      <product-link>
        <id>string</id>
        <sku>string</sku>
        <option-id type="integer">42</option-id>
        <qty type="float">42.0</qty>
        <position type="integer">42</position>
        <is-default type="boolean">true</is-default>
        <price type="float">42.0</price>
        <price-type type="integer">42</price-type>
        <can-change-quantity type="integer">42</can-change-quantity>
        <extension-attributes>
        </extension-attributes>
      </product-link>
    </product-links>
    <extension-attributes>
    </extension-attributes>
  </option>
</root>

Response examples (200)

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 (401)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

Response examples (400)

{
  "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 (400)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

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"
}

Response examples (default)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>