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

Product - Shipping Classes

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

Product Shipping Class Properties

Attribute	Type	Description
id	integer	Shipping Class ID (term ID) read-only
name	string	Shipping Class name required
slug	string	Shipping Class slug
parent	integer	Shipping Class parent
description	string	Shipping Class description
count	integer	Shows the quantity of products in this shipping class read-only

Create a Product Shipping Class

This API helps you to create a new product shipping class.

HTTP Request

POST

/wc-api/v3/products/shipping_classes

Example of how to create a product shipping class:

curl -X POST https://example.com/wc-api/v3/products/shipping_classes \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "product_shipping_class": {
    "name": "Priority"
  }
}'

var data = {
  product_shipping_class: {
    name: 'Priority'
  }
};

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

<?php
$data = [
    'product_shipping_class' => [
        'name' => 'Priority'
    ]
];

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

data = {
    "product_shipping_class": {
        "name": "Priority"
    }
}

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

data = {
  product_shipping_class: {
    name: "Priority"
  }
}

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

JSON response example:

{
  "product_shipping_class": {
    "id": 35,
    "name": "Priority",
    "slug": "priority",
    "parent": 0,
    "description": "",
    "count": 0
  }
}

Endpoint introduced since WooCommerce 2.5.

View a Product Shipping Class

This API lets you retrieve a product shipping class by ID.

GET

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

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

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

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

print(wcapi.get("products/shipping_classes/35").json())

woocommerce.get("products/shipping_classes/35").parsed_response

JSON response example:

{
  "product_shipping_class": {
    "id": 35,
    "name": "Priority",
    "slug": "priority",
    "parent": 0,
    "description": "",
    "count": 0
  }
}

Endpoint introduced since WooCommerce 2.5.

View List of Product Shipping Classes

This API lets you retrieve all product shipping classes.

GET

/wc-api/v3/products/shipping_classes

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

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

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

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

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

JSON response example:

{
  "product_shipping_classes": [
    {
      "id": 30,
      "name": "Express",
      "slug": "express",
      "parent": 0,
      "description": "",
      "count": 1
    },
    {
      "id": 35,
      "name": "Priority",
      "slug": "priority",
      "parent": 0,
      "description": "",
      "count": 0
    }
  ]
}

Endpoint introduced since WooCommerce 2.5.

Update a Product Shipping Class

This API lets you make changes to a product shipping class.

HTTP Request

PUT

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

curl -X PUT https://example.com/wc-api/v3/products/shipping_classes/35 \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "product_shipping_class": {
    "description": "Priority mail."
  }
}'

var data = {
  product_shipping_class: {
    description: 'Priority mail.'
  }
};

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

<?php
$data = [
    'product_shipping_class' => [
        'description' => 'Priority mail.'
    ]
];

print_r($woocommerce->put('products/shipping_classes/35', $data));
?>

data = {
    "product_shipping_class": {
        "description": "Priority mail."
    }
}

print(wcapi.put("products/shipping_classes/35", data).json())

data = {
  product_shipping_class: {
    description: "Priority mail."
  }
}

woocommerce.put("products/shipping_classes/35", data).parsed_response

JSON response example:

{
  "product_shipping_class": {
    "id": 35,
    "name": "Priority",
    "slug": "priority",
    "parent": 0,
    "description": "Priority mail.",
    "count": 0
  }
}

Endpoint introduced since WooCommerce 2.5.

Delete a Product Shipping Class

This API helps you delete a product shipping class.

HTTP Request

DELETE

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

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

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

<?php print_r($woocommerce->delete('products/shipping_classes/35')); ?>

print(wcapi.delete("products/shipping_classes/35").json())

woocommerce.delete("products/shipping_classes/35").parsed_response

JSON response example:

{
  "message": "Deleted product_shipping_class"
}

Endpoint introduced since WooCommerce 2.5.