Woocommerce REST API

WooCommerce REST API

API version: v3

Auth

Bearer basic

Base URL

https://example-woocommerce-shop.com/wp-json/wc/v3

Setup

1. Set Authorization header with your Bearer token
2. GET /customers -- verify access
3. POST /customers -- create first customers

Endpoints

122 endpoints across 11 groups. See references/api-spec.lap for full details.

customers

products

orders

reports

coupons

settings

shipping

payment_gateways

taxes

webhooks

system_status

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a customer?" -> POST /customers
• "Search customers?" -> GET /customers
• "Get customer details?" -> GET /customers/{customerId}
• "Update a customer?" -> PUT /customers/{customerId}
• "Delete a customer?" -> DELETE /customers/{customerId}
• "Create a batch?" -> POST /customers/batch
• "Create a product?" -> POST /products
• "Search products?" -> GET /products
• "Get product details?" -> GET /products/{productId}
• "Update a product?" -> PUT /products/{productId}
• "Delete a product?" -> DELETE /products/{productId}
• "Create a duplicate?" -> POST /products/{productId}/duplicate
• "Create a batch?" -> POST /products/batch
• "Create a variation?" -> POST /products/{productId}/variations
• "Search variations?" -> GET /products/{productId}/variations
• "Get variation details?" -> GET /products/{productId}/variations/{variationId}
• "Update a variation?" -> PUT /products/{productId}/variations/{variationId}
• "Delete a variation?" -> DELETE /products/{productId}/variations/{variationId}
• "Create a batch?" -> POST /products/{productId}/variations/batch
• "List all attributes?" -> GET /products/attributes
• "Create a attribute?" -> POST /products/attributes
• "Get attribute details?" -> GET /products/attributes/{attributeId}
• "Update a attribute?" -> PUT /products/attributes/{attributeId}
• "Delete a attribute?" -> DELETE /products/attributes/{attributeId}
• "Create a batch?" -> POST /products/attributes/batch
• "Search terms?" -> GET /products/attributes/{attributeId}/terms
• "Create a term?" -> POST /products/attributes/{attributeId}/terms
• "Get term details?" -> GET /products/attributes/{attributeId}/terms/{termId}
• "Update a term?" -> PUT /products/attributes/{attributeId}/terms/{termId}
• "Delete a term?" -> DELETE /products/attributes/{attributeId}/terms/{termId}
• "Create a batch?" -> POST /products/attributes/{attributeId}/terms/batch
• "Create a category?" -> POST /products/categories
• "Search categories?" -> GET /products/categories
• "Get category details?" -> GET /products/categories/{categoryId}
• "Update a category?" -> PUT /products/categories/{categoryId}
• "Delete a category?" -> DELETE /products/categories/{categoryId}
• "Create a batch?" -> POST /products/categories/batch
• "Search shipping-classes?" -> GET /products/shipping-classes
• "Create a shipping-class?" -> POST /products/shipping-classes
• "Get shipping-class details?" -> GET /products/shipping-classes/{classId}
• "Update a shipping-class?" -> PUT /products/shipping-classes/{classId}
• "Delete a shipping-class?" -> DELETE /products/shipping-classes/{classId}
• "Create a batch?" -> POST /products/shipping-classes/batch
• "Create a tag?" -> POST /products/tags
• "Search tags?" -> GET /products/tags
• "Get tag details?" -> GET /products/tags/{tagId}
• "Update a tag?" -> PUT /products/tags/{tagId}
• "Delete a tag?" -> DELETE /products/tags/{tagId}
• "Create a batch?" -> POST /products/tags/batch
• "Create a order?" -> POST /orders
• "Search orders?" -> GET /orders
• "Get order details?" -> GET /orders/{orderId}
• "Update a order?" -> PUT /orders/{orderId}
• "Delete a order?" -> DELETE /orders/{orderId}
• "Create a batch?" -> POST /orders/batch
• "List all notes?" -> GET /orders/{orderId}/notes
• "Create a note?" -> POST /orders/{orderId}/notes
• "Get note details?" -> GET /orders/{orderId}/notes/{noteId}
• "Delete a note?" -> DELETE /orders/{orderId}/notes/{noteId}
• "Search reviews?" -> GET /products/reviews
• "Create a review?" -> POST /products/reviews
• "Get review details?" -> GET /products/reviews/{reviewId}
• "Update a review?" -> PUT /products/reviews/{reviewId}
• "Delete a review?" -> DELETE /products/reviews/{reviewId}
• "Create a batch?" -> POST /products/reviews/batch
• "List all reports?" -> GET /reports
• "List all top_sellers?" -> GET /reports/top_sellers
• "List all totals?" -> GET /reports/coupons/totals
• "List all totals?" -> GET /reports/customers/totals
• "List all totals?" -> GET /reports/orders/totals
• "List all totals?" -> GET /reports/products/totals
• "List all totals?" -> GET /reports/reviews/totals
• "List all sales?" -> GET /reports/sales
• "List all refunds?" -> GET /orders/{orderId}/refunds
• "Create a refund?" -> POST /orders/{orderId}/refunds
• "Get refund details?" -> GET /orders/{orderId}/refunds/{refundId}
• "Delete a refund?" -> DELETE /orders/{orderId}/refunds/{refundId}
• "Search coupons?" -> GET /coupons
• "Create a coupon?" -> POST /coupons
• "Get coupon details?" -> GET /coupons/{couponId}
• "Update a coupon?" -> PUT /coupons/{couponId}
• "Delete a coupon?" -> DELETE /coupons/{couponId}
• "Create a batch?" -> POST /coupons/batch
• "List all settings?" -> GET /settings
• "Get setting details?" -> GET /settings/{groupId}
• "Get setting details?" -> GET /settings/{groupId}/{id}
• "Update a setting?" -> PUT /settings/{groupId}/{id}
• "List all zones?" -> GET /shipping/zones
• "Create a zone?" -> POST /shipping/zones
• "Get zone details?" -> GET /shipping/zones/{id}
• "Update a zone?" -> PUT /shipping/zones/{id}
• "Delete a zone?" -> DELETE /shipping/zones/{id}
• "List all locations?" -> GET /shipping/zones/{id}/locations
• "List all methods?" -> GET /shipping/zones/{id}/methods
• "Create a method?" -> POST /shipping/zones/{id}/methods
• "Get method details?" -> GET /shipping/zones/{id}/methods/{instanceId}
• "Update a method?" -> PUT /shipping/zones/{id}/methods/{instanceId}
• "Delete a method?" -> DELETE /shipping/zones/{id}/methods/{instanceId}
• "List all payment_gateways?" -> GET /payment_gateways
• "Get payment_gateway details?" -> GET /payment_gateways/{id}
• "Update a payment_gateway?" -> PUT /payment_gateways/{id}
• "Search taxes?" -> GET /taxes
• "Create a taxe?" -> POST /taxes
• "Get taxe details?" -> GET /taxes/{id}
• "Update a taxe?" -> PUT /taxes/{id}
• "Delete a taxe?" -> DELETE /taxes/{id}
• "Create a batch?" -> POST /taxes/batch
• "List all classes?" -> GET /taxes/classes
• "Create a class?" -> POST /taxes/classes
• "Get class details?" -> GET /taxes/classes/{slug}
• "Delete a class?" -> DELETE /taxes/classes/{slug}
• "Search webhooks?" -> GET /webhooks
• "Create a webhook?" -> POST /webhooks
• "Get webhook details?" -> GET /webhooks/{id}
• "Update a webhook?" -> PUT /webhooks/{id}
• "Delete a webhook?" -> DELETE /webhooks/{id}
• "Create a batch?" -> POST /webhooks/batch
• "List all system_status?" -> GET /system_status
• "List all tools?" -> GET /system_status/tools
• "Get tool details?" -> GET /system_status/tools/{id}
• "Update a tool?" -> PUT /system_status/tools/{id}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP