WooCommerce
2026-03-25
新闻来源:网淘吧
围观:86
电脑广告
手机广告
WooCommerce
通过托管的OAuth认证访问WooCommerce REST API。管理产品、订单、客户、优惠券、配送、税费等电子商务运营操作。
快速开始
# 列出产品
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
基础URL
https://gateway.maton.ai/woocommerce/{native-api-path}
替换{native-api-path}为实际的WooCommerce API端点路径。网关将请求代理到您的WooCommerce商店并自动处理身份验证。
身份验证
所有请求都要求在Authorization头部中包含Maton API密钥:
Authorization: Bearer $MATON_API_KEY
环境变量:将您的API密钥设置为MATON_API_KEY:
export MATON_API_KEY="YOUR_API_KEY"
获取您的API密钥
连接管理
在以下地址管理您的WooCommerce OAuth连接https://ctrl.maton.ai。
列出连接
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections?app=woocommerce&status=ACTIVE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
创建连接
python <<'EOF'
import urllib.request, os, json
data = json.dumps({'app': 'woocommerce'}).encode()
req = urllib.request.Request('https://ctrl.maton.ai/connections', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
获取连接
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
响应:
{
"connection": {
"connection_id": "21fd90f9-5935-43cd-b6c8-bde9d915ca80",
"status": "ACTIVE",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=...",
"app": "woocommerce",
"metadata": {}
}
}
在浏览器中打开返回的URL以完成OAuth授权。
删除连接
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}', method='DELETE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
指定连接
如果您有多个WooCommerce连接,请使用Maton-Connection请求头来指定要使用哪一个。
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Maton-Connection', '21fd90f9-5935-43cd-b6c8-bde9d915ca80')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
如果省略,网关将使用默认(最早)的活动连接。
API 参考
产品
列出所有产品
GET /woocommerce/wp-json/wc/v3/products
查询参数:
page- 当前页码(默认值:1)per_page- 每页项目数(默认值:10,最大值:100)search- 按产品名称搜索status- 按状态筛选:draft、pending、private、publish类型- 按类型筛选:简单产品、分组产品、外部产品、可变产品SKU- 按SKU筛选分类- 按分类ID筛选标签- 按标签ID筛选精选- 筛选精选产品促销中- 筛选促销产品最低价格/最高价格- 按价格范围筛选库存状态- 按库存状态筛选:有货,缺货,预售排序方式- 排序依据:日期,ID,包含,标题,别名,价格,人气,评分排序- 排序方式:升序,降序
示例:
curl -s -X GET "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products?per_page=20&status=publish" -H "Authorization: Bearer $MATON_API_KEY"
响应:
[
{
"id": 123,
"name": "高级T恤",
"slug": "premium-t-shirt",
"type": "simple",
"status": "publish",
"sku": "TSH-001",
"price": "29.99",
"regular_price": "34.99",
"sale_price": "29.99",
"stock_quantity": 50,
"stock_status": "instock",
"categories": [{"id": 15, "name": "服饰"}],
"images": [{"id": 456, "src": "https://..."}]
}
]
获取单个商品
GET /woocommerce/wp-json/wc/v3/products/{id}
示例:
curl -s -X GET "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products/123" -H "Authorization: Bearer $MATON_API_KEY"
创建商品
POST /woocommerce/wp-json/wc/v3/products
Content-Type: application/json
{
"name": "新产品",
"type": "simple",
"regular_price": "49.99",
"description": "完整商品描述",
"short_description": "简短描述",
"sku": "PROD-001",
"manage_stock": true,
"stock_quantity": 100,
"categories": [{"id": 15}],
"images": [{"src": "https://example.com/image.jpg"}]
}
示例:
curl -s -X POST "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products" -H "Content-Type: application/json" -H "Authorization: Bearer $MATON_API_KEY" -d '{"name": "高级小部件", "type": "simple", "regular_price": "19.99", "sku": "WDG-001"}'
更新商品
PUT /woocommerce/wp-json/wc/v3/products/{id}
示例:
curl -s -X PUT "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products/123" -H "Content-Type: application/json" -H "Authorization: Bearer $MATON_API_KEY" -d '{"regular_price": "24.99", "sale_price": "19.99"}'
删除产品
DELETE /woocommerce/wp-json/wc/v3/products/{id}
查询参数:
force- 设置为true以永久删除(默认值为false将移至回收站)
复制产品
POST /woocommerce/wp-json/wc/v3/products/{id}/duplicate
产品变体
对于可变产品,管理单个变体:
列出变体
GET /woocommerce/wp-json/wc/v3/products/{product_id}/variations
创建变体
POST /woocommerce/wp-json/wc/v3/products/{product_id}/variations
Content-Type: application/json
{
"regular_price": "29.99",
"sku": "TSH-001-RED-M",
"attributes": [
{"id": 1, "option": "Red"},
{"id": 2, "option": "Medium"}
]
}
更新变体
PUT /woocommerce/wp-json/wc/v3/products/{product_id}/variations/{id}
删除变体
DELETE /woocommerce/wp-json/wc/v3/products/{product_id}/variations/{id}
批量更新变体
POST /woocommerce/wp-json/wc/v3/products/{product_id}/variations/batch
产品属性
列出属性
GET /woocommerce/wp-json/wc/v3/products/attributes
创建属性
POST /woocommerce/wp-json/wc/v3/products/attributes
Content-Type: application/json
{
"name": "颜色",
"slug": "color",
"type": "select",
"order_by": "menu_order"
}
获取/更新/删除属性
GET /woocommerce/wp-json/wc/v3/products/attributes/{id}
PUT /woocommerce/wp-json/wc/v3/products/attributes/{id}
DELETE /woocommerce/wp-json/wc/v3/products/attributes/{id}
属性术语
GET /woocommerce/wp-json/wc/v3/products/attributes/{attribute_id}/terms
POST /woocommerce/wp-json/wc/v3/products/attributes/{attribute_id}/terms
GET /woocommerce/wp-json/wc/v3/products/attributes/{attribute_id}/terms/{id}
PUT /woocommerce/wp-json/wc/v3/products/attributes/{attribute_id}/terms/{id}
DELETE /woocommerce/wp-json/wc/v3/products/attributes/{attribute_id}/terms/{id}
产品分类
列出分类
GET /woocommerce/wp-json/wc/v3/products/categories
创建分类
POST /woocommerce/wp-json/wc/v3/products/categories
Content-Type: application/json
{
"name": "电子产品",
"parent": 0,
"description": "电子产品"
}
获取/更新/删除分类
GET /woocommerce/wp-json/wc/v3/products/categories/{id}
PUT /woocommerce/wp-json/wc/v3/products/categories/{id}
DELETE /woocommerce/wp-json/wc/v3/products/categories/{id}
产品标签
GET /woocommerce/wp-json/wc/v3/products/tags
POST /woocommerce/wp-json/wc/v3/products/tags
GET /woocommerce/wp-json/wc/v3/products/tags/{id}
PUT /woocommerce/wp-json/wc/v3/products/tags/{id}
DELETE /woocommerce/wp-json/wc/v3/products/tags/{id}
产品配送类别
获取 /woocommerce/wp-json/wc/v3/products/shipping_classes
创建 /woocommerce/wp-json/wc/v3/products/shipping_classes
获取 /woocommerce/wp-json/wc/v3/products/shipping_classes/{id}
更新 /woocommerce/wp-json/wc/v3/products/shipping_classes/{id}
删除 /woocommerce/wp-json/wc/v3/products/shipping_classes/{id}
商品评价
列出评价
获取 /woocommerce/wp-json/wc/v3/products/reviews
查询参数:
product- 按商品ID筛选status- 按状态筛选:approved、hold、spam、trash
创建评价
创建 /woocommerce/wp-json/wc/v3/products/reviews
内容类型:application/json
{
"product_id": 123,
"review": "商品很棒!",
"reviewer": "张三",
"reviewer_email": "john@example.com",
"rating": 5
}
获取/更新/删除评价
获取 /woocommerce/wp-json/wc/v3/products/reviews/{id}
更新 /woocommerce/wp-json/wc/v3/products/reviews/{id}
删除 /woocommerce/wp-json/wc/v3/products/reviews/{id}
订单
列出所有订单
获取 /woocommerce/wp-json/wc/v3/orders
查询参数:
页- 当前页(默认值:1)每页数量- 每页项目数(默认值:10)搜索- 搜索订单之后/之前- 按日期筛选(ISO8601格式)状态- 订单状态(见下文)客户- 按客户ID筛选产品- 按产品ID筛选排序依据- 排序方式:日期,ID,包含,标题,slugorder- 排序方式:asc,desc
订单状态:
pending- 待支付processing- 已收款,待履约on-hold- 等待支付确认completed- 订单已完成cancelled- 已被管理员或客户取消refunded- 已全额退款failed- 支付失败
示例:
curl -s -X GET "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/orders?status=processing&per_page=50" -H "Authorization: Bearer $MATON_API_KEY"
响应:
[
{
"id": 456,
"status": "processing",
"currency": "USD",
"total": "129.99",
"customer_id": 12,
"billing": {
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com"
},
"line_items": [
{
"id": 789,
"product_id": 123,
"name": "Premium T-Shirt",
"quantity": 2,
"total": "59.98"
}
]
}
]
获取订单
GET /woocommerce/wp-json/wc/v3/orders/{id}
创建订单
POST /woocommerce/wp-json/wc/v3/orders
Content-Type: application/json
{
"payment_method": "stripe",
"payment_method_title": "Credit Card",
"set_paid": true,
"billing": {
"first_name": "John",
"last_name": "Doe",
"address_1": "123 Main St",
"city": "Anytown",
"state": "CA",
"postcode": "12345",
"country": "US",
"email": "john@example.com",
"phone": "555-1234"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"address_1": "123 Main St",
"city": "Anytown",
"state": "CA",
"postcode": "12345",
"country": "US"
},
"line_items": [
{
"product_id": 123,
"quantity": 2
}
]
}
更新订单
PUT /woocommerce/wp-json/wc/v3/orders/{id}
示例 - 更新订单状态:
curl -s -X PUT "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/orders/456" -H "Content-Type: application/json" -H "Authorization: Bearer $MATON_API_KEY" -d '{"status": "completed"}'
删除订单
DELETE /woocommerce/wp-json/wc/v3/orders/{id}
订单备注
列出订单备注
GET /woocommerce/wp-json/wc/v3/orders/{order_id}/notes
创建订单备注
POST /woocommerce/wp-json/wc/v3/orders/{order_id}/notes
Content-Type: application/json
{
"note": "订单已通过FedEx发货,追踪号 #12345",
"customer_note": true
}
customer_note: 设置为true可使备注对客户可见
获取/删除订单备注
GET /woocommerce/wp-json/wc/v3/orders/{order_id}/notes/{id}
DELETE /woocommerce/wp-json/wc/v3/orders/{order_id}/notes/{id}
订单退款
列出退款
GET /woocommerce/wp-json/wc/v3/orders/{order_id}/refunds
创建退款
POST /woocommerce/wp-json/wc/v3/orders/{order_id}/refunds
Content-Type: application/json
{
"amount": "25.00",
"reason": "产品在运输过程中损坏",
"api_refund": true
}
api_refund:设置为true以通过支付网关处理退款
获取/删除退款
GET /woocommerce/wp-json/wc/v3/orders/{order_id}/refunds/{id}
DELETE /woocommerce/wp-json/wc/v3/orders/{order_id}/refunds/{id}
客户
列出所有客户
GET /woocommerce/wp-json/wc/v3/customers
查询参数:
page- 当前页数(默认值:1)per_page- 每页项目数(默认值:10)search- 按姓名或电子邮件搜索email- 按精确电子邮件筛选role- 按角色筛选:all,管理员,客户,店铺管理员排序依据- 排序方式:ID,包含,姓名,注册日期排序- 排序顺序:升序,降序
示例:
curl -s -X GET "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/customers?per_page=25" -H "Authorization: Bearer $MATON_API_KEY"
响应:
[
{
"id": 12,
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"username": "johndoe",
"billing": {
"first_name": "John",
"last_name": "Doe",
"address_1": "123 Main St",
"city": "Anytown",
"state": "CA",
"postcode": "12345",
"country": "US",
"email": "john@example.com",
"phone": "555-1234"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"address_1": "123 Main St",
"city": "Anytown",
"state": "CA",
"postcode": "12345",
"country": "US"
}
}
]
获取客户
GET /woocommerce/wp-json/wc/v3/customers/{id}
创建客户
POST /woocommerce/wp-json/wc/v3/customers
Content-Type: application/json
{
"email": "jane@example.com",
"first_name": "Jane",
"last_name": "Smith",
"username": "janesmith",
"password": "secure_password",
"billing": {
"first_name": "Jane",
"last_name": "Smith",
"address_1": "456 Oak Ave",
"city": "Springfield",
"state": "IL",
"postcode": "62701",
"country": "US",
"email": "jane@example.com",
"phone": "555-5678"
}
}
更新客户
PUT /woocommerce/wp-json/wc/v3/customers/{id}
删除客户
DELETE /woocommerce/wp-json/wc/v3/customers/{id}
客户下载
GET /woocommerce/wp-json/wc/v3/customers/{customer_id}/downloads
返回客户有权访问的可下载产品。
优惠券
列出所有优惠券
GET /woocommerce/wp-json/wc/v3/coupons
查询参数:
page- 当前页码(默认:1)per_page- 每页项目数(默认:10)search- 搜索优惠券code- 按优惠券代码筛选
获取优惠券
GET /woocommerce/wp-json/wc/v3/coupons/{id}
创建一个优惠券
POST /woocommerce/wp-json/wc/v3/coupons
Content-Type: application/json
{
"code": "SUMMER2024",
"discount_type": "percent",
"amount": "15",
"description": "夏季促销 - 15% 折扣",
"date_expires": "2024-08-31T23:59:59",
"individual_use": true,
"usage_limit": 100,
"usage_limit_per_user": 1,
"minimum_amount": "50.00",
"maximum_amount": "500.00",
"free_shipping": false,
"exclude_sale_items": true
}
折扣类型:
percent- 百分比折扣fixed_cart- 整个购物车固定金额减免fixed_product- 每件商品固定金额减免
优惠券属性:
code- 优惠券代码(必需)amount- 折扣金额discount_type- 折扣类型description- 优惠券描述date_expires- 过期日期 (ISO8601)individual_use- 不能与其他优惠券组合使用product_ids- 优惠券适用的产品ID数组excluded_product_ids- 排除的产品ID数组使用限制次数- 优惠券可使用的总次数每个用户的使用限制- 每位顾客的使用限制限制适用于X件商品- 折扣适用的最大商品数量免运费- 启用免运费产品分类- 分类ID数组排除的产品分类- 排除的分类ID数组排除特价商品- 折扣不适用于特价商品最低金额- 购物车所需最低总额最高金额- 购物车允许的最高总额邮箱限制- 允许的邮箱地址数组
更新优惠券
PUT /woocommerce/wp-json/wc/v3/coupons/{id}
删除优惠券
DELETE /woocommerce/wp-json/wc/v3/coupons/{id}
税费
税率
GET /woocommerce/wp-json/wc/v3/taxes
POST /woocommerce/wp-json/wc/v3/taxes
GET /woocommerce/wp-json/wc/v3/taxes/{id}
PUT /woocommerce/wp-json/wc/v3/taxes/{id}
DELETE /woocommerce/wp-json/wc/v3/taxes/{id}
POST /woocommerce/wp-json/wc/v3/taxes/batch
创建税率示例:
curl -s -X POST "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/taxes" -H "Content-Type: application/json" -H "Authorization: Bearer $MATON_API_KEY" -d '{"country": "US", "state": "CA", "rate": "7.25", "name": "CA State Tax", "shipping": true}'
税种分类
GET /woocommerce/wp-json/wc/v3/taxes/classes
POST /woocommerce/wp-json/wc/v3/taxes/classes
DELETE /woocommerce/wp-json/wc/v3/taxes/classes/{slug}
配送
配送区域
GET /woocommerce/wp-json/wc/v3/shipping/zones
POST /woocommerce/wp-json/wc/v3/shipping/zones
GET /woocommerce/wp-json/wc/v3/shipping/zones/{id}
PUT /woocommerce/wp-json/wc/v3/shipping/zones/{id}
DELETE /woocommerce/wp-json/wc/v3/shipping/zones/{id}
创建配送区域示例:
curl -s -X POST "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/shipping/zones" -H "Content-Type: application/json" -H "Authorization: Bearer $MATON_API_KEY" -d '{"name": "US West Coast", "order": 1}'
配送区域位置
GET /woocommerce/wp-json/wc/v3/shipping/zones/{zone_id}/locations
PUT /woocommerce/wp-json/wc/v3/shipping/zones/{zone_id}/locations
更新区域位置示例:
curl -s -X PUT "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/shipping/zones/1/locations" -H "Content-Type: application/json" -H "Authorization: Bearer $MATON_API_KEY" -d '[{"code": "US:CA", "type": "state"}, {"code": "US:OR", "type": "state"}, {"code": "US:WA", "type": "state"}]'
配送区域方法
GET /woocommerce/wp-json/wc/v3/shipping/zones/{zone_id}/methods
POST /woocommerce/wp-json/wc/v3/shipping/zones/{zone_id}/methods
GET /woocommerce/wp-json/wc/v3/shipping/zones/{zone_id}/methods/{id}
PUT /woocommerce/wp-json/wc/v3/shipping/zones/{zone_id}/methods/{id}
DELETE /woocommerce/wp-json/wc/v3/shipping/zones/{zone_id}/methods/{id}
配送方法(全局)
GET /woocommerce/wp-json/wc/v3/shipping_methods
GET /woocommerce/wp-json/wc/v3/shipping_methods/{id}
支付网关
GET /woocommerce/wp-json/wc/v3/payment_gateways
GET /woocommerce/wp-json/wc/v3/payment_gateways/{id}
PUT /woocommerce/wp-json/wc/v3/payment_gateways/{id}
示例 - 启用支付网关:
curl -s -X PUT "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/payment_gateways/stripe" -H "Content-Type: application/json" -H "Authorization: Bearer $MATON_API_KEY" -d '{"enabled": true}'
设置
列出设置组
GET /woocommerce/wp-json/wc/v3/settings
列出组内设置
GET /woocommerce/wp-json/wc/v3/settings/{group}
常见组:general、products、tax、shipping、checkout、account、email
获取/更新设置
GET /woocommerce/wp-json/wc/v3/settings/{group}/{id}
PUT /woocommerce/wp-json/wc/v3/settings/{group}/{id}
示例 - 更新商店地址:
curl -s -X PUT "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/settings/general/woocommerce_store_address" -H "Content-Type: application/json" -H "Authorization: Bearer $MATON_API_KEY" -d '{"value": "123 Commerce St"}'
批量更新设置
POST /woocommerce/wp-json/wc/v3/settings/{group}/batch
Webhooks
列出所有Webhooks
GET /woocommerce/wp-json/wc/v3/webhooks
创建Webhook
POST /woocommerce/wp-json/wc/v3/webhooks
Content-Type: application/json
{
"name": "订单已创建",
"topic": "order.created",
"delivery_url": "https://example.com/webhooks/woocommerce",
"status": "active"
}
Webhook主题:
order.created,order.updated,order.deleted,order.restoredproduct.created,product.updated,product.deleted,产品已恢复客户已创建,客户已更新,客户已删除优惠券已创建,优惠券已更新,优惠券已删除,优惠券已恢复
获取/更新/删除Webhook
GET /woocommerce/wp-json/wc/v3/webhooks/{id}
PUT /woocommerce/wp-json/wc/v3/webhooks/{id}
DELETE /woocommerce/wp-json/wc/v3/webhooks/{id}
报告
列出可用报告
GET /woocommerce/wp-json/wc/v3/reports
销售报告
GET /woocommerce/wp-json/wc/v3/reports/sales
查询参数:
时间段- 报告周期:周,月,上月,年起始日期/截止日期- 自定义日期范围
畅销商品报告
GET /woocommerce/wp-json/wc/v3/reports/top_sellers
优惠券总计
GET /woocommerce/wp-json/wc/v3/reports/coupons/totals
客户总计
GET /woocommerce/wp-json/wc/v3/reports/customers/totals
订单总计
GET /woocommerce/wp-json/wc/v3/reports/orders/totals
产品总计
GET /woocommerce/wp-json/wc/v3/reports/products/totals
评论总计
GET /woocommerce/wp-json/wc/v3/reports/reviews/totals
数据
列出所有数据端点
GET /woocommerce/wp-json/wc/v3/data
大洲
GET /woocommerce/wp-json/wc/v3/data/continents
GET /woocommerce/wp-json/wc/v3/data/continents/{code}
国家/地区
GET /woocommerce/wp-json/wc/v3/data/countries
GET /woocommerce/wp-json/wc/v3/data/countries/{code}
货币
GET /woocommerce/wp-json/wc/v3/data/currencies
GET /woocommerce/wp-json/wc/v3/data/currencies/{code}
GET /woocommerce/wp-json/wc/v3/data/currencies/current
系统状态
GET /woocommerce/wp-json/wc/v3/system_status
GET /woocommerce/wp-json/wc/v3/system_status/tools
POST /woocommerce/wp-json/wc/v3/system_status/tools/{id}
批量操作
大多数资源支持用于创建、更新和删除多个项目的批量操作:
POST /woocommerce/wp-json/wc/v3/{resource}/batch
Content-Type: application/json
{
"create": [
{"name": "新产品 1", "regular_price": "19.99"},
{"name": "新产品 2", "regular_price": "29.99"}
],
"update": [
{"id": 123, "regular_price": "24.99"}
],
"delete": [456, 789]
}
响应:
{
"create": [...],
"update": [...],
"delete": [...]
}
分页
WooCommerce 使用基于页面的分页,并带有响应头:
查询参数:
page- 页码(默认值:1)per_page- 每页项目数(默认值:10,最大值:100)offset- 起始偏移量
响应头:
X-WP-Total- 项目总数X-WP-TotalPages- 总页数Link- 包含下一页、上一页、首页、末页的分页链接
示例:
curl -s -I -X GET "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products?page=2&per_page=25" -H "Authorization: Bearer $MATON_API_KEY"
代码示例
JavaScript
const response = await fetch(
'https://gateway.maton.ai/woocommerce/wp-json/wc/v3/orders?status=processing',
{
headers: {
'Authorization': `Bearer ${process.env.MATON_API_KEY}`
}
}
);
const orders = await response.json();
Python
import os
import requests
response = requests.get(
'https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products',
headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'},
params={'per_page': 50, 'status': 'publish'}
)
products = response.json()
创建包含订单项的订单
import os
import requests
order_data = {
"payment_method": "stripe",
"set_paid": True,
"billing": {
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"address_1": "123 Main St",
"city": "Anytown",
"state": "CA",
"postcode": "12345",
"country": "US"
},
"line_items": [
{"product_id": 123, "quantity": 2},
{"product_id": 456, "quantity": 1}
]
}
response = requests.post(
'https://gateway.maton.ai/woocommerce/wp-json/wc/v3/orders',
headers={
'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}',
'Content-Type': 'application/json'
},
json=order_data
)
order = response.json()
备注
- 所有货币金额均以保留两位小数的字符串形式返回
- 日期采用 ISO8601 格式:
YYYY-MM-DDTHH:MM:SS - 资源 ID 为整数
- API 要求 WordPress 中启用“固定链接”
- 使用
context=edit参数以获取额外的可写字段 - 重要提示:使用 curl 命令时,如果 URL 包含括号(
fields[]、sort[]、records[]),请使用curl -g以禁用通配符解析 - 重要提示:当将 curl 输出通过管道传递给
jq或其他命令时,在某些 shell 环境中,像$MATON_API_KEY这样的环境变量可能无法正确展开。通过管道传递时,您可能会收到“无效 API 密钥”错误。
错误处理
| 状态码 | 含义 |
|---|---|
| 400 | 错误请求或无效数据 |
| 401 | 无效或缺少身份验证 |
| 403 | 禁止访问 - 权限不足 |
| 404 | 未找到资源 |
| 500 | 内部服务器错误 |
错误响应格式:
{
"code": "woocommerce_rest_invalid_id",
"message": "无效的 ID。",
"data": {
"status": 404
}
}
故障排除:API 密钥问题
- 检查
MATON_API_KEY环境变量是否已设置:
echo $MATON_API_KEY
- 通过列出连接来验证 API 密钥是否有效:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
故障排除:无效的应用名称
- 请确保您的 URL 路径以
woocommerce开头。例如:
- 正确:
https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products - 错误:
https://gateway.maton.ai/wp-json/wc/v3/products
资源
概述
产品
订单
客户
优惠券
税费
配送
支付与设置
Webhooks
报告
数据
系统
文章底部电脑广告
手机广告位-内容正文底部
上一篇:Productivity
下一篇:Marketing Skills


微信扫一扫,打赏作者吧~