跳转到主要内容

书籍

WooCommerce REST API 文档

WooCommerce REST API 中文文档，介绍接口约定与常见资源用法。

112 页更新于 7 个月前

开始阅读

目录112

  1. 01 Index.Html title: WooCommerce REST API Documentation - WP REST API v3 language_tabs: shell: cURL javascript: Node.js p... 7 个月前
  2. 02 V1.Html title: WooCommerce REST API Documentation v1 language_tabs: shell: cURL toc_footers: Contributing to WC RES... 7 个月前
  3. 03 V2.Html title: WooCommerce REST API Documentation v2 language_tabs: shell: cURL javascript: Node.js python: Python ... 7 个月前
  4. 04 V3.Html title: WooCommerce REST API Documentation v3 language_tabs: shell: cURL javascript: Node.js php: PHP python... 7 个月前
  5. 05 Wp Api V1.Html title: WooCommerce REST API Documentation - WP REST API v1 language_tabs: shell: cURL javascript: Node.js p... 7 个月前
  6. 06 Wp Api V2.Html title: WooCommerce REST API Documentation - WP REST API v2 language_tabs: shell: cURL javascript: Node.js p... 7 个月前
  7. 07 简介 自 v2.1 版本起，WooCommerce 包含了一个 REST API，允许以 JSON 或 XML 格式访问商店数据。当前版本为只读（更新订单状态是唯一的例外），但未来版本将允许更新、创建和删除资源。 要求 ... 7 个月前
  8. 08 优惠券 # 本节列出了所有可用于创建、编辑或以其他方式操作优惠券的 API。 优惠券属性 Attribute Type Description id integer Coupon ID (post ID) read-only ... 7 个月前
  9. 09 客户 # 本节列出了所有可用于创建、编辑或以其他方式操作客户的 API。 客户属性 Attribute Type Description id integer Customer ID (user ID) read-only ... 7 个月前
  10. 10 索引 # API 索引提供有关网站可用端点的信息，以及特定于商店的信息。访问 API 索引无需身份验证，但如果 REST API 被禁用，您将收到 404 Not Found 错误。 404 Not Found 响应： {... 7 个月前
  11. 11 简介 # WooCommerce 2.1 版本引入的 REST API 支持使用 JSON 格式对商店数据进行创建、读取、更新和删除操作。 要求 必须使用 WooCommerce 2.1 或更高版本，并确保在 WooCom... 7 个月前
  12. 12 订单 # 本节列出了所有可用于创建、编辑或以其他方式操作订单的 API。 订单属性 Attribute Type Description id integer Order ID (post ID) read-only ord... 7 个月前
  13. 13 产品 # 本节列出了所有可用于创建、编辑或以其他方式操作产品的 API。 产品属性 Attribute Type Description title string Product name id integer Produc... 7 个月前
  14. 14 报告 # 本节列出了所有可用于查看报告的 API。 报告过滤器 对于任何类型的报告，均可使用以下过滤器来指定销售时段： 过滤器 类型 描述 period 字符串 支持的时段包括： week、 month、 last_mont... 7 个月前
  15. 15 Webhooks # This section lists all API that can be used to create, edit or otherwise manipulate webhooks. Webhooks Prop... 7 个月前
  16. 16 认证端点 # 自 WooCommerce 2.4 起，我们引入了认证端点。任何应用程序均可使用此端点，允许用户生成 API 密钥。这使得与 WooCommerce API 的集成更为简便，因为用户只需访问一个 URL 并点击“接... 7 个月前
  17. 17 优惠券 # 本节列出了所有可用于创建、编辑或以其他方式操作优惠券的 API 端点。 优惠券属性 Attribute Type Description id integer Coupon ID (post ID) read-on... 7 个月前
  18. 18 客户 # 本节列出了所有可用于创建、编辑或以其他方式操作客户的 API 端点。 客户属性 Attribute Type Description id integer Customer ID (user ID) read-on... 7 个月前
  19. 19 索引 # API 索引提供有关网站可用端点的信息，以及特定于商店的信息。访问 API 索引无需身份验证，但如果 REST API 被禁用，您将收到 404 Not Found 错误。 404 Not Found 响应： {... 7 个月前
  20. 20 简介 # WooCommerce 2.1 版本引入的 REST API 允许使用 JSON 格式对 WooCommerce 数据进行创建、读取、更新和删除操作。 要求 您必须使用 WooCommerce 2.1 或更高版本，... 7 个月前
  21. 21 订单 - 备注 # 本节列出了所有可用于创建、编辑或以其他方式操作订单备注的 API 端点。 订单备注属性 属性 类型 描述 id integer 订单备注 ID 只读 created_at string 订单备注创建时的 UTC 日... 7 个月前
  22. 22 订单 - 退款 # 本节列出了所有可用于创建、编辑或操作订单退款的 API 端点。 订单退款属性 属性 类型 描述 id integer 订单备注 ID 只读 created_at string 订单退款创建时的 UTC 日期时间 只... 7 个月前
  23. 23 订单 # 本节列出了所有可用于创建、编辑或以其他方式操作订单的 API 端点。 订单属性 Attribute Type Description id integer Order ID (post ID) read-only ... 7 个月前
  24. 24 产品 - 属性术语 # 本节列出了所有可用于创建、编辑或以其他方式操作产品属性术语的 API 端点。 产品属性特性 属性 类型 描述 id integer 术语 ID (term ID) 只读 name string 术语名称 必需 sl... 7 个月前
  25. 25 Product - Attributes # This section lists all API endpoints that can be used to create, edit or otherwise manipulate product attri... 7 个月前
  26. 26 Product - Categories # This section lists all API endpoints that can be used to create, edit or otherwise manipulate product categ... 7 个月前
  27. 27 Product - Shipping Classes # This section lists all API endpoints that can be used to create, edit or otherwise manipulate product shipp... 7 个月前
  28. 28 产品 - 标签 # 本节列出了所有可用于创建、编辑或以其他方式操作产品标签的 API 端点。 产品标签属性 属性 类型 描述 id integer 标签 ID（术语 ID）只读 name string 标签名称 必需 slug str... 7 个月前
  29. 29 产品 # 本节列出了所有可用于创建、编辑或以其他方式操作产品的 API 端点。 产品属性 Attribute Type Description title string Product name id integer Pro... 7 个月前
  30. 30 报告 # 本节列出了所有可用于查看报告的 API 端点。 报告过滤器 对于任何类型的报告，可使用以下过滤器来指定销售时段： 过滤器 类型 描述 period 字符串 支持的时段有： week、 month、 last_mon... 7 个月前
  31. 31 税费 - 类别 # 本节列出了所有可用于创建、编辑或以其他方式操作税费类别的 API 端点。 税费属性 属性 类型 描述 slug string 税费类别标识符 只读 name string 税费类别名称 创建税率类别 此 API 可... 7 个月前
  32. 32 Taxes # This section lists all API endpoints that can be used to create, edit or otherwise manipulate tax rates. Ta... 7 个月前
  33. 33 Webhooks # This section lists all API endpoints that can be used to create, edit or otherwise manipulate webhooks. Web... 7 个月前
  34. 34 身份验证 # WooCommerce 提供了两种与 WP REST API 进行身份验证的方式。您也可以使用任何 WP REST API 身份验证插件或方法进行身份验证。 REST API 密钥 预生成的密钥可用于验证 REST... 7 个月前
  35. 35 优惠券 # 优惠券 API 允许您创建、查看、更新和删除单个或批量优惠券代码。 优惠券属性 Attribute Type Description id integer Unique identifier for the obj... 7 个月前
  36. 36 客户 # 客户 API 允许您创建、查看、更新和删除单个或批量客户。 客户属性 Attribute Type Description id integer Unique identifier for the resource... 7 个月前
  37. 37 索引 # 默认情况下，API 提供站点上所有可用端点的信息。访问 API 索引无需身份验证。 HTTP 请求 GET /wp-json/wc/v1 curl https://example.com/wp-j... 7 个月前
  38. 38 简介 # WooCommerce (WC) 2.6+ 版本已与 WordPress REST API 完全集成。这使得 WC 数据能够通过 JSON 格式的请求、WordPress REST API 认证方法以及大多数 HT... 7 个月前
  39. 39 订单备注 # 订单备注 API 允许您创建、查看和删除单个订单备注。 订单备注由管理员或通过程序添加，用于存储订单或订单事件的相关数据。 Order note properties Attribute Type Descript... 7 个月前
  40. 40 退款 # 退款 API 允许您创建、查看和删除单个退款记录。 退款属性 属性名 类型 描述 id integer 资源的唯一标识符。只读 date_created date-time 订单退款创建的日期，使用站点时区。只读 ... 7 个月前
  41. 41 订单 # 订单 API 允许您创建、查看、更新和删除单个或批量订单。 订单属性 Attribute Type Description id integer Unique identifier for the resource... 7 个月前
  42. 42 Product attribute terms # The product attribute terms API allows you to create, view, update, and delete individual, or a batch, of a... 7 个月前
  43. 43 Product attributes # The product attributes API allows you to create, view, update, and delete individual, or a batch, of produc... 7 个月前
  44. 44 Product categories # The product categories API allows you to create, view, update, and delete individual, or a batch, of catego... 7 个月前
  45. 45 产品配送类别 # 产品配送类别 API 允许您创建、查看、更新和删除单个或批量的配送类别。 配送类别属性 属性 类型 描述 id integer 资源的唯一标识符。只读 name string 配送类别名称。必需 slug stri... 7 个月前
  46. 46 产品标签 # 产品标签 API 允许您创建、查看、更新和删除单个或批量产品标签。 产品标签属性 属性 类型 描述 id 整数 资源的唯一标识符。只读 name 字符串 标签名称。必需 slug 字符串 资源在其类型中唯一的字母数... 7 个月前
  47. 47 产品 # 产品 API 允许您创建、查看、更新和删除单个或批量产品。 产品属性 Attribute Type Description id integer Unique identifier for the resource... 7 个月前
  48. 48 报告 # 报告 API 允许您查看所有可用的报告类型。 列出所有报告 此 API 允许您检索并查看可用报告的简单列表。 HTTP request GET /wp-json/wc/v1/reports cur... 7 个月前
  49. 49 税率类别 # 税率类别 API 允许您创建、查看和删除单个税率类别。 税率类别属性 属性 类型 描述 slug string 资源的唯一标识符。只读 name string 税率类别名称。必需 创建税率类别 此 API 可帮助您... 7 个月前
  50. 50 Tax rates # The taxes API allows you to create, view, update, and delete individual tax rates, or a batch of tax rates.... 7 个月前
  51. 51 Webhooks # Webhooks API 允许您创建、查看、更新和删除单个或批量 Webhook。 Webhook 可以通过 WooCommerce 设置界面或使用 REST API 端点进行管理。 WC_Webhook 类负责管... 7 个月前
  52. 52 身份验证 # WooCommerce 提供了两种与 WP REST API 进行身份验证的方式。您也可以使用任何 WP REST API 身份验证插件或方法进行身份验证。 REST API 密钥 预生成的密钥可用于验证 REST... 7 个月前
  53. 53 优惠券 # 优惠券 API 允许您创建、查看、更新和删除单个或批量优惠券代码。 优惠券属性 Attribute Type Description id integer Unique identifier for the obj... 7 个月前
  54. 54 客户 # 客户 API 允许您创建、查看、更新和删除单个或批量客户。 客户属性 Attribute Type Description id integer Unique identifier for the resource... 7 个月前
  55. 55 索引 # 默认情况下，API 提供站点上所有可用端点的信息。访问 API 索引无需身份验证。 HTTP 请求 GET /wp-json/wc/v2 curl https://example.com/wp-j... 7 个月前
  56. 56 简介 # WooCommerce (WC) 2.6+ 已与 WordPress REST API 完全集成。这使得可以使用 JSON 格式的请求、WordPress REST API 认证方法以及大多数 HTTP 客户端都能... 7 个月前
  57. 57 订单备注 # 订单备注 API 允许您创建、查看和删除单个订单备注。 订单备注由管理员或通过程序添加，用于存储订单或订单事件的相关数据。 Order note properties Attribute Type Descript... 7 个月前
  58. 58 Refunds # The refunds API allows you to create, view, and delete individual refunds. Order refund properties Attribut... 7 个月前
  59. 59 订单 # 订单 API 允许您创建、查看、更新和删除单个或批量订单。 订单属性 Attribute Type Description id integer Unique identifier for the resource... 7 个月前
  60. 60 Payment gateways # The payment gateways API allows you to view, and update individual payment gateways. Results are not pagina... 7 个月前
  61. 61 Product attribute terms # The product attribute terms API allows you to create, view, update, and delete individual, or a batch, of a... 7 个月前
  62. 62 Product attributes # The product attributes API allows you to create, view, update, and delete individual, or a batch, of produc... 7 个月前
  63. 63 Product categories # The product categories API allows you to create, view, update, and delete individual, or a batch, of catego... 7 个月前
  64. 64 产品配送类别 # 产品配送类别 API 允许您创建、查看、更新和删除单个或批量的配送类别。 产品配送类别属性 属性 类型 描述 id integer 资源的唯一标识符。只读 name string 配送类别名称。必填 slug st... 7 个月前
  65. 65 产品标签 # 产品标签 API 允许您创建、查看、更新和删除单个或批量产品标签。 产品标签属性 属性 类型 描述 id integer 资源的唯一标识符。只读 name string 标签名称。必需 slug string 资源... 7 个月前
  66. 66 产品变体 # 产品变体 API 允许您创建、查看、更新和删除单个或批量产品变体。 产品变体属性 Attribute Type Description id integer Unique identifier for the re... 7 个月前
  67. 67 产品 # 产品 API 允许您创建、查看、更新和删除单个或批量产品。 产品属性 Attribute Type Description id integer Unique identifier for the resource... 7 个月前
  68. 68 报告 # 报告 API 允许您查看所有可用的报告类型。 列出所有报告 此 API 允许您检索并查看可用报告的简单列表。 HTTP request GET /wp-json/wc/v2/reports cur... 7 个月前
  69. 69 Setting options # Setting option properties Attribute Type Description id string A unique identifier for the setting. read-on... 7 个月前
  70. 70 设置 # 设置 API 允许您查看所有可用的设置组。 设置组属性 属性 类型 描述 id string 可用于将设置链接在一起的唯一标识符。只读 label string 在界面中使用的、人类可读的设置标签。只读 descr... 7 个月前
  71. 71 配送方式 # 配送方式 API 允许您查看单个配送方式。 配送方式属性 属性 类型 描述 id string 方法 ID。只读 title string 配送方式标题。只读 description string 配送方式描述。只... 7 个月前
  72. 72 配送区域位置 # 配送区域位置 API 允许您查看和批量更新配送区域的位置。 配送位置属性 属性 类型 描述 code string 配送区域位置代码。 type string 配送区域位置类型。选项： postcode、 stat... 7 个月前
  73. 73 Shipping zone methods # The shipping zone methods API allows you to create, view, update, and delete individual methods of a shippi... 7 个月前
  74. 74 配送区域 # 配送区域 API 允许您创建、查看、更新和删除单个配送区域。 配送区域属性 属性 类型 描述 id integer 资源的唯一标识符。只读 name string 配送区域名称。必填 order integer 配... 7 个月前
  75. 75 System status tools # The system status tools API allows you to view and run tools from system status. System status tool propert... 7 个月前
  76. 76 System status # The system status API allows you to view all system status items. System status properties Attribute Type D... 7 个月前
  77. 77 税率类别 # 税率类别 API 允许您创建、查看和删除单个税率类别。 税率类别属性 属性 类型 描述 slug string 资源的唯一标识符。只读 name string 税率类别名称。必需 创建税率类别 此 API 可帮助您... 7 个月前
  78. 78 Tax rates # The taxes API allows you to create, view, update, and delete individual tax rates, or a batch of tax rates.... 7 个月前
  79. 79 Webhooks # Webhooks API 允许您创建、查看、更新和删除单个或批量 Webhook。 Webhook 可以通过 WooCommerce 设置界面或使用 REST API 端点进行管理。 WC_Webhook 类负责管... 7 个月前
  80. 80 身份验证 # WooCommerce 提供了两种与 WP REST API 进行身份验证的方式。您也可以使用任何 WP REST API 身份验证插件或方法进行身份验证。 REST API 密钥 预生成的密钥可用于验证 REST... 7 个月前
  81. 81 优惠券 # 优惠券 API 允许您创建、查看、更新和删除单个或批量优惠券代码。 优惠券属性 Attribute Type Description id integer Unique identifier for the obj... 7 个月前
  82. 82 Customers # The customer API allows you to create, view, update, and delete individual, or a batch, of customers. Custo... 7 个月前
  83. 83 数据 # 数据 API 允许您查看所有可用的数据类型。 列出所有数据 此 API 允许您检索并查看可用数据端点的简单列表。 HTTP request GET /wp-json/wc/v3/data curl... 7 个月前
  84. 84 索引 # 默认情况下，API 提供站点上所有可用端点的信息。访问 API 索引无需身份验证。 HTTP 请求 GET /wp-json/wc/v3 curl https://example.com/wp-j... 7 个月前
  85. 85 简介 # WooCommerce (WC) 2.6+ 已与 WordPress REST API 完全集成。这使得 WC 数据能够通过 JSON 格式的请求、WordPress REST API 认证方法以及大多数 HTTP... 7 个月前
  86. 86 订单操作 # 订单操作 API 允许您对现有订单执行特定操作，类似于在网页应用的编辑订单界面中可进行的操作。 注意：目前仅部分操作可用，其他操作将在后续推出。 发送订单详情给客户 此端点允许您向客户发送包含其订单详情的电子邮件。... 7 个月前
  87. 87 订单备注 # 订单备注 API 允许您创建、查看和删除单个订单备注。 订单备注由管理员或通过程序添加，用于存储订单或订单事件的相关数据。 Order note properties Attribute Type Descript... 7 个月前
  88. 88 订单退款 # 订单退款 API 允许您基于现有订单创建、查看和删除单个退款。 订单退款属性 Attribute Type Description id integer Unique identifier for the reso... 7 个月前
  89. 89 订单 # 订单 API 允许您创建、查看、更新和删除单个或批量订单。 订单属性 Attribute Type Description id integer Unique identifier for the resource... 7 个月前
  90. 90 Payment gateways # The payment gateways API allows you to view, and update individual payment gateways. Results are not pagina... 7 个月前
  91. 91 Product attribute terms # The product attribute terms API allows you to create, view, update, and delete individual, or a batch, of a... 7 个月前
  92. 92 Product attributes # The product attributes API allows you to create, view, update, and delete individual, or a batch, of produc... 7 个月前
  93. 93 Product categories # The product categories API allows you to create, view, update, and delete individual, or a batch, of catego... 7 个月前
  94. 94 产品自定义字段 # 产品自定义字段 API 允许您查看已记录的自定义字段名称。 自定义字段可用参数 参数 类型 描述 context string 请求的作用域；决定响应中包含的字段。选项： view 和 edit。默认为 vie... 7 个月前
  95. 95 Product reviews # The product reviews API allows you to create, view, update, and delete individual, or a batch, of product r... 7 个月前
  96. 96 产品配送类别 # 产品配送类别 API 允许您创建、查看、更新和删除单个或批量的配送类别。 产品配送类别属性 属性 类型 描述 id integer 资源的唯一标识符。只读 name string 配送类别名称。必填 slug st... 7 个月前
  97. 97 产品标签 # 产品标签 API 允许您创建、查看、更新和删除单个或批量产品标签。 产品标签属性 属性 类型 描述 id integer 资源的唯一标识符。只读 name string 标签名称。必填 slug string 资源... 7 个月前
  98. 98 产品变体 # 产品变体 API 允许您创建、查看、更新和删除单个或批量产品变体。 产品变体属性 Attribute Type Description id integer Unique identifier for the re... 7 个月前
  99. 99 产品 # 产品 API 允许您创建、查看、更新和删除单个或批量产品。 产品属性 Attribute Type Description id integer Unique identifier for the resource... 7 个月前
  100. 100 退款 # 退款 API 是一个简单的只读端点，允许您在现有订单上下文之外检索退款列表。如需创建、查看和删除单个退款，请查阅订单退款 API。 退款属性 所有属性均与订单退款端点中的属性相同，但额外增加了一个属性： 属性 类型... 7 个月前
  101. 101 报告 # 报告 API 允许您查看所有可用的报告类型。 列出所有报告 此 API 允许您检索并查看可用报告的简单列表。 HTTP 请求 GET /wp-json/wc/v3/reports curl htt... 7 个月前
  102. 102 Setting options # Setting option properties Attribute Type Description id string A unique identifier for the setting. read-on... 7 个月前
  103. 103 设置 # 设置 API 允许您查看所有可用的设置组。 设置组属性 属性 类型 描述 id string 可用于将设置关联在一起的唯一标识符。只读 label string 在界面中使用的、人类可读的设置标签。只读 descr... 7 个月前
  104. 104 配送方式 # 配送方式 API 允许您查看单个配送方式。 配送方式属性 属性 类型 描述 id string 方法 ID。只读 title string 配送方式标题。只读 description string 配送方式描述。只... 7 个月前
  105. 105 配送区域位置 # 配送区域位置 API 允许您查看和批量更新配送区域的位置。 配送位置属性 属性 类型 描述 code string 配送区域位置代码。 type string 配送区域位置类型。选项： postcode、 stat... 7 个月前
  106. 106 Shipping zone methods # The shipping zone methods API allows you to create, view, update, and delete individual methods of a shippi... 7 个月前
  107. 107 配送区域 # 配送区域 API 允许您创建、查看、更新和删除单个配送区域。 配送区域属性 属性 类型 描述 id integer 资源的唯一标识符。只读 name string 配送区域名称。必填 order integer 配... 7 个月前
  108. 108 System status tools # The system status tools API allows you to view and run tools from system status. System status tool propert... 7 个月前
  109. 109 System status # The system status API allows you to view all system status items. System status properties Attribute Type D... 7 个月前
  110. 110 税率类别 # 税率类别 API 允许您创建、查看和删除单个税率类别。 税率类别属性 属性 类型 描述 slug string 资源的唯一标识符。只读 name string 税率类别名称。必需 创建税率类别 此 API 可帮助您... 7 个月前
  111. 111 税率 # 税率 API 允许您创建、查看、更新和删除单个税率或批量税率。 税率属性 Attribute Type Description id integer Unique identifier for the resour... 7 个月前
  112. 112 Webhooks # Webhooks API 允许您创建、查看、更新和删除单个或批量 Webhook。 Webhook 可以通过 WooCommerce 设置界面或使用 REST API 端点进行管理。 WC_Webhook 类负责管... 7 个月前