moxie-lean / woocommerce-api

此包的最新版本(0.2.5)没有提供许可证信息。

Lean生态系统中的Woocommerce API端点。

安装: 54

依赖: 0

建议者: 0

安全: 0

类型:wordpress-plugin

0.2.5 2016-09-20 16:07 UTC

This package is auto-updated.

Last update: 2024-08-28 10:29:52 UTC


README

描述:Lean的Woocommerce API端点。状态:开发中。

版本:0.1.0

入门

待办事项

端点

/ecommerce/cart

GET - 获取当前用户的购物车。

POST - 向用户的购物车添加产品。需要将 product_id 作为url参数指定。

DELETE - 从购物车中删除产品。必须将 item_key 作为url参数指定。

/ecommerce/order

GET - 获取所有已登录用户的订单。如果用户未登录,则返回空数组。

POST - 使用当前用户的购物车创建订单。返回创建的订单或错误。

/ecommerce/checkout

POST - 需要在URL中提供 order_id 参数。此端点尝试对作为参数传递的订单进行支付。

/ecommerce/products

GET - 获取数组中的所有产品。

注意:请阅读以下注意事项。

  1. 用户必须是订单的所有者,或者它应该是一个客户订单。
  2. 插件将尝试在您的WP仪表板中配置的第一个活动支付网关。
  3. 根据使用的网关,可能需要更多信息。如果支付失败,则应在仪表板的订单面板中提供更多信息。

错误代码

API可以返回一些自定义错误。您可以在以下位置找到这些错误的解释。此外,所有错误响应都应显示额外的消息,以便更好地理解问题。

  • method_not_registered - 这意味着您正在尝试使用不允许的方法。例如,如果端点仅接受 POST 而您发送了 GET

  • request_error - 这意味着您的请求无法完成。这通常发生在您遗漏参数或未满足此请求的要求时。更多信息可以在响应消息中找到。

  • bad_configured - 这意味着,在Wordpress管理面板中需要做一些配置。

  • bad_permissions - 这意味着,用户没有权限执行所需操作。

  • internal_error - 这意味着,服务器出现了一些问题,但我们没有更多信息。服务器日志和/或Woocommerce日志应提供更多信息。

钩子

您可以使用以下操作来添加此插件的功能。

操作

ln_wc_pre_order

在创建订单之前调用。

参数

$request;   // WP_REST_Request.
$cart;      // WC_Cart Cart instance.
ln_wc_after_order

在创建订单后调用。

$request;   // WP_REST_Request.
$order;     // WC_Order Order instance after it has been created.
ln_wc_pre_update_guest_order

在更新订单的发货/账单地址之前调用(仅限客户购买)。

$request;   // WP_REST_Request.
$order;     // WC_Order Order instance.
ln_wc_after_update_guest_order

在更新订单的发货/账单地址之后调用(仅限客户购买)。

$request;   // WP_REST_Request.
$order;     // WC_Order Order instance.
ln_wc_pre_checkout

在处理支付之前调用。您可以使用此钩子,例如,在 $_POST 对象上加载一些信息。

$order_id;     // int Order id.
ln_wc_after_checkout

在处理支付后调用。

$order_id;     // int Order id.

过滤器