woocommerce-rest-api-docs/source/includes/v3/_product-attributes.md

Product - Attributes

This section lists all API endpoints that can be used to create, edit or otherwise manipulate product attributes.

Product Attribute Properties

Attribute	Type	Description
id	integer	Attribute ID read-only
name	string	Attribute name
slug	string	Attribute slug
type	string	Attribute type, the types available include by default are: select and text (some plugins can include new types)
order_by	string	Default sort order. Available: menu_order, name, name_num and id
has_archives	boolean	Enable/Disable attribute archives

Create a Product Attribute

This API helps you to create a new product attribute.

HTTP Request

POST

/wc-api/v3/products/attributes

curl -X POST https://example.com/wc-api/v3/products/attributes \
    -u consumer_key:consumer_secret \
    -H "Content-Type: application/json" \
    -d '{
  "product_attribute": {
    "name": "Color",
    "slug": "pa_color",
    "type": "select",
    "order_by": "menu_order",
    "has_archives": true
  }
}'

var data = {
  product_attribute: {
    name: 'Color',
    slug: 'pa_color',
    type: 'select',
    order_by: 'menu_order',
    has_archives: true
  }
};

WooCommerce.post('products/attributes', data, function(err, data, res) {
  console.log(res);
});

<?php
$data = [
    'product_attribute' => [
        'name' => 'Color',
        'slug' => 'pa_color',
        'type' => 'select',
        'order_by' => 'menu_order',
        'has_archives' => true
    ]
];

print_r($woocommerce->post('products/attributes', $data));
?>

data = {
    "product_attribute": {
        "name": "Color",
        "slug": "pa_color",
        "type": "select",
        "order_by": "menu_order",
        "has_archives": True
    }
}

print(wcapi.post("products/attributes", data).json())

data = {
  product_attribute: {
    name: "Color",
    slug: "pa_color",
    type: "select",
    order_by: "menu_order",
    has_archives: true
  }
}

woocommerce.post("products/attributes", data).parsed_response

JSON response example:

{
  "product_attribute": {
    "id": 1,
    "name": "Color",
    "slug": "pa_color",
    "type": "select",
    "order_by": "menu_order",
    "has_archives": true
  }
}

View a Product Attribute

This API lets you retrieve and view a specific product attribute by ID.

GET

/wc-api/v3/products/attributes/<id>

curl https://example.com/wc-api/v3/products/attributes/1 \
	-u consumer_key:consumer_secret

WooCommerce.get('products/attributes/1', function(err, data, res) {
  console.log(res);
});

<?php print_r($woocommerce->get('products/attributes/1')); ?>

print(wcapi.get("products/attributes/1").json())

woocommerce.get("products/attributes/1").parsed_response

JSON response example:

{
  "product_attribute": {
    "id": 1,
    "name": "Color",
    "slug": "pa_color",
    "type": "select",
    "order_by": "menu_order",
    "has_archives": true
  }
}

View List of Product Attributes

This API helps you to view all the product attributes.

HTTP Request

GET

/wc-api/v3/products/attributes

curl https://example.com/wc-api/v3/products/attributes \
	-u consumer_key:consumer_secret

WooCommerce.get('products/attributes', function(err, data, res) {
  console.log(res);
});

<?php print_r($woocommerce->get('products/attributes')); ?>

print(wcapi.get("products/attributes").json())

woocommerce.get("products/attributes").parsed_response

JSON response example:

{
  "product_attributes": [
    {
      "id": 1,
      "name": "Color",
      "slug": "pa_color",
      "type": "select",
      "order_by": "menu_order",
      "has_archives": true
    },
    {
      "id": 2,
      "name": "Size",
      "slug": "pa_size",
      "type": "select",
      "order_by": "menu_order",
      "has_archives": false
    }
  ]
}

Update a Product Attribute

This API lets you make changes to a product attribute.

HTTP Request

PUT

/wc-api/v3/products/attributes/<id>

curl -X PUT https://example.com/wc-api/v3/products/attributes/1 \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "product_attribute": {
    "order_by": "name"
  }
}'

var data = {
  product_attribute: {
    order_by: 'name'
  }
};

WooCommerce.put('products/attributes/1', data, function(err, data, res) {
  console.log(res);
});

<?php
$data = [
    'product_attribute' => [
        'order_by' => 'name'
    ]
];

print_r($woocommerce->put('products/attributes/1', $data));
?>

data = {
    "product_attribute": {
        "order_by": "name"
    }
}

print(wcapi.put("products/attributes/1", data).json())

data = {
  product_attribute: {
    order_by: "name"
  }
}

woocommerce.put("products/attributes/1", data).parsed_response

JSON response example:

{
  "product_attribute": {
    "id": 1,
    "name": "Color",
    "slug": "pa_color",
    "type": "select",
    "order_by": "name",
    "has_archives": true
  }
}

Delete a Product Attribute

This API helps you delete a product attribute.

HTTP Request

DELETE

/wc-api/v3/products/attributes/<id>

curl -X DELETE https://example.com/wc-api/v3/products/attributes/1 \
	-u consumer_key:consumer_secret

WooCommerce.delete('products/attributes/1', function(err, data, res) {
  console.log(res);
});

<?php print_r($woocommerce->delete('products/attributes/1')); ?>

print(wcapi.delete("products/attributes/1").json())

woocommerce.delete("products/attributes/1").parsed_response

JSON response example:

{
  "message": "Deleted product_attribute"
}