将当前页面内容以 Markdown 格式复制到剪贴板

产品配送类型

产品配送类型 API 允许您创建、查看、更新和删除单个或批量配送类型。

产品配送类型属性

属性	类型	描述
`id`	integer	该资源的唯一标识符。`只读`
`name`	string	配送类型名称。`必填`
`slug`	string	用于该资源类型的字母数字标识符。
`description`	string	该资源的 HTML 描述。
`count`	integer	该资源已发布的产品的数量。`只读`

创建一个配送类型

此 API 可帮助您创建新的产品配送类型。

POST /wp-json/wc/v3/products/shipping_classes

创建产品配送类型的例子：

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

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

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

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

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

data = {
    "name": "Priority"
}

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

data = {
  name: "Priority"
}

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

{
	"id": 32,
	"name": "Priority",
	"slug": "priority",
	"description": "",
	"count": 0,
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/products/shipping_classes/32"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/products/shipping_classes"
			}
		]
	}
}

获取配送类型

此 API 允许您通过编号获取产品的配送类型。

GET /wp-json/wc/v3/products/shipping_classes/<id>

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

WooCommerce.get( 'products/shipping_classes/32' )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );

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

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

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

{
	"id": 32,
	"name": "Priority",
	"slug": "priority",
	"description": "",
	"count": 0,
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/products/shipping_classes/32"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/products/shipping_classes"
			}
		]
	}
}

列出所有配送类型

此 API 允许您检索所有产品的配送类型。

GET /wp-json/wc/v3/products/shipping_classes

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

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

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

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

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

[
	{
		"id": 33,
		"name": "Express",
		"slug": "express",
		"description": "",
		"count": 0,
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/products/shipping_classes/33"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/products/shipping_classes"
				}
			]
		}
	},
	{
		"id": 32,
		"name": "Priority",
		"slug": "priority",
		"description": "",
		"count": 0,
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/products/shipping_classes/32"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/products/shipping_classes"
				}
			]
		}
	}
]

Available parameters

Parameter	Type	Description
`context`	string	Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`.
`page`	integer	Current page of the collection. Default is `1`.
`per_page`	integer	Maximum number of items to be returned in result set. Default is `10`.
`search`	string	Limit results to those matching a string.
`exclude`	array	Ensure result set excludes specific ids.
`include`	array	Limit result set to specific ids.
`offset`	integer	Offset the result set by a specific number of items.
`order`	string	Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `asc`.
`orderby`	string	Sort collection by resource attribute. Options: `id`, `include`, `name`, `slug`, `term_group`, `description` and `count`. Default is `name`.
`hide_empty`	boolean	Whether to hide resources not assigned to any products. Default is `false`.
`product`	integer	Limit result set to resources assigned to a specific product.
`slug`	string	Limit result set to resources with a specific slug.

Update a shipping class

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

PUT /wp-json/wc/v3/products/shipping_classes/<id>

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

const data = {
	description: 'Priority mail.',
};

WooCommerce.put( 'products/shipping_classes/32', data )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );

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

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

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

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

data = {
  description: "Priority mail."
}

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

{
	"id": 32,
	"name": "Priority",
	"slug": "priority",
	"description": "Priority mail.",
	"count": 0,
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/products/shipping_classes/32"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/products/shipping_classes"
			}
		]
	}
}

删除一个配送类型

这个 API 可以帮助您删除产品的配送类型。

DELETE /wp-json/wc/v3/products/shipping_classes/<id>

curl -X DELETE https://example.com/wp-json/wc/v3/products/shipping_classes/32?force=true \
	-u consumer_key:consumer_secret

WooCommerce.delete( 'products/shipping_classes/32', {
	force: true,
} )
	.then( ( response ) => {
		console.log( response.data );
	} )
	.catch( ( error ) => {
		console.log( error.response.data );
	} );

<?php print_r($woocommerce->delete('products/shipping_classes/32', ['force' => true])); ?>

print(wcapi.delete("products/shipping_classes/32", params={"force": True}).json())

woocommerce.delete("products/shipping_classes/32", force: true).parsed_response

{
	"id": 32,
	"name": "Priority",
	"slug": "priority",
	"description": "Priority mail.",
	"count": 0,
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/products/shipping_classes/32"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/products/shipping_classes"
			}
		]
	}
}

可用参数

参数	类型	描述
`force`	字符串	必须为 `true`，因为资源不支持放入回收站。

批量更新配送类型

此 API 可以帮助您批量创建、更新和删除多个产品的配送类型。

备注

注意：默认情况下，限制为最多可以创建、更新或删除 100 个对象。

POST /wp-json/wc/v3/products/shipping_classes/batch

curl -X POST https://example.com/wp-json/wc/v3/products/shipping_classes/batch \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "create": [
    {
      "name": "Small items"
    },
    {
      "name": "Large items"
    }
  ],
  "update": [
    {
      "id": 33,
      "description": "Express shipping"
    }
  ],
  "delete": [
    32
  ]
}'

const data = {
	create: [
		{
			name: 'Small items',
		},
		{
			name: 'Large items',
		},
	],
	update: [
		{
			id: 33,
			description: 'Express shipping',
		},
	],
	delete: [ 32 ],
};

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

<?php
$data = [
    'create' => [
        [
            'name' => 'Small items'
        ],
        [
            'name' => 'Large items'
        ]
    ],
    'update' => [
        [
            'id' => 33,
            'description' => 'Express shipping'
        ]
    ],
    'delete' => [
        32
    ]
];

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

data = {
    "create": [
        {
            "name": "Small items"
        },
        {
            "name": "Large items"
        }
    ],
    "update": [
        {
            "id": 33,
            "description": "Express shipping"
        }
    ],
    "delete": [
        32
    ]
}

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

data = {
  create: [
    {
      name: "Small items"
    },
    {
      name: "Large items"
    }
  ],
  update: [
    {
      id: 33,
      description: "Express shipping"
    }
  ],
  delete: [
    32
  ]
}

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

{
	"create": [
		{
			"id": 34,
			"name": "Small items",
			"slug": "small-items",
			"description": "",
			"count": 0,
			"_links": {
				"self": [
					{
						"href": "https://example.com/wp-json/wc/v3/products/shipping_classes/34"
					}
				],
				"collection": [
					{
						"href": "https://example.com/wp-json/wc/v3/products/shipping_classes"
					}
				]
			}
		},
		{
			"id": 35,
			"name": "Large items",
			"slug": "large-items",
			"description": "",
			"count": 0,
			"_links": {
				"self": [
					{
						"href": "https://example.com/wp-json/wc/v3/products/shipping_classes/35"
					}
				],
				"collection": [
					{
						"href": "https://example.com/wp-json/wc/v3/products/shipping_classes"
					}
				]
			}
		}
	],
	"update": [
		{
			"id": 33,
			"name": "Express",
			"slug": "express",
			"description": "Express shipping",
			"count": 0,
			"_links": {
				"self": [
					{
						"href": "https://example.com/wp-json/wc/v3/products/shipping_classes/33"
					}
				],
				"collection": [
					{
						"href": "https://example.com/wp-json/wc/v3/products/shipping_classes"
					}
				]
			}
		}
	],
	"delete": [
		{
			"id": 32,
			"name": "Priority",
			"slug": "priority",
			"description": "",
			"count": 0,
			"_links": {
				"self": [
					{
						"href": "https://example.com/wp-json/wc/v3/products/shipping_classes/32"
					}
				],
				"collection": [
					{
						"href": "https://example.com/wp-json/wc/v3/products/shipping_classes"
					}
				]
			}
		}
	]
}

产品配送类型属性​

创建一个配送类型​

获取配送类型​

列出所有配送类型​

Available parameters​

Update a shipping class​

删除一个配送类型​

可用参数​

批量更新配送类型​