ContextQMD
Back to Woocommerce

Shipping zone methods

docs/apis/rest-api/v3/shipping-zone-methods.mdx

10.9.0-dev36.0 KB
Original Source

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Shipping zone methods

The shipping zone methods API allows you to create, view, update, and delete individual methods of a shipping zone.

Shipping method properties

AttributeTypeDescription
instance_idintegerShipping method instance ID. READ-ONLY
titlestringShipping method customer facing title. READ-ONLY
orderintegerShipping method sort order.
enabledbooleanShipping method enabled status.
method_idstringShipping method ID. READ-ONLY MANDATORY
method_titlestringShipping method title. READ-ONLY
method_descriptionstringShipping method description. READ-ONLY
settingsobjectShipping method settings. See Shipping method - Settings properties

Shipping method - Settings properties

AttributeTypeDescription
idstringA unique identifier for the setting. READ-ONLY
labelstringA human readable label for the setting used in interfaces. READ-ONLY
descriptionstringA human readable description for the setting used in interfaces. READ-ONLY
typestringType of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox. READ-ONLY
valuestringSetting value.
defaultstringDefault value for the setting. READ-ONLY
tipstringAdditional help text shown to the user about the setting. READ-ONLY
placeholderstringPlaceholder text to be displayed in text inputs. READ-ONLY

Include a shipping method to a shipping zone

This API helps you to create a new shipping method to a shipping zone.

http
POST /wp-json/wc/v3/shipping/zones/<id>/methods
<Tabs> <TabItem value="curl" label="cURL">
shell
curl -X POST https://example.com/wp-json/wc/v3/shipping/zones/5/methods \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "method_id": "flat_rate"
}'
</TabItem> <TabItem value="js" label="JavaScript">
javascript
const data = {
	method_id: 'flat_rate',
};

WooCommerce.post( 'shipping/zones/5/methods', data )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );
</TabItem> <TabItem value="php" label="PHP">
php
<?php
$data = [
    'method_id' => 'flat_rate'
];

print_r($woocommerce->post('shipping/zones/5/methods', $data));
?>
</TabItem> <TabItem value="python" label="Python">
python
data = {
    "method_id": "flat_rate"
}

print(wcapi.post("shipping/zones/5/methods", data).json())
</TabItem> <TabItem value="ruby" label="Ruby">
ruby
data = {
  method_id: "flat_rate"
}

woocommerce.post("shipping/zones/5/methods", data).parsed_response
</TabItem> <TabItem value="response" label="JSON Response">
json
{
	"instance_id": 26,
	"title": "Flat rate",
	"order": 1,
	"enabled": true,
	"method_id": "flat_rate",
	"method_title": "Flat rate",
	"method_description": "<p>Lets you charge a fixed rate for shipping.</p>\n",
	"settings": {
		"title": {
			"id": "title",
			"label": "Method title",
			"description": "This controls the title which the user sees during checkout.",
			"type": "text",
			"value": "Flat rate",
			"default": "Flat rate",
			"tip": "This controls the title which the user sees during checkout.",
			"placeholder": ""
		},
		"tax_status": {
			"id": "tax_status",
			"label": "Tax status",
			"description": "",
			"type": "select",
			"value": "taxable",
			"default": "taxable",
			"tip": "",
			"placeholder": "",
			"options": {
				"taxable": "Taxable",
				"none": "None"
			}
		},
		"cost": {
			"id": "cost",
			"label": "Cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "0",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": ""
		},
		"class_costs": {
			"id": "class_costs",
			"label": "Shipping class costs",
			"description": "These costs can optionally be added based on the <a href=\"https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes\">product shipping class</a>.",
			"type": "title",
			"value": "",
			"default": "",
			"tip": "These costs can optionally be added based on the <a href=\"https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes\">product shipping class</a>.",
			"placeholder": ""
		},
		"class_cost_92": {
			"id": "class_cost_92",
			"label": "\"Express\" shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"class_cost_91": {
			"id": "class_cost_91",
			"label": "\"Priority\" shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"no_class_cost": {
			"id": "no_class_cost",
			"label": "No shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"type": {
			"id": "type",
			"label": "Calculation type",
			"description": "",
			"type": "select",
			"value": "class",
			"default": "class",
			"tip": "",
			"placeholder": "",
			"options": {
				"class": "Per class: Charge shipping for each shipping class individually",
				"order": "Per order: Charge shipping for the most expensive shipping class"
			}
		}
	},
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods/26"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods"
			}
		],
		"describes": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5"
			}
		]
	}
}
</TabItem> </Tabs>

Retrieve a shipping method from a shipping zone

This API lets you retrieve and view a specific shipping method from a shipping zone by ID.

http
GET /wp-json/wc/v3/shipping/zones/<zone_id>/methods/<id>
<Tabs> <TabItem value="curl" label="cURL">
shell
curl https://example.com/wp-json/wc/v3/shipping/zones/5/methods/26 \
	-u consumer_key:consumer_secret
</TabItem> <TabItem value="js" label="JavaScript">
javascript
WooCommerce.get( 'shipping/zones/5/methods/26' )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );
</TabItem> <TabItem value="php" label="PHP">
php
<?php print_r($woocommerce->get('shipping/zones/5/methods/26')); ?>
</TabItem> <TabItem value="python" label="Python">
python
print(wcapi.get("shipping/zones/5/methods/26").json())
</TabItem> <TabItem value="ruby" label="Ruby">
ruby
woocommerce.get("shipping/zones/5/methods/26").parsed_response
</TabItem> <TabItem value="response" label="JSON Response">
json
{
	"instance_id": 26,
	"title": "Flat rate",
	"order": 1,
	"enabled": true,
	"method_id": "flat_rate",
	"method_title": "Flat rate",
	"method_description": "<p>Lets you charge a fixed rate for shipping.</p>\n",
	"settings": {
		"title": {
			"id": "title",
			"label": "Method title",
			"description": "This controls the title which the user sees during checkout.",
			"type": "text",
			"value": "Flat rate",
			"default": "Flat rate",
			"tip": "This controls the title which the user sees during checkout.",
			"placeholder": ""
		},
		"tax_status": {
			"id": "tax_status",
			"label": "Tax status",
			"description": "",
			"type": "select",
			"value": "taxable",
			"default": "taxable",
			"tip": "",
			"placeholder": "",
			"options": {
				"taxable": "Taxable",
				"none": "None"
			}
		},
		"cost": {
			"id": "cost",
			"label": "Cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "0",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": ""
		},
		"class_costs": {
			"id": "class_costs",
			"label": "Shipping class costs",
			"description": "These costs can optionally be added based on the <a href=\"https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes\">product shipping class</a>.",
			"type": "title",
			"value": "",
			"default": "",
			"tip": "These costs can optionally be added based on the <a href=\"https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes\">product shipping class</a>.",
			"placeholder": ""
		},
		"class_cost_92": {
			"id": "class_cost_92",
			"label": "\"Express\" shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"class_cost_91": {
			"id": "class_cost_91",
			"label": "\"Priority\" shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"no_class_cost": {
			"id": "no_class_cost",
			"label": "No shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"type": {
			"id": "type",
			"label": "Calculation type",
			"description": "",
			"type": "select",
			"value": "class",
			"default": "class",
			"tip": "",
			"placeholder": "",
			"options": {
				"class": "Per class: Charge shipping for each shipping class individually",
				"order": "Per order: Charge shipping for the most expensive shipping class"
			}
		}
	},
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods/26"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods"
			}
		],
		"describes": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5"
			}
		]
	}
}
</TabItem> </Tabs>

List all shipping methods from a shipping zone

This API helps you to view all the shipping methods from a shipping zone.

http
GET /wp-json/wc/v3/shipping/zones/<id>/methods
<Tabs> <TabItem value="curl" label="cURL">
shell
curl https://example.com/wp-json/wc/v3/shipping/zones/5/methods \
	-u consumer_key:consumer_secret
</TabItem> <TabItem value="js" label="JavaScript">
javascript
WooCommerce.get( 'shipping/zones/5/methods' )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );
</TabItem> <TabItem value="php" label="PHP">
php
<?php print_r($woocommerce->get('shipping/zones/5/methods')); ?>
</TabItem> <TabItem value="python" label="Python">
python
print(wcapi.get("shipping/zones/5/methods").json())
</TabItem> <TabItem value="ruby" label="Ruby">
ruby
woocommerce.get("shipping/zones/5/methods").parsed_response
</TabItem> <TabItem value="response" label="JSON Response">
json
[
	{
		"instance_id": 26,
		"title": "Flat rate",
		"order": 1,
		"enabled": true,
		"method_id": "flat_rate",
		"method_title": "Flat rate",
		"method_description": "<p>Lets you charge a fixed rate for shipping.</p>\n",
		"settings": {
			"title": {
				"id": "title",
				"label": "Method title",
				"description": "This controls the title which the user sees during checkout.",
				"type": "text",
				"value": "Flat rate",
				"default": "Flat rate",
				"tip": "This controls the title which the user sees during checkout.",
				"placeholder": ""
			},
			"tax_status": {
				"id": "tax_status",
				"label": "Tax status",
				"description": "",
				"type": "select",
				"value": "taxable",
				"default": "taxable",
				"tip": "",
				"placeholder": "",
				"options": {
					"taxable": "Taxable",
					"none": "None"
				}
			},
			"cost": {
				"id": "cost",
				"label": "Cost",
				"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
				"type": "text",
				"value": "0",
				"default": "",
				"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
				"placeholder": ""
			},
			"class_costs": {
				"id": "class_costs",
				"label": "Shipping class costs",
				"description": "These costs can optionally be added based on the <a href=\"https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes\">product shipping class</a>.",
				"type": "title",
				"value": "",
				"default": "",
				"tip": "These costs can optionally be added based on the <a href=\"https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes\">product shipping class</a>.",
				"placeholder": ""
			},
			"class_cost_92": {
				"id": "class_cost_92",
				"label": "\"Express\" shipping class cost",
				"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
				"type": "text",
				"value": "",
				"default": "",
				"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
				"placeholder": "N/A"
			},
			"class_cost_91": {
				"id": "class_cost_91",
				"label": "\"Priority\" shipping class cost",
				"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
				"type": "text",
				"value": "",
				"default": "",
				"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
				"placeholder": "N/A"
			},
			"no_class_cost": {
				"id": "no_class_cost",
				"label": "No shipping class cost",
				"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
				"type": "text",
				"value": "",
				"default": "",
				"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
				"placeholder": "N/A"
			},
			"type": {
				"id": "type",
				"label": "Calculation type",
				"description": "",
				"type": "select",
				"value": "class",
				"default": "class",
				"tip": "",
				"placeholder": "",
				"options": {
					"class": "Per class: Charge shipping for each shipping class individually",
					"order": "Per order: Charge shipping for the most expensive shipping class"
				}
			}
		},
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods/26"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods"
				}
			],
			"describes": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones/5"
				}
			]
		}
	},
	{
		"instance_id": 27,
		"title": "Free shipping",
		"order": 2,
		"enabled": true,
		"method_id": "free_shipping",
		"method_title": "Free shipping",
		"method_description": "<p>Free shipping is a special method which can be triggered with coupons and minimum spends.</p>\n",
		"settings": {
			"title": {
				"id": "title",
				"label": "Title",
				"description": "This controls the title which the user sees during checkout.",
				"type": "text",
				"value": "Free shipping",
				"default": "Free shipping",
				"tip": "This controls the title which the user sees during checkout.",
				"placeholder": ""
			},
			"requires": {
				"id": "requires",
				"label": "Free shipping requires...",
				"description": "",
				"type": "select",
				"value": "",
				"default": "",
				"tip": "",
				"placeholder": "",
				"options": {
					"": "N/A",
					"coupon": "A valid free shipping coupon",
					"min_amount": "A minimum order amount",
					"either": "A minimum order amount OR a coupon",
					"both": "A minimum order amount AND a coupon"
				}
			},
			"min_amount": {
				"id": "min_amount",
				"label": "Minimum order amount",
				"description": "Users will need to spend this amount to get free shipping (if enabled above).",
				"type": "price",
				"value": "0",
				"default": "",
				"tip": "Users will need to spend this amount to get free shipping (if enabled above).",
				"placeholder": ""
			}
		},
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods/27"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods"
				}
			],
			"describes": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones/5"
				}
			]
		}
	}
]
</TabItem> </Tabs>

Update a shipping method of a shipping zone

This API lets you make changes to a shipping method of a shipping zone.

http
PUT /wp-json/wc/v3/shipping/zones/<zone_id>/methods/<id>
<Tabs> <TabItem value="curl" label="cURL">
shell
curl -X PUT https://example.com/wp-json/wc/v3/shipping/zones/5/methods/26 \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "settings": {
    "cost": "20.00"
  }
}'
</TabItem> <TabItem value="js" label="JavaScript">
javascript
const data = {
	settings: {
		cost: '20.00',
	},
};

WooCommerce.put( 'shipping/zones/5/methods/26', data )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );
</TabItem> <TabItem value="php" label="PHP">
php
<?php
$data = [
    'settings' => [
        'cost' => '20.00'
    ]
];

print_r($woocommerce->put('shipping/zones/5/methods/26', $data));
?>
</TabItem> <TabItem value="python" label="Python">
python
data = {
    "settings": {
        "cost": "20.00"
    }
}

print(wcapi.put("shipping/zones/5/methods/26", data).json())
</TabItem> <TabItem value="ruby" label="Ruby">
ruby
data = {
  settings: {
    "cost": "20.00"
  }
}

woocommerce.put("shipping/zones/5/methods/26", data).parsed_response
</TabItem> <TabItem value="response" label="JSON Response">
json
{
	"instance_id": 26,
	"title": "Flat rate",
	"order": 1,
	"enabled": true,
	"method_id": "flat_rate",
	"method_title": "Flat rate",
	"method_description": "<p>Lets you charge a fixed rate for shipping.</p>\n",
	"settings": {
		"title": {
			"id": "title",
			"label": "Method title",
			"description": "This controls the title which the user sees during checkout.",
			"type": "text",
			"value": "Flat rate",
			"default": "Flat rate",
			"tip": "This controls the title which the user sees during checkout.",
			"placeholder": ""
		},
		"tax_status": {
			"id": "tax_status",
			"label": "Tax status",
			"description": "",
			"type": "select",
			"value": "taxable",
			"default": "taxable",
			"tip": "",
			"placeholder": "",
			"options": {
				"taxable": "Taxable",
				"none": "None"
			}
		},
		"cost": {
			"id": "cost",
			"label": "Cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "20.00",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": ""
		},
		"class_costs": {
			"id": "class_costs",
			"label": "Shipping class costs",
			"description": "These costs can optionally be added based on the <a href=\"https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes\">product shipping class</a>.",
			"type": "title",
			"value": "",
			"default": "",
			"tip": "These costs can optionally be added based on the <a href=\"https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes\">product shipping class</a>.",
			"placeholder": ""
		},
		"class_cost_92": {
			"id": "class_cost_92",
			"label": "\"Express\" shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"class_cost_91": {
			"id": "class_cost_91",
			"label": "\"Priority\" shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"no_class_cost": {
			"id": "no_class_cost",
			"label": "No shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"type": {
			"id": "type",
			"label": "Calculation type",
			"description": "",
			"type": "select",
			"value": "class",
			"default": "class",
			"tip": "",
			"placeholder": "",
			"options": {
				"class": "Per class: Charge shipping for each shipping class individually",
				"order": "Per order: Charge shipping for the most expensive shipping class"
			}
		}
	},
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods/26"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods"
			}
		],
		"describes": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5"
			}
		]
	}
}
</TabItem> </Tabs>

Delete a shipping method from a shipping zone

This API helps you delete a shipping method from a shipping zone.

http
DELETE /wp-json/wc/v3/shipping/zones/<zone_id>/methods/<id>
<Tabs> <TabItem value="curl" label="cURL">
shell
curl -X DELETE https://example.com/wp-json/wc/v3/shipping/zones/5/methods/26?force=true \
	-u consumer_key:consumer_secret
</TabItem> <TabItem value="js" label="JavaScript">
javascript
WooCommerce.delete( 'shipping/zones/5/methods/26', {
	force: true,
} )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );
</TabItem> <TabItem value="php" label="PHP">
php
<?php print_r($woocommerce->delete('shipping/zones/5/methods/26', ['force' => true])); ?>
</TabItem> <TabItem value="python" label="Python">
python
print(wcapi.delete("shipping/zones/5/methods/26", params={"force": True}).json())
</TabItem> <TabItem value="ruby" label="Ruby">
ruby
woocommerce.delete("shipping/zones/5/methods/26", force: true).parsed_response
</TabItem> <TabItem value="response" label="JSON Response">
json
{
	"instance_id": 26,
	"title": "Flat rate",
	"order": 1,
	"enabled": true,
	"method_id": "flat_rate",
	"method_title": "Flat rate",
	"method_description": "<p>Lets you charge a fixed rate for shipping.</p>\n",
	"settings": {
		"title": {
			"id": "title",
			"label": "Method title",
			"description": "This controls the title which the user sees during checkout.",
			"type": "text",
			"value": "Flat rate",
			"default": "Flat rate",
			"tip": "This controls the title which the user sees during checkout.",
			"placeholder": ""
		},
		"tax_status": {
			"id": "tax_status",
			"label": "Tax status",
			"description": "",
			"type": "select",
			"value": "taxable",
			"default": "taxable",
			"tip": "",
			"placeholder": "",
			"options": {
				"taxable": "Taxable",
				"none": "None"
			}
		},
		"cost": {
			"id": "cost",
			"label": "Cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "20.00",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": ""
		},
		"class_costs": {
			"id": "class_costs",
			"label": "Shipping class costs",
			"description": "These costs can optionally be added based on the <a href=\"https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes\">product shipping class</a>.",
			"type": "title",
			"value": "",
			"default": "",
			"tip": "These costs can optionally be added based on the <a href=\"https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes\">product shipping class</a>.",
			"placeholder": ""
		},
		"class_cost_92": {
			"id": "class_cost_92",
			"label": "\"Express\" shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"class_cost_91": {
			"id": "class_cost_91",
			"label": "\"Priority\" shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"no_class_cost": {
			"id": "no_class_cost",
			"label": "No shipping class cost",
			"description": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"type": "text",
			"value": "",
			"default": "",
			"tip": "Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.

Use <code>[qty]</code> for the number of items, 
<code>[cost]</code> for the total cost of items, and <code>[fee percent=\"10\" min_fee=\"20\" max_fee=\"\"]</code> for percentage based fees.",
			"placeholder": "N/A"
		},
		"type": {
			"id": "type",
			"label": "Calculation type",
			"description": "",
			"type": "select",
			"value": "class",
			"default": "class",
			"tip": "",
			"placeholder": "",
			"options": {
				"class": "Per class: Charge shipping for each shipping class individually",
				"order": "Per order: Charge shipping for the most expensive shipping class"
			}
		}
	},
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods/26"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/methods"
			}
		],
		"describes": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5"
			}
		]
	}
}
</TabItem> </Tabs>

Available parameters

ParameterTypeDescription
forcestringRequired to be true, as resource does not support trashing.