{"id":4526,"date":"2018-03-03T15:13:21","date_gmt":"2018-03-03T14:13:21","guid":{"rendered":"https:\/\/florianbrinkmann.com\/en\/?p=4526"},"modified":"2020-02-09T11:27:55","modified_gmt":"2020-02-09T10:27:55","slug":"creating-a-woocommerce-product-variation-rest-api","status":"publish","type":"post","link":"https:\/\/florianbrinkmann.com\/en\/creating-a-woocommerce-product-variation-rest-api-4526\/","title":{"rendered":"Creating a WooCommerce product variation with the REST API"},"content":{"rendered":"\n

Like adding a product via the REST API is creating a product variation done relatively quickly \u2013 I use the PHP library for that, like in my last week\u2019s post.<\/p>\n\n\n\n\n\n\n\n

Requirements for adding a variation<\/h2>\n\n\n\n

To make adding a variation work, we need to add the wanted attributes to the product first. This can look something like that while adding a product (my post from last week was about that<\/a>):<\/p>\n\n\n

$prod_data = [\n\t'name'<\/span>        => 'A great product'<\/span>,\n\t'type'<\/span>        => 'variable'<\/span>,\n\t'description'<\/span> => 'A very meaningful product description'<\/span>,\n\t'images'<\/span>      => [\n\t\t[\n\t\t\t'src'<\/span>      => 'https:\/\/shop.local\/path\/to\/image.jpg'<\/span>,\n\t\t\t'position'<\/span> => 0<\/span>,\n\t\t],\n\t],\n\t'categories'<\/span>  => [\n\t\t[\n\t\t\t'id'<\/span> => 1<\/span>,\n\t\t],\n\t],\n\t'attributes'<\/span>  => [\n\t\t[\n\t\t\t'id'<\/span>        => 5<\/span>,\n\t\t\t'variation'<\/span> => true<\/span>,\n\t\t\t'visible'<\/span>   => true<\/span>,\n\t\t\t'options'<\/span>   => [ 'S'<\/span>, 'M'<\/span>, 'L'<\/span> ],\n\t\t],\n\t],\n];\n\n$product = $this<\/span>->woocommerce->post( 'products'<\/span>, $prod_data );<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
We set an array of attributes for the attributes<\/code> key (just the size in the example) and can specify if this attributes should be available for variations via variation<\/code>. With options<\/code>, we define the available options for the variations \u2013 those attribute terms must exist before adding the product, like the attribute.<\/p>\n\n\n\n
Besides that, we set the type<\/code> of the product to variable<\/code>.<\/p>\n\n\n\n
Adding a product variation<\/h2>\n\n\n\n
After we meet the requirements, we can create a variation with the following code:<\/p>\n\n\n
$variation_data = [\n\t'regular_price'<\/span> => '15.00'<\/span>,\n\t'image'<\/span>         => [\n\t\t'src'<\/span> => 'https:\/\/shop.local\/path\/to\/image_size_l.jpg'<\/span>,\n\t],\n\t'attributes'<\/span>    => [\n\t\t[\n\t\t\t'id'<\/span>     => 5<\/span>,\n\t\t\t'option'<\/span> => 'L'<\/span>,\n\t\t],\n\t],\n];\n\n$this<\/span>->woocommerce->post( \"products\/$product->id\/variations\"<\/span>, $variation_data );<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
We define the price, set an image and the size. For specifying the size, we pass the id of the attribute and the label of the option as an array inside the array of attributes<\/code>. We use the REST API endpoint products\/$product->id\/variations<\/code> \u2013 we can get the product\u2019s ID via $product->id<\/code> here, because we saved the call of the products<\/code> endpoint for creating the product in the $product<\/code> variable.<\/p>\n\n\n\n
And that is it \u2013 we should have created a variable product with a variation.<\/p>\n","protected":false},"excerpt":{"rendered":"
Like adding a product via the REST API is creating a product variation done relatively quickly \u2013 I use the PHP library for that, like in my last week\u2019s post.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"wpf_show_in_dewp_planet_feed":false,"flobn_post_versions":"","webmentions_disabled_pings":false,"webmentions_disabled":false,"lazy_load_responsive_images_disabled":false,"footnotes":""},"categories":[115],"tags":[],"class_list":["post-4526","post","type-post","status-publish","format-standard","hentry","category-wordpress-snippets"],"wp-worthy-pixel":{"ignored":false,"public":"46ac065aeac94cdbbe3ce85ce12ffa17","server":"vg07.met.vgwort.de","url":"https:\/\/vg07.met.vgwort.de\/na\/46ac065aeac94cdbbe3ce85ce12ffa17"},"wp-worthy-type":"normal","_links":{"self":[{"href":"https:\/\/florianbrinkmann.com\/en\/wp-json\/wp\/v2\/posts\/4526","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/florianbrinkmann.com\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/florianbrinkmann.com\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/florianbrinkmann.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/florianbrinkmann.com\/en\/wp-json\/wp\/v2\/comments?post=4526"}],"version-history":[{"count":4,"href":"https:\/\/florianbrinkmann.com\/en\/wp-json\/wp\/v2\/posts\/4526\/revisions"}],"predecessor-version":[{"id":5972,"href":"https:\/\/florianbrinkmann.com\/en\/wp-json\/wp\/v2\/posts\/4526\/revisions\/5972"}],"wp:attachment":[{"href":"https:\/\/florianbrinkmann.com\/en\/wp-json\/wp\/v2\/media?parent=4526"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/florianbrinkmann.com\/en\/wp-json\/wp\/v2\/categories?post=4526"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/florianbrinkmann.com\/en\/wp-json\/wp\/v2\/tags?post=4526"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}