Children
Get all children for Configurable product
get
/V1/configurable-products/{sku}/children
Path parameters
skustringrequired
(Required)
Example:
<string>
Responses
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
--url 'http://{{baseurl}}/V1/configurable-products/{sku}/children'
200
401
500
[
{
"sku": "<string>",
"id": "<integer>",
"name": "<string>",
"attribute_set_id": "<integer>",
"price": "<number>",
"status": "<integer>",
"visibility": "<integer>",
"type_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"weight": "<number>",
"extension_attributes": {
"website_ids": [
"<integer>",
"<integer>"
],
"category_links": [
{
"category_id": "<string>",
"position": "<integer>",
"extension_attributes": "<object>"
},
{
"category_id": "<string>",
"position": "<integer>",
"extension_attributes": "<object>"
}
],
"stock_item": {
"qty": "<number>",
"is_in_stock": "<boolean>",
"is_qty_decimal": "<boolean>",
"show_default_notification_message": "<boolean>",
"use_config_min_qty": "<boolean>",
"min_qty": "<number>",
"use_config_min_sale_qty": "<integer>",
"min_sale_qty": "<number>",
"use_config_max_sale_qty": "<boolean>",
"max_sale_qty": "<number>",
"use_config_backorders": "<boolean>",
"backorders": "<integer>",
"use_config_notify_stock_qty": "<boolean>",
"notify_stock_qty": "<number>",
"use_config_qty_increments": "<boolean>",
"qty_increments": "<number>",
"use_config_enable_qty_inc": "<boolean>",
"enable_qty_increments": "<boolean>",
"use_config_manage_stock": "<boolean>",
"manage_stock": "<boolean>",
"low_stock_date": "<string>",
"is_decimal_divided": "<boolean>",
"stock_status_changed_auto": "<integer>",
"item_id": "<integer>",
"product_id": "<integer>",
"stock_id": "<integer>",
"extension_attributes": "<object>"
},
"bundle_product_options": [
{
"option_id": "<integer>",
"title": "<string>",
"required": "<boolean>",
"type": "<string>",
"position": "<integer>",
"sku": "<string>",
"product_links": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"extension_attributes": "<object>"
},
{
"option_id": "<integer>",
"title": "<string>",
"required": "<boolean>",
"type": "<string>",
"position": "<integer>",
"sku": "<string>",
"product_links": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"extension_attributes": "<object>"
}
],
"downloadable_product_links": [
{
"sort_order": "<integer>",
"is_shareable": "<integer>",
"price": "<number>",
"link_type": "<string>",
"sample_type": "<string>",
"id": "<integer>",
"title": "<string>",
"number_of_downloads": "<integer>",
"link_file": "<string>",
"link_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"link_url": "<string>",
"sample_file": "<string>",
"sample_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"sample_url": "<string>",
"extension_attributes": "<object>"
},
{
"sort_order": "<integer>",
"is_shareable": "<integer>",
"price": "<number>",
"link_type": "<string>",
"sample_type": "<string>",
"id": "<integer>",
"title": "<string>",
"number_of_downloads": "<integer>",
"link_file": "<string>",
"link_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"link_url": "<string>",
"sample_file": "<string>",
"sample_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"sample_url": "<string>",
"extension_attributes": "<object>"
}
],
"downloadable_product_samples": [
{
"title": "<string>",
"sort_order": "<integer>",
"sample_type": "<string>",
"id": "<integer>",
"sample_file": "<string>",
"sample_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"sample_url": "<string>",
"extension_attributes": "<object>"
},
{
"title": "<string>",
"sort_order": "<integer>",
"sample_type": "<string>",
"id": "<integer>",
"sample_file": "<string>",
"sample_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"sample_url": "<string>",
"extension_attributes": "<object>"
}
],
"configurable_product_options": [
{
"id": "<integer>",
"attribute_id": "<string>",
"label": "<string>",
"position": "<integer>",
"is_use_default": "<boolean>",
"values": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"extension_attributes": "<object>",
"product_id": "<integer>"
},
{
"id": "<integer>",
"attribute_id": "<string>",
"label": "<string>",
"position": "<integer>",
"is_use_default": "<boolean>",
"values": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"extension_attributes": "<object>",
"product_id": "<integer>"
}
],
"configurable_product_links": [
"<integer>",
"<integer>"
]
},
"product_links": [
{
"sku": "<string>",
"link_type": "<string>",
"linked_product_sku": "<string>",
"linked_product_type": "<string>",
"position": "<integer>",
"extension_attributes": {
"qty": "<number>"
}
},
{
"sku": "<string>",
"link_type": "<string>",
"linked_product_sku": "<string>",
"linked_product_type": "<string>",
"position": "<integer>",
"extension_attributes": {
"qty": "<number>"
}
}
],
"options": [
{
"product_sku": "<string>",
"title": "<string>",
"type": "<string>",
"sort_order": "<integer>",
"is_require": "<boolean>",
"option_id": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"file_extension": "<string>",
"max_characters": "<integer>",
"image_size_x": "<integer>",
"image_size_y": "<integer>",
"values": [
{
"title": "<string>",
"sort_order": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"option_type_id": "<integer>"
},
{
"title": "<string>",
"sort_order": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"option_type_id": "<integer>"
}
],
"extension_attributes": {
"vertex_flex_field": "<string>"
}
},
{
"product_sku": "<string>",
"title": "<string>",
"type": "<string>",
"sort_order": "<integer>",
"is_require": "<boolean>",
"option_id": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"file_extension": "<string>",
"max_characters": "<integer>",
"image_size_x": "<integer>",
"image_size_y": "<integer>",
"values": [
{
"title": "<string>",
"sort_order": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"option_type_id": "<integer>"
},
{
"title": "<string>",
"sort_order": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"option_type_id": "<integer>"
}
],
"extension_attributes": {
"vertex_flex_field": "<string>"
}
}
],
"media_gallery_entries": [
{
"media_type": "<string>",
"label": "<string>",
"position": "<integer>",
"disabled": "<boolean>",
"types": [
"<string>",
"<string>"
],
"id": "<integer>",
"file": "<string>",
"content": {
"base64_encoded_data": "<string>",
"type": "<string>",
"name": "<string>"
},
"extension_attributes": {
"video_content": {
"media_type": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_provider": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_url": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_title": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_description": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_metadata": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
}
}
},
{
"media_type": "<string>",
"label": "<string>",
"position": "<integer>",
"disabled": "<boolean>",
"types": [
"<string>",
"<string>"
],
"id": "<integer>",
"file": "<string>",
"content": {
"base64_encoded_data": "<string>",
"type": "<string>",
"name": "<string>"
},
"extension_attributes": {
"video_content": {
"media_type": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_provider": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_url": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_title": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_description": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_metadata": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
}
}
}
],
"tier_prices": [
{
"customer_group_id": "<integer>",
"qty": "<number>",
"value": "<number>",
"extension_attributes": {
"percentage_value": "<number>",
"website_id": "<integer>"
}
},
{
"customer_group_id": "<integer>",
"qty": "<number>",
"value": "<number>",
"extension_attributes": {
"percentage_value": "<number>",
"website_id": "<integer>"
}
}
],
"custom_attributes": [
{
"attribute_code": "fugiat aliquip nulla dolore",
"value": "veniam"
},
{
"attribute_code": "amet eiusmod",
"value": "in esse"
}
]
},
{
"sku": "<string>",
"id": "<integer>",
"name": "<string>",
"attribute_set_id": "<integer>",
"price": "<number>",
"status": "<integer>",
"visibility": "<integer>",
"type_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"weight": "<number>",
"extension_attributes": {
"website_ids": [
"<integer>",
"<integer>"
],
"category_links": [
{
"category_id": "<string>",
"position": "<integer>",
"extension_attributes": "<object>"
},
{
"category_id": "<string>",
"position": "<integer>",
"extension_attributes": "<object>"
}
],
"stock_item": {
"qty": "<number>",
"is_in_stock": "<boolean>",
"is_qty_decimal": "<boolean>",
"show_default_notification_message": "<boolean>",
"use_config_min_qty": "<boolean>",
"min_qty": "<number>",
"use_config_min_sale_qty": "<integer>",
"min_sale_qty": "<number>",
"use_config_max_sale_qty": "<boolean>",
"max_sale_qty": "<number>",
"use_config_backorders": "<boolean>",
"backorders": "<integer>",
"use_config_notify_stock_qty": "<boolean>",
"notify_stock_qty": "<number>",
"use_config_qty_increments": "<boolean>",
"qty_increments": "<number>",
"use_config_enable_qty_inc": "<boolean>",
"enable_qty_increments": "<boolean>",
"use_config_manage_stock": "<boolean>",
"manage_stock": "<boolean>",
"low_stock_date": "<string>",
"is_decimal_divided": "<boolean>",
"stock_status_changed_auto": "<integer>",
"item_id": "<integer>",
"product_id": "<integer>",
"stock_id": "<integer>",
"extension_attributes": "<object>"
},
"bundle_product_options": [
{
"option_id": "<integer>",
"title": "<string>",
"required": "<boolean>",
"type": "<string>",
"position": "<integer>",
"sku": "<string>",
"product_links": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"extension_attributes": "<object>"
},
{
"option_id": "<integer>",
"title": "<string>",
"required": "<boolean>",
"type": "<string>",
"position": "<integer>",
"sku": "<string>",
"product_links": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"extension_attributes": "<object>"
}
],
"downloadable_product_links": [
{
"sort_order": "<integer>",
"is_shareable": "<integer>",
"price": "<number>",
"link_type": "<string>",
"sample_type": "<string>",
"id": "<integer>",
"title": "<string>",
"number_of_downloads": "<integer>",
"link_file": "<string>",
"link_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"link_url": "<string>",
"sample_file": "<string>",
"sample_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"sample_url": "<string>",
"extension_attributes": "<object>"
},
{
"sort_order": "<integer>",
"is_shareable": "<integer>",
"price": "<number>",
"link_type": "<string>",
"sample_type": "<string>",
"id": "<integer>",
"title": "<string>",
"number_of_downloads": "<integer>",
"link_file": "<string>",
"link_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"link_url": "<string>",
"sample_file": "<string>",
"sample_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"sample_url": "<string>",
"extension_attributes": "<object>"
}
],
"downloadable_product_samples": [
{
"title": "<string>",
"sort_order": "<integer>",
"sample_type": "<string>",
"id": "<integer>",
"sample_file": "<string>",
"sample_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"sample_url": "<string>",
"extension_attributes": "<object>"
},
{
"title": "<string>",
"sort_order": "<integer>",
"sample_type": "<string>",
"id": "<integer>",
"sample_file": "<string>",
"sample_file_content": {
"file_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"extension_attributes": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"sample_url": "<string>",
"extension_attributes": "<object>"
}
],
"configurable_product_options": [
{
"id": "<integer>",
"attribute_id": "<string>",
"label": "<string>",
"position": "<integer>",
"is_use_default": "<boolean>",
"values": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"extension_attributes": "<object>",
"product_id": "<integer>"
},
{
"id": "<integer>",
"attribute_id": "<string>",
"label": "<string>",
"position": "<integer>",
"is_use_default": "<boolean>",
"values": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
},
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"extension_attributes": "<object>",
"product_id": "<integer>"
}
],
"configurable_product_links": [
"<integer>",
"<integer>"
]
},
"product_links": [
{
"sku": "<string>",
"link_type": "<string>",
"linked_product_sku": "<string>",
"linked_product_type": "<string>",
"position": "<integer>",
"extension_attributes": {
"qty": "<number>"
}
},
{
"sku": "<string>",
"link_type": "<string>",
"linked_product_sku": "<string>",
"linked_product_type": "<string>",
"position": "<integer>",
"extension_attributes": {
"qty": "<number>"
}
}
],
"options": [
{
"product_sku": "<string>",
"title": "<string>",
"type": "<string>",
"sort_order": "<integer>",
"is_require": "<boolean>",
"option_id": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"file_extension": "<string>",
"max_characters": "<integer>",
"image_size_x": "<integer>",
"image_size_y": "<integer>",
"values": [
{
"title": "<string>",
"sort_order": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"option_type_id": "<integer>"
},
{
"title": "<string>",
"sort_order": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"option_type_id": "<integer>"
}
],
"extension_attributes": {
"vertex_flex_field": "<string>"
}
},
{
"product_sku": "<string>",
"title": "<string>",
"type": "<string>",
"sort_order": "<integer>",
"is_require": "<boolean>",
"option_id": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"file_extension": "<string>",
"max_characters": "<integer>",
"image_size_x": "<integer>",
"image_size_y": "<integer>",
"values": [
{
"title": "<string>",
"sort_order": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"option_type_id": "<integer>"
},
{
"title": "<string>",
"sort_order": "<integer>",
"price": "<number>",
"price_type": "<string>",
"sku": "<string>",
"option_type_id": "<integer>"
}
],
"extension_attributes": {
"vertex_flex_field": "<string>"
}
}
],
"media_gallery_entries": [
{
"media_type": "<string>",
"label": "<string>",
"position": "<integer>",
"disabled": "<boolean>",
"types": [
"<string>",
"<string>"
],
"id": "<integer>",
"file": "<string>",
"content": {
"base64_encoded_data": "<string>",
"type": "<string>",
"name": "<string>"
},
"extension_attributes": {
"video_content": {
"media_type": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_provider": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_url": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_title": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_description": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_metadata": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
}
}
},
{
"media_type": "<string>",
"label": "<string>",
"position": "<integer>",
"disabled": "<boolean>",
"types": [
"<string>",
"<string>"
],
"id": "<integer>",
"file": "<string>",
"content": {
"base64_encoded_data": "<string>",
"type": "<string>",
"name": "<string>"
},
"extension_attributes": {
"video_content": {
"media_type": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_provider": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_url": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_title": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_description": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"video_metadata": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
}
}
}
],
"tier_prices": [
{
"customer_group_id": "<integer>",
"qty": "<number>",
"value": "<number>",
"extension_attributes": {
"percentage_value": "<number>",
"website_id": "<integer>"
}
},
{
"customer_group_id": "<integer>",
"qty": "<number>",
"value": "<number>",
"extension_attributes": {
"percentage_value": "<number>",
"website_id": "<integer>"
}
}
],
"custom_attributes": [
{
"attribute_code": "reprehenderit",
"value": "pariatur Duis fugiat"
},
{
"attribute_code": "E",
"value": "ullamco sed"
}
]
}
]
OK
Remove configurable product option
delete
/V1/configurable-products/{sku}/children/{childSku}
Path parameters
skustringrequired
(Required)
Example:
<string>
childSkustringrequired
(Required)
Example:
<string>
Responses
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
--request DELETE \
--url 'http://{{baseurl}}/V1/configurable-products/{sku}/children/{childSku}'
200
400
401
500
true
OK