Skip to content

Commit

Permalink
Merge pull request #307 from arnobsh/ACP2E-2872
Browse files Browse the repository at this point in the history 
ACP2E-2872: [Documentation] Update documentation regarding Bundle pro…
  • Loading branch information
@keharper
keharper authored Apr 29, 2024
2 parents edbec84 + 5acd8a2 commit a92f58d
Show file tree
Hide file tree
Showing 2 changed files with 304 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/data/navigation/sections/rest.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,10 @@ module.exports = [
title: "Step 3. Create the bundle product",
path: "/rest/tutorials/bundle-product/create-bundle-product.md",
},
{
title: "Step 4. Update bundle product options and option links",
path: "/rest/tutorials/bundle-product/update-options-and-links.md",
},
],
},
{
Expand Down
300 changes: 300 additions & 0 deletions src/pages/rest/tutorials/bundle-product/update-options-and-links.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,300 @@
---
title: Step 4. Update bundle product options and option links
description: In this step, you will pdate store-specific bundle product option and option links.
keywords:
- REST
---

# Step 4. Update product options or option links (optional)

Updating bundle product options or option links requires the following steps:

1. Get bundle product details
2. Update bundle product options
3. Update bundle product links

## 1. Get bundle product details

The following example retrieves store-specific bundle product details for a multi-store configuration by using the `GET {store_code}/V1/products/{sku}` call.

**Request:**

```html
GET http://domain.com/rest/default/V1/products/Desktop-Computer
```

**Response:**

```json
{
"id": 25,
"sku": "Desktop-Computer",
"name": "Desktop Computer",
"attribute_set_id": 4,
"price": 0,
"status": 1,
"visibility": 4,
"type_id": "bundle",
"created_at": "2022-04-15 18:04:04",
"updated_at": "2022-04-15 18:04:04",
"weight": 0,
"extension_attributes": {
"website_ids": [
1
],
"category_links": [
{
"position": 0,
"category_id": "32"
}
],
"stock_item": {
"item_id": 25,
"product_id": 25,
"stock_id": 1,
"qty": 0,
"is_in_stock": true,
"is_qty_decimal": false,
"show_default_notification_message": false,
"use_config_min_qty": true,
"min_qty": 0,
"use_config_min_sale_qty": 1,
"min_sale_qty": 1,
"use_config_max_sale_qty": true,
"max_sale_qty": 10000,
"use_config_backorders": true,
"backorders": 0,
"use_config_notify_stock_qty": true,
"notify_stock_qty": 1,
"use_config_qty_increments": true,
"qty_increments": 0,
"use_config_enable_qty_inc": true,
"enable_qty_increments": false,
"use_config_manage_stock": true,
"manage_stock": true,
"low_stock_date": null,
"is_decimal_divided": false,
"stock_status_changed_auto": 0
},
"bundle_product_options": [
{
"option_id": 14,
"title": "RAM",
"required": true,
"type": "select",
"position": 1,
"sku": "Desktop-Computer",
"product_links": [
{
"id": "19",
"sku": "RAM-12GB",
"option_id": 14,
"qty": 1,
"position": 1,
"is_default": false,
"price": 25,
"price_type": null,
"can_change_quantity": 0
},
{
"id": "20",
"sku": "RAM-24GB",
"option_id": 14,
"qty": 1,
"position": 2,
"is_default": false,
"price": 50,
"price_type": null,
"can_change_quantity": 0
}
]
},
{
"option_id": 15,
"title": "Monitor",
"required": true,
"type": "select",
"position": 2,
"sku": "Desktop-Computer",
"product_links": [
{
"id": "21",
"sku": "Monitor-15",
"option_id": 15,
"qty": 1,
"position": 1,
"is_default": false,
"price": 100,
"price_type": null,
"can_change_quantity": 0
},
{
"id": "22",
"sku": "Monitor-17",
"option_id": 15,
"qty": 1,
"position": 2,
"is_default": false,
"price": 150,
"price_type": null,
"can_change_quantity": 0
}
]
}
]
},
"options": [],
"media_gallery_entries": [],
"custom_attributes": [
{
"attribute_code": "shipment_type",
"value": "0"
},
{
"attribute_code": "options_container",
"value": "container2"
},
{
"attribute_code": "msrp_display_actual_price_type",
"value": "0"
},
{
"attribute_code": "url_key",
"value": "desktop-computer"
},
{
"attribute_code": "price_view",
"value": "0"
},
{
"attribute_code": "required_options",
"value": "0"
},
{
"attribute_code": "has_options",
"value": "0"
},
{
"attribute_code": "sku_type",
"value": "0"
},
{
"attribute_code": "price_type",
"value": "0"
},
{
"attribute_code": "tax_class_id",
"value": "2"
},
{
"attribute_code": "weight_type",
"value": "0"
},
{
"attribute_code": "category_ids",
"value": [
"32"
]
}
]
}
```

Retrieve the `option_id` values from the bundle product options section of the response and use it to update the bundle product option and option links.

## 2. Update bundle product options

The following example uses the `PUT /V1/bundle-products/options/{optionId}` call
to update the bundle product option. For a store-specific request, add the `store_code`.
For example, `PUT {store_code}/V1/bundle-products/options/{optionId}`.

**Endpoint:**

```html
PUT http://domain.com/rest/default/V1/bundle-products/options/14
```

<CodeBlock slots="heading, code" repeat="2" languages="JSON, JSON" />

#### Payload

```json
{
"option_id": 14,
"title": "RAM-Version-2",
"required": true,
"type": "select",
"position": 1,
"sku": "Desktop-Computer",
"product_links": [
{
"id": "19",
"sku": "RAM-12GB",
"option_id": 14,
"qty": 2,
"position": 1,
"is_default": false,
"price": 50,
"price_type": null,
"can_change_quantity": 0,
"extension_attributes": {}
},
{
"id": "20",
"sku": "RAM-24GB",
"option_id": 14,
"qty": 2,
"position": 2,
"is_default": false,
"price": 100,
"price_type": null,
"can_change_quantity": 0,
"extension_attributes": {}
}
],
"extension_attributes": {}
}
```

#### Response

```json
14
```

## 3. Update bundle product links

The following example uses the `PUT /V1/bundle-products/{sku}/links/{optionId}` call to update a bundle product option link.

**Endpoint:**

```html
PUT http://domain.com/rest/default/V1/bundle-products/Desktop-Computer/links/14
```

<CodeBlock slots="heading, code" repeat="2" languages="JSON, JSON" />

#### Payload

```json
{
"linkedProduct":
{
"id": "19",
"option_id": 14,
"sku": "RAM-12GB",
"qty": 2,
"is_default": false,
"can_change_quantity": 0,
"price": 50,
"price_type": 0,
"extension_attributes": { }
}
}
```

#### Response

```json
true
```

0 comments on commit a92f58d

Please sign in to comment.