Shipping zones

The shipping zones API allows you to create, view, update, and delete individual shipping zones.

Shipping zone properties

Attribute	Type	Description
id	integer	Unique identifier for the resource. READ-ONLY
name	string	Shipping zone name. MANDATORY
order	integer	Shipping zone order.

Create a shipping zone

This API helps you to create a new shipping zone.

POST /wp-json/wc/v3/shipping/zones

cURL

curl -X POST https://example.com/wp-json/wc/v3/shipping/zones \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "name": "Brazil"
}'

JavaScript

const data = {
	name: 'Brazil',
};

WooCommerce.post( 'shipping/zones', data )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );

PHP

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

print_r($woocommerce->post('shipping/zones', $data));
?>

Python

data = {
    "name": "Brazil"
}

print(wcapi.post("shipping/zones", data).json())

Ruby

data = {
  name: "Brazil"
}

woocommerce.post("shipping/zones", data).parsed_response

JSON Response

{
	"id": 5,
	"name": "Brazil",
	"order": 0,
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones"
			}
		],
		"describedby": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/locations"
			}
		]
	}
}

Retrieve a shipping zone

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

GET /wp-json/wc/v3/shipping/zones/<id>

cURL

curl https://example.com/wp-json/wc/v3/shipping/zones/5 \
	-u consumer_key:consumer_secret

JavaScript

WooCommerce.get( 'shipping/zones/5' )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );

PHP

<?php print_r($woocommerce->get('shipping/zones/5')); ?>

Python

print(wcapi.get("shipping/zones/5").json())

Ruby

woocommerce.get("shipping/zones/5").parsed_response

JSON Response

{
	"id": 5,
	"name": "Brazil",
	"order": 0,
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones"
			}
		],
		"describedby": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/locations"
			}
		]
	}
}

List all shipping zones

This API helps you to view all the shipping zones.

GET /wp-json/wc/v3/shipping/zones

cURL

curl https://example.com/wp-json/wc/v3/shipping/zones \
	-u consumer_key:consumer_secret

JavaScript

WooCommerce.get( 'shipping/zones' )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );

PHP

<?php print_r($woocommerce->get('shipping/zones')); ?>

Python

print(wcapi.get("shipping/zones").json())

Ruby

woocommerce.get("shipping/zones").parsed_response

JSON Response

[
	{
		"id": 0,
		"name": "Rest of the World",
		"order": 0,
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones/0"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones"
				}
			],
			"describedby": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones/0/locations"
				}
			]
		}
	},
	{
		"id": 5,
		"name": "Brazil",
		"order": 0,
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones/5"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones"
				}
			],
			"describedby": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/locations"
				}
			]
		}
	}
]

Update a shipping zone

This API lets you make changes to a shipping zone.

PUT /wp-json/wc/v3/shipping/zones/<id>

cURL

curl -X PUT https://example.com/wp-json/wc/v3/shipping/zones/5 \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "order": 1
}'

JavaScript

const data = {
	order: 1,
};

WooCommerce.put( 'shipping/zones/5', data )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );

PHP

<?php
$data = [
    'order' => 1
];

print_r($woocommerce->put('shipping/zones/5', $data));
?>

Python

data = {
    "order": 1
}

print(wcapi.put("shipping/zones/5", data).json())

Ruby

data = {
  order: 1
}

woocommerce.put("shipping/zones/5", data).parsed_response

JSON Response

{
	"id": 5,
	"name": "Brazil",
	"order": 1,
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones"
			}
		],
		"describedby": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/locations"
			}
		]
	}
}

Delete a shipping zone

This API helps you delete a shipping zone.

DELETE /wp-json/wc/v3/shipping/zones/<id>

cURL

curl -X DELETE https://example.com/wp-json/wc/v3/shipping/zones/5?force=true \
	-u consumer_key:consumer_secret

JavaScript

WooCommerce.delete( 'shipping/zones/5', {
	force: true,
} )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );

PHP

<?php print_r($woocommerce->delete('shipping/zones/5', ['force' => true])); ?>

Python

print(wcapi.delete("shipping/zones/5", params={"force": True}).json())

Ruby

woocommerce.delete("shipping/zones/5", force: true).parsed_response

JSON Response

{
	"id": 5,
	"name": "Brazil",
	"order": 1,
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones"
			}
		],
		"describedby": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping/zones/5/locations"
			}
		]
	}
}

Available parameters

Parameter	Type	Description
force	string	Required to be true, as resource does not support trashing.