Create a configurable product using bulk APIs

Step 3. Define configurable product options

Now that we’ve created all the Champ Tee products, we need to assign size as the configurable attribute and link the simple products to the configurable product.

Set the configurable attribute

The POST async/bulk/V1/configurable-products/bySku/options call assigns the specified attribute_id to be the configurable attribute.

The value assigned to the value_index must be unique within the system.

Endpoint

POST <host>/rest/default/async/bulk/V1/configurable-products/bySku/options

Payload

[{
  "sku": "MS-Champ",
  "option": {
    "attribute_id": "141",
    "label": "Size",
    "position": 0,
    "is_use_default": true,
    "values": [
      {
        "value_index": 9
      }
    ]
  }
}]

Response

{
    "bulk_uuid": "98c46050-cd66-4b49-9d45-69bfa04efc78",
    "request_items": [
        {
            "id": 0,
            "data_hash": null,
            "status": "accepted"
        }
    ],
    "errors": false
}

Now that you have set the configurable attribute to be sku, you can link all simple products to the configurable product and execute a single call with a payload that contains an array of simple products. To do this, specify the sku of the configurable product, and the childSku of each simple product.

Endpoint

Bulk endpoint routes cannot contain input parameters, such as a sku value. You must replace input parameters with a string that begins with by and ends with the input parameter name, such as bySku. See bulk endpoints for more information.

POST <host>/rest/default/async/bulk/V1/configurable-products/bySku/child

Payload

[
  {
    "sku": "MS-Champ",
    "childSku": "MS-Champ-S"
  },
  {
    "sku": "MS-Champ",
    "childSku": "MS-Champ-M"
  },
  {
    "sku": "MS-Champ",
    "childSku": "MS-Champ-L"
  },
  // .... you can link as many products at the same time as required ....
]

Response

{
    "bulk_uuid": "e78042d1-de13-4260-8f56-d5dd13f89e3c",
    "request_items": [
        {
            "id": 0,
            "data_hash": null,
            "status": "accepted"
        },
        {
            "id": 1,
            "data_hash": null,
            "status": "accepted"
        },
        {
            "id": 2,
            "data_hash": null,
            "status": "accepted"
        }
    ],
    "errors": false
}

Verify this step

  • Log in to the Luma website and select Catalog > Products. Click on the Champ Tee configurable product and expand the Configurations section.

Product page with configurable and simple products

  • On the Luma storefront page, search for Champ.

Search results

  • Call GET <host>/rest/default/V1/products/MS-Champ. The response includes the configurable_product_options and configurable_product_links arrays.
...
"configurable_product_options": [
    {
        "id": 338,
        "attribute_id": "141",
        "label": "Size",
        "position": 0,
        "values": [
            {
                "value_index": 168
            },
            {
                "value_index": 169
            },
            {
                "value_index": 170
            }
        ],
        "product_id": 2078
    }
],
"configurable_product_links": [
    2079,
    2080,
    2081
]
},
...