Shipping methods

The shipping methods API allows you to view individual shipping methods.

Shipping method properties

Attribute	Type	Description
id	string	Method ID. READ-ONLY
title	string	Shipping method title. READ-ONLY
description	string	Shipping method description. READ-ONLY

Retrieve a shipping method

This API lets you retrieve and view a specific shipping method.

GET /wp-json/wc/v3/shipping_methods/<id>

cURL

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

JavaScript

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

PHP

<?php print_r($woocommerce->get('shipping_methods/flat_rate')); ?>

Python

print(wcapi.get("shipping_methods/flat_rate").json())

Ruby

woocommerce.get("shipping_methods/flat_rate").parsed_response

JSON Response

{
	"id": "flat_rate",
	"title": "Flat rate",
	"description": "Lets you charge a fixed rate for shipping.",
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping_methods/flat_rate"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/shipping_methods"
			}
		]
	}
}

List all shipping methods

This API helps you to view all the shipping methods.

GET /wp-json/wc/v3/shipping_methods

cURL

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

JavaScript

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

PHP

<?php print_r($woocommerce->get('shipping_methods')); ?>

Python

print(wcapi.get("shipping_methods").json())

Ruby

woocommerce.get("shipping_methods").parsed_response

JSON Response

[
	{
		"id": "flat_rate",
		"title": "Flat rate",
		"description": "Lets you charge a fixed rate for shipping.",
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping_methods/flat_rate"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping_methods"
				}
			]
		}
	},
	{
		"id": "free_shipping",
		"title": "Free shipping",
		"description": "Free shipping is a special method which can be triggered with coupons and minimum spends.",
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping_methods/free_shipping"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping_methods"
				}
			]
		}
	},
	{
		"id": "local_pickup",
		"title": "Local pickup",
		"description": "Allow customers to pick up orders themselves. By default, when using local pickup store base taxes will apply regardless of customer address.",
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping_methods/local_pickup"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/shipping_methods"
				}
			]
		}
	}
]