WooCommerce CLI 命令
概述
本文档是 WooCommerce 命令行界面 (WC-CLI) 命令的综合参考。它包含每个命令的语法、选项和简要描述。这些命令适用于 WooCommerce 版本 3.0.0 及更高版本。
通用命令结构
WC-CLI 命令的通用语法如下:
wp wc [命令] [选项]
要获取任何特定命令的详细帮助,请使用:
wp wc [命令] --help
命令
wc blueprint
wc blueprint import [结构化数据路径]
--show-messages- 显示调试信息。支持的日志级别:all, error, info, debug。
wc blueprint export [保存到文件名]
--steps- 要导出的步骤名称。
wc com
wc com extension list
--format- 以特定格式渲染输出。
默认:table
选项:table, csv, json, yaml
--fields- 限制输出到特定的对象字段。
默认:all
选项:product_slug, product_name, auto_renew, expires_on, expired, sites_max, sites_active, maxed
wc com extension install [扩展]
--extension- 从可用扩展中安装一个插件。接受插件别名。--force- 如果设置,该命令将覆盖已安装的任何扩展版本,而无需提示确认。--activate- 如果设置,安装后,该命令将激活插件。--activate-network- 如果设置,插件将在安装后立即进行网络激活。--insecure- 如果 TLS 握手失败,则重试下载,无需证书验证。注意:这会使请求容易受到 MITM 攻击。
wc customer
wc customer list
--context- 请求的范围;确定响应中包含的字段。--page- 集合的当前页。--per_page- 返回结果集中最多显示的项数。默认为 100 项。--search- 限制结果,仅包含匹配的字符串。--exclude- 确保结果集排除特定的 ID。--include- 限制结果集为特定的 ID。--offset- 通过特定数量的项来偏移结果集。--order- 按照升序或降序对排序属性进行排序。--orderby- 按照对象属性对集合进行排序。--email- 限制结果集为具有特定电子邮件地址的资源。--role- 限制结果集为具有特定角色的资源。--fields- 限制响应为特定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc customer create
--email- 新用户的 Email 地址。(必需)--first_name- 客户的 名。--last_name- 客户的 姓氏。--username- 新用户的 用户名。--password- 新用户的 密码。(必需)--billing- 账单地址 数据列表。--shipping- 配送 地址 数据列表。--meta_data- 元数据。--porcelain- 当操作成功时,仅输出 ID。
wc customer get [id]
--id- 资源的唯一标识符。--context- 发送请求的范围;决定响应中包含的字段。--fields- 限制响应的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc customer update [id]
--id- 资源的唯一标识符。--email- 客户的 Email 地址。--first_name- 客户的 名。--last_name- 客户的 姓氏。--username- 客户的 登录名。--password- 客户的 密码。--billing- 账单地址 数据列表。--shipping- 配送 地址 数据列表。--meta_data- 元数据。--porcelain- 当操作成功时,仅输出 ID。
wc customer delete [id]
--id- 资源的唯一标识符。--force- 必须设置为 true,因为资源不支持放入回收站。--reassign- 用于重新分配帖子的 ID。--porcelain- 当操作成功时,仅输出 ID。
wc customer_download
wc customer_download list <customer_id>
--customer_id- 资源的唯一标识符。--context- 发送请求的范围;决定响应中包含的字段。--fields- 限制响应的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc order_note
wc order_note list <order_id>
--order_id- 订单 ID。--context- 发送请求的范围;决定响应中包含的字段。--type- 限制结果为客户或内部备注。--fields- 限制响应的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc order_note create <order_id>
--order_id- 订单 ID。--note- 订单备注内容。(必需)--customer_note- 如果为 true,则备注将显示给客户,并且他们将收到通知。如果为 false,则备注仅供管理员参考。--porcelain- 当操作成功时,仅输出 ID。
wc order_note get <order_id> [id]
--id- 资源的唯一标识符。--order_id- 订单 ID。--context- 发送请求的范围;决定响应中包含的字段。--fields- 限制响应仅包含指定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc order_note delete <order_id> [id]
--id- 资源的唯一标识符。--order_id- 订单 ID。--force- 必须设置为 true,因为该资源不支持放入回收站。--porcelain- 操作成功时,仅输出 ID。
wc payment_gateway
wc payment_gateway list
--context- 发送请求的范围;决定响应中包含的字段。--fields- 限制响应仅包含指定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc payment_gateway get [id]
--id- 资源的唯一标识符。--context- 发送请求的范围;决定响应中包含的字段。--fields- 限制响应仅包含指定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc payment_gateway update [id]
--id- 资源的唯一标识符。--title- 在结账页面上显示的支付网关标题。--description- 在结账页面上显示的支付网关描述。--order- 支付网关的排序顺序。--enabled- 支付网关的启用状态。--settings- 支付网关的设置。--porcelain- 操作成功时,仅输出 ID。
wc product
wc product list
--context- 请求的作用域;决定响应中包含的字段。--page- 集合的当前页。--per_page- 结果集中返回的最大项目数。默认为 100 个项目。--search- 将结果限制为与某个字符串匹配的项目。--after- 将响应限制为在给定符合 ISO8601 标准的日期之后发布的资源。--before- 将响应限制为在给定符合 ISO8601 标准的日期之前发布的资源。--exclude- 确保结果集排除特定的 ID。--include- 将结果集限制为特定的 ID。--offset- 通过指定数量的项目来偏移结果集。--order- 按照升序或降序对排序属性进行排序。--orderby- 按照对象的属性对集合进行排序。--parent- 将结果集限制为特定父级 ID 的项目。--parent_exclude- 将结果集限制为所有项目,但排除特定父级 ID 的项目。--slug- 将结果集限制为具有特定别名的产品。--status- 将结果集限制为具有特定状态的产品。--type- 将结果集限制为具有特定类型的产品。--sku- 将结果集限制为具有特定 SKU 的产品。--featured- 将结果集限制为精选产品。--category- 将结果集限制为具有特定分类 ID 的产品。--tag- 将结果集限制为具有特定标签 ID 的产品。--shipping_class- 将结果集限制为具有特定配送类型 ID 的产品。--attribute- 将结果集限制为具有特定属性的产品。--attribute_term- 将结果集限制为具有特定属性项 ID 的产品(需要已分配的属性)。--tax_class- 将结果集限制为具有特定税类的产品。--in_stock- 将结果集限制为库存中的产品或缺货的产品。--on_sale- 将结果集限制为正在促销的产品。--min_price- 根据最小价格限制结果集。--max_price- 根据最大价格限制结果集。--fields- 将响应限制为特定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product create
--name- 产品名称。--slug- 产品别名。--type- 产品类型。--status- 产品状态(帖子状态)。--featured- 是否为推荐产品。--catalog_visibility- 目录可见性。--description- 产品描述。--short_description- 产品简短描述。--sku- 唯一标识符。--regular_price- 产品常规价格。--sale_price- 产品促销价格。--date_on_sale_from- 促销价格的起始日期,使用站点时区。--date_on_sale_from_gmt- 促销价格的起始日期,使用 GMT 时区。--date_on_sale_to- 促销价格的结束日期,使用站点时区。--date_on_sale_to_gmt- 促销价格的结束日期,使用站点时区。--virtual- 如果产品是虚拟产品。--downloadable- 如果产品可以下载。--downloads- 可下载文件的列表。--download_limit- 购买后,可下载文件可以下载的次数。--download_expiry- 可下载文件过期前的天数。--external_url- 产品的外部 URL。仅适用于外部产品。--button_text- 产品的外部按钮文本。仅适用于外部产品。--tax_status- 税收状态。--tax_class- 税类。--manage_stock- 产品级别的库存管理。--stock_quantity- 库存数量。--in_stock- 控制产品在前台显示为“有库存”或“缺货”。--backorders- 如果管理库存,则控制是否允许延期交货。--sold_individually- 允许在单个订单中购买一件商品。--weight- 产品重量(磅)。--dimensions- 产品尺寸。--shipping_class- 配送类型别名。--reviews_allowed- 允许评论。--upsell_ids- 追加销售产品的 ID 列表。--cross_sell_ids- 交叉销售产品的 ID 列表。--parent_id- 产品父级 ID。--purchase_note- 购买后发送给客户的可选备注。--categories- 分类的列表。--tags- 标签的列表。--images- 图像的列表。--attributes- 属性的列表。--default_attributes- 默认变体属性。--menu_order- 菜单排序,用于自定义产品排序。--meta_data- 元数据。--porcelain- 操作成功时,仅输出 ID。
wc product get [id]
--id- 资源的唯一标识符。--context- 发起请求的作用域;确定响应中包含的字段。--fields- 限制响应为特定字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product update [id]
--id- 资源的唯一标识符。--name- 产品名称。--slug- 产品别名。--type- 产品类型。--status- 产品状态(帖子状态)。--featured- 推荐产品。--catalog_visibility- 目录可见性。--description- 产品描述。--short_description- 产品简短描述。--sku- 唯一标识符。--regular_price- 产品常规价格。--sale_price- 产品促销价格。--date_on_sale_from- 促销价格的起始日期,使用站点时区。--date_on_sale_from_gmt- 促销价格的起始日期,使用 GMT 时区。--date_on_sale_to- 促销价格的结束日期,使用站点时区。--date_on_sale_to_gmt- 促销价格的结束日期,使用站点时区。--virtual- 如果产品是虚拟产品。--downloadable- 如果产品可以下载。--downloads- 可下载文件的列表。--download_limit- 购买后,可下载文件可以下载的次数。--download_expiry- 可下载文件到期前的天数。--external_url- 产品的外部 URL。仅适用于外部产品。--button_text- 产品的外部按钮文本。仅适用于外部产品。--tax_status- 税收状态。--tax_class- 税类。--manage_stock- 产品级别的库存管理。--stock_quantity- 库存数量。--in_stock- 控制产品在前台显示为“有库存”或“缺货”。--backorders- 如果管理库存,则控制是否允许延期交货。--sold_individually- 允许在单个订单中购买一件商品。--weight- 产品重量(磅)。--dimensions- 产品尺寸。--shipping_class- 配送类型别名。--reviews_allowed- 允许评论。--upsell_ids- 追加销售产品的 ID 列表。--cross_sell_ids- 交叉销售产品的 ID 列表。--parent_id- 产品父级 ID。--purchase_note- 购买后发送给客户的可选备注。--categories- 分类列表。--tags- 标签列表。--images- 图片列表。--attributes- 属性列表。--default_attributes- 默认变体属性。--menu_order- 菜单排序,用于自定义产品排序。--meta_data- 元数据。--porcelain- 操作成功时,仅输出 ID。
wc product delete [id]
--id- 资源的唯一标识符。--force- 是否绕过回收站,强制删除。--porcelain- 操作成功时,仅输出 ID。
wc product_attribute_term
wc product_attribute_term list <attribute_id>
--attribute_id- 属性的唯一标识符。--context- 请求的范围;决定响应中包含的字段。--page- 集合的当前页。--per_page- 返回结果集中最多显示的项数。默认为 100 项。--search- 限制结果,仅包含匹配的字符串。--exclude- 确保结果集中排除指定的 ID。--include- 限制结果集,仅包含指定的 ID。--order- 升序或降序排序。--orderby- 根据资源属性对集合进行排序。--hide_empty- 是否隐藏未分配给任何产品的资源。--parent- 限制结果集,仅包含分配给特定父级的资源。--product- 限制结果集,仅包含分配给特定产品的资源。--slug- 限制结果集,仅包含具有特定别名的资源。--fields- 限制响应,仅包含指定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_attribute_term create <attribute_id>
--attribute_id- 属性的唯一标识符。--name- 资源的名称。(必需)--slug- 资源的字母数字标识符,该标识符在资源类型中是唯一的。--description- 资源的 HTML 描述。--menu_order- 菜单排序,用于自定义排序资源。--porcelain- 当操作成功时,仅输出 ID。
wc product_attribute_term get <attribute_id> [id]
--id- 资源的唯一标识符。--attribute_id- 属性的唯一标识符。--context- 请求的范围;决定响应中包含的字段。--fields- 限制响应,仅包含指定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_attribute_term update <attribute_id> [id]
--id- 资源的唯一标识符。--attribute_id- 属性的唯一标识符。--name- 术语名称。--slug- 资源的字母数字标识符,该标识符在资源类型中是唯一的。--description- 资源的 HTML 描述。--menu_order- 菜单排序,用于自定义排序资源。--porcelain- 当操作成功时,仅输出 ID。
wc product_attribute_term delete <attribute_id> [id]
--id- 资源的唯一标识符。--attribute_id- 属性的唯一标识符。--force- 必须设置为 true,因为资源不支持放入回收站。--porcelain- 当操作成功时,仅输出 ID。
wc product_attribute
wc product_attribute list
--context- 发送请求的上下文范围;决定响应中包含的字段。--fields- 限制响应仅包含指定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_attribute create
--name- 资源的名称。(必需)--slug- 资源的字母数字标识符,该标识符在资源类型中是唯一的。--type- 属性的类型。--order_by- 默认排序顺序。--has_archives- 启用/禁用属性归档。--porcelain- 当操作成功时,仅输出 ID。
wc product_attribute get [id]
--id- 资源的唯一标识符。--context- 发送请求的上下文范围;决定响应中包含的字段。--fields- 限制响应仅包含指定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_attribute update [id]
--id- 资源的唯一标识符。--name- 属性名称。--slug- 资源的字母数字标识符,该标识符在资源类型中是唯一的。--type- 属性的类型。--order_by- 默认排序顺序。--has_archives- 启用/禁用属性归档。--porcelain- 当操作成功时,仅输出 ID。
wc product_attribute delete [id]
--id- 资源的唯一标识符。--force- 必须设置为 true,因为资源不支持放入回收站。--porcelain- 当操作成功时,仅输出 ID。
wc product_cat
wc product_cat list
--context- 发送请求的上下文范围;决定响应中包含的字段。--page- 集合的当前页。--per_page- 返回结果集中最多显示的项数。默认为 100 项。--search- 限制结果,仅包含匹配的字符串。--exclude- 确保结果集中排除指定的 ID。--include- 限制结果集,仅包含指定的 ID。--order- 按照属性升序或降序排序。--orderby- 按照资源属性排序集合。--hide_empty- 是否隐藏未分配给任何产品的资源。--parent- 限制结果集,仅包含分配给特定父级的资源。--product- 限制结果集,仅包含分配给特定产品的资源。--slug- 限制结果集,仅包含具有特定别名的资源。--fields- 限制响应仅包含指定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_cat create
--name- 资源的名称。(必需)--slug- 资源的字母数字标识符,该标识符在资源类型中是唯一的。--parent- 资源的父级 ID。--description- 资源的 HTML 描述。--display- 分类归档显示类型。--image- 图像数据。--menu_order- 菜单排序,用于自定义资源排序。--porcelain- 当操作成功时,仅输出 ID。
wc product_cat get [id]
--id- 资源的唯一标识符。--context- 发送请求的范围;确定响应中包含的字段。--fields- 限制响应为特定字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_cat update [id]
--id- 资源的唯一标识符。--name- 分类名称。--slug- 资源的字母数字标识符,该标识符在资源类型中是唯一的。--parent- 资源的父级 ID。--description- 资源的 HTML 描述。--display- 分类归档显示类型。--image- 图像数据。--menu_order- 菜单排序,用于自定义资源排序。--porcelain- 当操作成功时,仅输出 ID。
wc product_cat delete [id]
--id- 资源的唯一标识符。--force- 必须设置为 true,因为资源不支持放入回收站。--porcelain- 当操作成功时,仅输出 ID。
wc product_review
wc product_review list <product_id>
--product_id- 可变产品的唯一标识符。--id- 变体的唯一标识符。--context- 发送请求的范围;确定响应中包含的字段。--fields- 限制响应为特定字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_review create <product_id>
--product_id- 可变产品的唯一标识符。--id- 变体的唯一标识符。--review- 评论内容。(必需)--date_created- 评论创建的日期,使用站点的时区。--date_created_gmt- 评论创建的日期,以 GMT 为准。--rating- 评论评分(0 到 5)。--name- 评论者姓名。(必需)--email- 评论者邮箱。(必需)--porcelain- 当操作成功时,仅输出 ID。
wc product_review get <product_id> [id]
--product_id- 可变产品的唯一标识符。--id- 资源的唯一标识符。--context- 发送请求的范围;确定响应中包含的字段。--fields- 限制响应仅包含特定字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认值: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_review update <product_id> [id]
--product_id- 可变产品的唯一标识符。--id- 资源的唯一标识符。--review- 评论内容。--date_created- 评论创建日期,使用站点时区。--date_created_gmt- 评论创建日期,以 GMT 时区表示。--rating- 评论评分(0 到 5)。--name- 评论者姓名。--email- 评论者邮箱。--porcelain- 操作成功时,仅输出 ID。
wc product_review delete <product_id> [id]
--product_id- 可变产品的唯一标识符。--id- 资源的唯一标识符。--force- 是否绕过回收站,强制删除。--porcelain- 操作成功时,仅输出 ID。
wc product_shipping_class
wc product_shipping_class list
--context- 发送请求的范围;确定响应中包含的字段。--page- 集合的当前页。--per_page- 返回结果集中最多显示的项数。默认为 100 项。--search- 限制结果,仅包含匹配的字符串。--exclude- 确保结果集中排除指定的 ID。--include- 限制结果集,仅包含指定的 ID。--offset- 通过指定数量的项来偏移结果集。--order- 升序或降序排列排序属性。--orderby- 按资源属性对集合进行排序。--hide_empty- 是否隐藏未分配给任何产品的资源。--product- 限制结果集,仅包含分配给特定产品的资源。--slug- 限制结果集,仅包含具有特定别名的资源。--fields- 限制响应仅包含特定字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认值: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_shipping_class create
--name- 资源的名称。(必需)--slug- 资源的字母数字标识符,该标识符在资源类型中是唯一的。--description- 资源的 HTML 描述。--porcelain- 操作成功时,仅输出 ID。
wc product_shipping_class get [id]
--id- 资源的唯一标识符。--context- 发送请求的范围;决定响应中包含的字段。--fields- 限制响应仅包含特定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_shipping_class update [id]
--id- 资源的唯一标识符。--name- 配送类型的名称。--slug- 资源的字母数字标识符,该标识符在资源类型中是唯一的。--description- 资源的 HTML 描述。--porcelain- 当操作成功时,仅输出 ID。
wc product_shipping_class delete [id]
--id- 资源的唯一标识符。--force- 必须设置为 true,因为该资源不支持放入回收站。--porcelain- 当操作成功时,仅输出 ID。
wc product_tag
wc product_tag list
--context- 发送请求的范围;决定响应中包含的字段。--page- 集合的当前页。--per_page- 结果集中返回的最大项目数。默认为 100 个项目。--search- 限制结果,仅包含与字符串匹配的结果。--exclude- 确保结果集排除指定的 ID。--include- 限制结果集仅包含指定的 ID。--offset- 通过指定的项目数偏移结果集。--order- 升序或降序排序属性。--orderby- 按资源属性对集合进行排序。--hide_empty- 是否隐藏未分配给任何产品的资源。--product- 限制结果集仅包含分配给特定产品的资源。--slug- 限制结果集仅包含具有特定别名的资源。--fields- 限制响应仅包含特定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_tag create
--name- 资源的名称。(必需)--slug- 资源的字母数字标识符,该标识符在资源类型中是唯一的。--description- 资源的 HTML 描述。--porcelain- 当操作成功时,仅输出 ID。
wc product_tag get [id]
--id- 资源的唯一标识符。--context- 发送请求的范围;决定响应中包含的字段。--fields- 限制响应仅包含特定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_tag update [id]
--id- 资源的唯一标识符。--name- 标签名。--slug- 资源的字母数字标识符,该标识符在资源类型中是唯一的。--description- 资源的 HTML 描述。--porcelain- 操作成功时,仅输出 ID。
wc product_tag delete [id]
--id- 资源的唯一标识符。--force- 必须设置为 true,因为该资源不支持移至回收站。--porcelain- 操作成功时,仅输出 ID。
wc product_variation
wc product_variation list <product_id>
--product_id- 可变产品的唯一标识符。--context- 发起请求的范围;确定响应中包含的字段。--page- 集合的当前页。--per_page- 返回结果集中最多的项目数。默认为 100 个项目。--search- 将结果限制为与字符串匹配的项目。--after- 将响应限制为在给定 ISO8601 兼容日期之后发布的资源。--before- 将响应限制为在给定 ISO8601 兼容日期之前发布的资源。--exclude- 确保结果集排除特定的 ID。--include- 将结果集限制为特定的 ID。--offset- 通过指定的项目数偏移结果集。--order- 按照升序或降序排序属性。--orderby- 按照对象的属性进行排序。--parent- 将结果集限制为特定父 ID 的资源。--parent_exclude- 将结果集限制为所有项目,但排除特定父 ID 的项目。--slug- 将结果集限制为具有特定别名的产品。--status- 将结果集限制为具有特定状态的产品。--type- 将结果集限制为具有特定类型的产品。--sku- 将结果集限制为具有特定 SKU 的产品。--featured- 将结果集限制为精选产品。--category- 将结果集限制为分配了特定分类 ID 的产品。--tag- 将结果集限制为分配了特定标签 ID 的产品。--shipping_class- 将结果集限制为分配了特定配送类型的产品。--attribute- 将结果集限制为具有特定属性的产品。--attribute_term- 将结果集限制为具有特定属性项 ID 的产品(需要已分配的属性)。--tax_class- 将结果集限制为具有特定税类的产品。--in_stock- 将结果集限制为在库存或缺货的产品。--on_sale- 将结果集限制为正在促销的产品。--min_price- 根据最低价格限制结果集。--max_price- 根据最高价格限制结果集。--fields- 限制响应为特定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式呈现响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc product_variation create "<product_id>"
--product_id- 可变产品的唯一标识符。--description- 变体的描述。--sku- 唯一标识符。--regular_price- 变体的常规价格。--sale_price- 变体的促销价格。--date_on_sale_from- 促销价格的起始日期,使用网站的时区。--date_on_sale_from_gmt- 促销价格的起始日期,使用 GMT 时区。--date_on_sale_to- 促销价格的结束日期,使用网站的时区。--date_on_sale_to_gmt- 促销价格的结束日期,使用 GMT 时区。--visible- 定义该属性是否在产品的“其他信息”选项卡中可见。--virtual- 如果该变体是虚拟的。--downloadable- 如果该变体可以下载。--downloads- 可下载文件的列表。--download_limit- 购买后,可下载文件可以下载的次数。--download_expiry- 访问可下载文件的天数限制。--tax_status- 税收状态。--tax_class- 税类。--manage_stock- 在变体级别进行库存管理。--stock_quantity- 库存数量。--in_stock- 控制该变体是否在前端显示为“有库存”或“缺货”。--backorders- 如果管理库存,则控制是否允许延期交货。--weight- 变体的重量(磅)。--dimensions- 变体的尺寸。--shipping_class- 配送类型的别名。--image- 变体的图像数据。--attributes- 属性列表。--menu_order- 菜单排序,用于自定义产品排序。--meta_data- 元数据。--porcelain- 操作成功时,仅输出 ID。
wc product_variation get "<product_id>" [id]
--product_id- 可变产品的唯一标识符。--id- 变体的唯一标识符。--context- 发起请求的作用域;确定响应中包含的字段。--fields- 限制响应仅包含特定字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认值: table
选项: table, json, csv, ids, yaml, count, headers, body, envelope
wc product_variation update <product_id> [id]
--product_id- 可变产品的唯一标识符。--id- 变体的唯一标识符。--description- 变体描述。--sku- 唯一标识符。--regular_price- 变体的常规价格。--sale_price- 变体的促销价格。--date_on_sale_from- 促销价格的起始日期,使用站点时区。--date_on_sale_from_gmt- 促销价格的起始日期,使用 GMT 时区。--date_on_sale_to- 促销价格的结束日期,使用站点时区。--date_on_sale_to_gmt- 促销价格的结束日期,使用 GMT 时区。--visible- 定义该属性是否在产品的“其他信息”选项卡中可见。--virtual- 如果该变体是虚拟的。--downloadable- 如果该变体可以下载。--downloads- 可下载文件的列表。--download_limit- 购买后,可下载文件可以下载的次数。--download_expiry- 可下载文件过期前的天数。--tax_status- 税收状态。--tax_class- 税类。--manage_stock- 在变体级别进行库存管理。--stock_quantity- 库存数量。--in_stock- 控制该变体在前台显示为“有库存”或“缺货”。--backorders- 如果管理库存,则控制是否允许延期交货。--weight- 变体的重量(磅)。--dimensions- 变体的尺寸。--shipping_class- 配送类型的别名。--image- 变体的图像数据。--attributes- 属性列表。--menu_order- 菜单排序,用于自定义产品排序。--meta_data- 元数据。--porcelain- 操作成功时,仅输出 ID。
wc product_variation delete <product_id> [id]
--product_id- 可变产品的唯一标识符。--id- 变体的唯一标识符。--force- 是否绕过回收站,强制删除。--porcelain- 操作成功时,仅输出 ID。
wc setting
wc setting get [id]
--group- 设置组 ID。--fields- 限制响应的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项: table, json, csv, ids, yaml, count, headers, body, envelope
wc setting update [id]
--group- 设置组 ID。--id- 资源的唯一标识符。--value- 设置值。--porcelain- 操作成功时,仅输出 ID。
wc shipping_method
wc shipping_method list
--context- 请求的上下文;决定响应中包含的字段。--fields- 限制响应的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shipping_method get [id]
--id- 资源的唯一标识符。--context- 请求的上下文;决定响应中包含的字段。--fields- 限制响应的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shipping_zone
wc shipping_zone list
--fields- 限制响应的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shipping_zone create
--name- 配送区域名称。(必需)--order- 配送区域顺序。--porcelain- 当操作成功时,仅输出 ID。
wc shipping_zone get [id]
--id- 资源的唯一 ID。--fields- 限制响应的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shipping_zone update [id]
--id- 资源的唯一 ID。--name- 配送区域名称。--order- 配送区域顺序。--porcelain- 当操作成功时,仅输出 ID。
wc shipping_zone delete [id]
--id- 资源的唯一 ID。--force- 是否绕过回收站,强制删除。--porcelain- 当操作成功时,仅输出 ID。
wc shipping_zone_location
wc shipping_zone_location list
--id- 资源的唯一 ID。--fields- 限制响应的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shipping_zone_method
wc shipping_zone_method list
--zone_id- 区域的唯一 ID。--fields- 限制响应的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shipping_zone_method create
--zone_id- 区域的唯一 ID。--order- 配送方式的排序顺序。--enabled- 配送方式的启用状态。--settings- 配送方式的设置。--method_id- 配送方式 ID。 (必需)--porcelain- 当操作成功时,仅输出 ID。
wc shipping_zone_method get [id]
--zone_id- 区域的唯一 ID。--instance_id- 实例的唯一 ID。--fields- 限制响应仅包含特定字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shipping_zone_method update [id]
--zone_id- 区域的唯一 ID。--instance_id- 实例的唯一 ID。--order- 配送方式的排序顺序。--enabled- 配送方式的启用状态。--settings- 配送方式的设置。--porcelain- 当操作成功时,仅输出 ID。
wc shipping_zone_method delete [id]
--zone_id- 区域的唯一 ID。--instance_id- 实例的唯一 ID。--force- 是否绕过回收站,强制删除。--porcelain- 当操作成功时,仅输出 ID。
wc shop_coupon
wc shop_coupon list
--context- 请求的作用域;决定响应中包含的字段。--page- 集合的当前页。--per_page- 结果集中返回的最大项目数。默认为 100 个项目。--search- 限制结果以匹配某个字符串。--after- 限制响应仅包含在给定 ISO8601 兼容日期之后发布的资源。--before- 限制响应仅包含在给定 ISO8601 兼容日期之前发布的资源。--exclude- 确保结果集排除特定的 ID。--include- 限制结果集仅包含特定的 ID。--offset- 通过指定数量的项目偏移结果集。--order- 按照属性升序或降序排序。--orderby- 按照对象属性对集合进行排序。--code- 限制结果集仅包含具有特定代码的资源。--fields- 限制响应仅包含特定字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shop_coupon create
--code- 优惠券代码。(必填)--amount- 折扣金额。 始终应为数字,即使是设置百分比。--discount_type- 确定要应用的折扣类型。--description- 优惠券描述。--date_expires- 优惠券到期日期,使用网站的时区。--date_expires_gmt- 优惠券到期日期,以 GMT 为准。--individual_use- 如果为 true,则优惠券只能单独使用。 其他已应用的优惠券将从购物车中移除。--product_ids- 优惠券可使用的产品 ID 列表。--excluded_product_ids- 优惠券不可使用的产品 ID 列表。--usage_limit- 优惠券总共可以使用多少次。--usage_limit_per_user- 每个客户可以使用优惠券的次数。--limit_usage_to_x_items- 优惠券可以应用的购物车中商品的最大数量。--free_shipping- 如果为 true,并且如果免费配送方法需要优惠券,则此优惠券将启用免费配送。--product_categories- 优惠券适用的分类 ID 列表。--excluded_product_categories- 优惠券不适用的分类 ID 列表。--exclude_sale_items- 如果为 true,则此优惠券将不应用于具有促销价格的商品。--minimum_amount- 优惠券生效前,购物车中所需的最小订单金额。--maximum_amount- 使用优惠券时允许的最大订单金额。--email_restrictions- 可以使用此优惠券的 Email 地址列表。--meta_data- 元数据。--porcelain- 操作成功时,仅输出 ID。
wc shop_coupon get [id]
--id- 资源的唯一标识符。--context- 发送请求的范围;确定响应中包含的字段。--fields- 限制响应仅包含特定字段。 默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认: table
选项: table, json, csv, ids, yaml, count, headers, body, envelope
wc shop_coupon update [id]
--id- 资源的唯一标识符。--code- 优惠券代码。--amount- 折扣金额。 始终应为数字,即使是设置百分比。--discount_type- 确定要应用的折扣类型。--description- 优惠券描述。--date_expires- 优惠券到期日期,采用网站的时区。--date_expires_gmt- 优惠券到期日期,采用 GMT 时区。--individual_use- 如果为 true,则优惠券只能单独使用。 其他已应用的优惠券将从购物车中移除。--product_ids- 优惠券可使用的产品 ID 列表。--excluded_product_ids- 优惠券不可使用的产品 ID 列表。--usage_limit- 优惠券总共可以使用多少次。--usage_limit_per_user- 优惠券每个客户可以使用多少次。--limit_usage_to_x_items- 优惠券可以应用的购物车中商品的最大数量。--free_shipping- 如果为 true,并且如果免费配送方法需要优惠券,则此优惠券将启用免费配送。--product_categories- 优惠券适用的分类 ID 列表。--excluded_product_categories- 优惠券不适用的分类 ID 列表。--exclude_sale_items- 如果为 true,则此优惠券将不应用于具有促销价格的商品。--minimum_amount- 优惠券生效前,购物车中所需的最小订单金额。--maximum_amount- 使用优惠券时允许的最大订单金额。--email_restrictions- 可以使用此优惠券的 Email 地址列表。--meta_data- 元数据。--porcelain- 操作成功时,仅输出 ID。
wc shop_coupon delete [id]
--id- 资源的唯一标识符。--force- 是否绕过回收站,强制删除。--porcelain- 操作成功时,仅输出 ID。
wc shop_order
wc shop_order list
--context- 请求的范围;决定响应中包含的字段。--page- 集合的当前页。--per_page- 返回结果集中最多包含的项目数。默认为 100 个项目。--search- 限制结果,仅包含匹配的字符串。--after- 限制响应,仅包含在给定符合 ISO8601 标准的日期之后发布的资源。--before- 限制响应,仅包含在给定符合 ISO8601 标准的日期之前发布的资源。--exclude- 确保结果集中排除特定的 ID。--include- 限制结果集,仅包含特定的 ID。--offset- 通过指定数量的项目来偏移结果集。--order- 按照升序或降序对排序属性进行排序。--orderby- 按照对象的属性对集合进行排序。--parent- 限制结果集,仅包含特定父 ID 的项目。--parent_exclude- 限制结果集,包含所有项目,但排除特定父 ID 的项目。--status- 限制结果集,仅包含分配了特定状态的订单。--customer- 限制结果集,仅包含分配给特定客户的订单。--product- 限制结果集,仅包含分配给特定产品的订单。--dp- 每个资源中使用的十进制位数。--fields- 限制响应,仅包含特定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式呈现响应。
默认值: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shop_order create
--parent_id- 父订单 ID。--status- 订单状态。--currency- 订单创建时使用的货币,以 ISO 格式表示。--customer_id- 拥有该订单的用户 ID。访客为 0。--customer_note- 客户在结账时留下的备注。--billing- 账单地址。--shipping- 配送地址。--payment_method- 支付方式 ID。--payment_method_title- 支付方式标题。--transaction_id- 唯一的交易 ID。--meta_data- 元数据。--line_items- 商品明细数据。--shipping_lines- 配送明细数据。--fee_lines- 费用明细数据。--coupon_lines- 优惠券明细数据。--set_paid- 定义订单是否已支付。如果设置为 true,则会将状态设置为“处理中”,并减少库存数量。--porcelain- 当操作成功时,仅输出 ID。
wc shop_order get [id]
--id- 资源的唯一标识符。--context- 请求的范围;决定响应中包含的字段。--fields- 限制响应,仅包含特定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式呈现响应。
默认值: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shop_order update [id]
--id- 资源的唯一标识符。--parent_id- 父订单 ID。--status- 订单状态。--currency- 订单创建时使用的货币,采用 ISO 格式。--customer_id- 拥有该订单的用户 ID。访客用户为 0。--customer_note- 客户在结账时留下的备注。--billing- 账单地址。--shipping- 收货地址。--payment_method- 支付方式 ID。--payment_method_title- 支付方式标题。--transaction_id- 唯一的交易 ID。--meta_data- 元数据。--line_items- 商品明细数据。--shipping_lines- 运费明细数据。--fee_lines- 费用明细数据。--coupon_lines- 优惠券明细数据。--set_paid- 定义订单是否已支付。如果设置为 true,将更改状态为“处理中”,并减少库存商品数量。--porcelain- 操作成功时,仅输出 ID。
wc shop_order delete [id]
--id- 资源的唯一标识符。--force- 是否绕过回收站,强制删除。--porcelain- 操作成功时,仅输出 ID。
wc shop_order_refund
wc shop_order_refund list <order_id>
--order_id- 订单 ID。--context- 请求的作用域;确定响应中包含的字段。--page- 集合的当前页。--per_page- 返回结果集中最多显示的条目数。默认为 100 个条目。--search- 将结果限制为与字符串匹配的条目。--after- 将响应限制为在给定 ISO8601 兼容日期之后发布的资源。--before- 将响应限制为在给定 ISO8601 兼容日期之前发布的资源。--exclude- 确保结果集排除特定的 ID。--include- 将结果集限制为特定的 ID。--offset- 通过指定的数量偏移结果集。--order- 排序属性的升序或降序。--orderby- 按对象属性对集合进行排序。--parent- 将结果集限制为特定父 ID 的条目。--parent_exclude- 将结果集限制为所有项目,但排除特定父 ID 的项目。--dp- 在每个资源中使用的十进制位数。--fields- 将响应限制为特定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shop_order_refund create <order_id>
--order_id- 订单 ID。--amount- 退款金额。--reason- 退款原因。--refunded_by- 创建退款的用户 ID。--meta_data- 元数据。--line_items- 商品明细数据。--api_refund- 如果设置为 true,则使用支付网关 API 生成退款。--porcelain- 操作成功时,仅输出 ID。
wc shop_order_refund get <order_id> [id]
--order_id- 订单 ID。--id- 资源的唯一标识符。--context- 发送请求的上下文;决定响应中包含的字段。--fields- 限制响应仅包含指定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc shop_order_refund delete <order_id> [id]
--order_id- 订单 ID。--id- 资源的唯一标识符。--force- 必须设置为 true,因为该资源不支持放入回收站。--porcelain- 操作成功时,仅输出 ID。
wc tax
wc tax list
--context- 发送请求的上下文;决定响应中包含的字段。--page- 集合的当前页。--per_page- 结果集中返回的最大项目数。默认为 100 个项目。--search- 限制结果以匹配字符串。--exclude- 确保结果集排除指定的 ID。--include- 限制结果集为指定的 ID。--offset- 通过指定的项目数偏移结果集。--order- 按照属性升序或降序排序。--orderby- 按照对象属性排序集合。--class- 按照税类排序。--fields- 限制响应仅包含指定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc tax create
--country- 国家 ISO 3166 代码。--state- 州代码。--postcode- 邮政编码 / ZIP 码。--city- 城市名称。--rate- 税率。--name- 税率名称。--priority- 税优先级。--compound- 是否为复合税率。--shipping- 是否也应用于配送。--order- 指示查询中出现的顺序。--class- 税类。--porcelain- 操作成功时,仅输出 ID。
wc tax get [id]
--id- 资源的唯一标识符。--context- 发送请求的上下文;决定响应中包含的字段。--fields- 限制响应仅包含指定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定格式呈现响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc tax update [id]
--id- 资源的唯一标识符。--country- 国家 ISO 3166 代码。--state- 州代码。--postcode- 邮政编码 / 邮编。--city- 城市名称。--rate- 税率。--name- 税率名称。--priority- 税优先级。--compound- 是否为复合税率。--shipping- 是否也应用于配送。--order- 在查询中显示的顺序。--class- 税类。--porcelain- 操作成功时,仅输出 ID。
wc tax delete [id]
--id- 资源的唯一标识符。--force- 必须为 true,因为该资源不支持放入回收站。--porcelain- 操作成功时,仅输出 ID。
wc tax_class
wc tax_class list
--context- 请求的范围;决定响应中包含的字段。--fields- 限制响应为特定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc tax_class create
--name- 税类名称。(必需)--porcelain- 操作成功时,仅输出 ID。
wc tax_class delete [id]
--slug- 资源的唯一别名。--force- 必须为 true,因为该资源不支持放入回收站。--porcelain- 操作成功时,仅输出 ID。
wc webhook
wc webhook list
--context- 请求的范围;决定响应中包含的字段。--page- 集合的当前页。--per_page- 返回结果集中最多显示的条目数。默认为 100 个条目。--search- 限制结果,仅包含匹配的字符串。--after- 限制响应,仅包含已发布的资源,发布时间晚于指定的 ISO8601 格式日期。--before- 限制响应,仅包含已发布的资源,发布时间早于指定的 ISO8601 格式日期。--exclude- 确保结果集排除特定的 ID。--include- 限制结果集为特定的 ID。--offset- 通过指定的数量的条目偏移结果集。--order- 按照升序或降序排列。--orderby- 按照对象的属性进行排序。--status- 限制结果集,仅包含具有特定状态的 webhook。--fields- 限制响应为特定的字段。默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式渲染响应。
默认: table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc webhook create
--name- Webhook 的友好名称。--status- Webhook 的状态。--topic- Webhook 的主题。 (必需)--secret- Webhook 的密钥。 (必需)--delivery_url- Webhook 的推送 URL。 (必需)--porcelain- 当操作成功时,只输出 ID。
wc webhook get [id]
--id- 资源的唯一标识符。--context- 发送请求的上下文;决定响应中包含的字段。--fields- 限制响应的字段。 默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式渲染响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc webhook update [id]
--id- 资源的唯一标识符。--name- Webhook 的友好名称。--status- Webhook 的状态。--topic- Webhook 的主题。--secret- 用于生成推送 webhook 的哈希值的密钥,并在请求头中提供。 如果未提供,则默认为当前用户的 ID|用户名 的 MD5 哈希值。--porcelain- 当操作成功时,只输出 ID。
wc webhook delete [id]
--id- 资源的唯一标识符。--force- 必须设置为 true,因为资源不支持放入回收站。--porcelain- 当操作成功时,只输出 ID。
wc webhook_delivery
wc webhook_delivery list
--webhook_id- Webhook 的唯一标识符。--context- 发送请求的上下文;决定响应中包含的字段。--fields- 限制响应的字段。 默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式渲染响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope
wc webhook_delivery get [id]
--webhook_id- Webhook 的唯一标识符。--id- 资源的唯一标识符。--context- 发送请求的上下文;决定响应中包含的字段。--fields- 限制响应的字段。 默认为所有字段。--field- 获取单个字段的值。--format- 以特定的格式渲染响应。
默认:table
选项:table, json, csv, ids, yaml, count, headers, body, envelope