Documentation is still being updated. Some content maybe unfinished.
JWT Authentication
API v1 (Deprecated in future)
API v2
- Error codes
- Variation Examples
- GETMy AccountNew
- POSTEdit AccountNew
- GETOrdersNew
- GETSingle OrderNew
- GETSingle Order - DownloadsNew
- GETDownloadsNew
- GETMy ReviewsNew
- GETSubscriptionsNew
- GETSingle SubscriptionNew
- POSTToggle Subscription Auto-RenewalNew
- POSTSuspend SubscriptionNew
- POSTReactivate SubscriptionNew
- POSTResubscribe to SubscriptionNew
- POSTCancel SubscriptionNew
- POSTUpdate Subscription Payment MethodNew
Error
A valid request URL is required to generate request examples{
"order_id": 789,
"order_number": "789",
"order_parent": 0,
"order_date": "December 15, 2024, 2:20 pm",
"order_status": "Completed",
"order_currency": "USD",
"billing_address": "John Doe, 123 Main St, Apt 4B, Anytown, CA, 12345, US",
"shipping_address": "John Doe, 123 Main St, Apt 4B, Anytown, CA, 12345, US",
"phone": "+1234567890",
"email": "john@example.com",
"ship_to_billing": false,
"items": [
{
"item_id": 1,
"product_id": 456,
"variation_id": 0,
"product_image": "https://example.com/wp-content/uploads/product.jpg",
"product_name": "Premium T-Shirt",
"product_title": "Premium T-Shirt",
"product_type": "simple",
"sku": "TSHIRT-001",
"quantity": "2",
"subtotal": "$39.98",
"purchase_note": "",
"refunded_qty": "0",
"meta": {},
"link": "https://example.com/wp-json/cocart/preview/products/456"
}
],
"totals": {
"subtotal": {
"label": "Subtotal",
"value": "$39.98"
},
"shipping": {
"label": "Shipping",
"value": "$5.00"
},
"total": {
"label": "Total",
"value": "$44.98"
}
},
"order_note": "Please leave at the door",
"order_notes": [
{
"date": "December 15, 2024, 2:25 pm",
"note": "Your order has been shipped"
}
],
"downloads": [],
"order_actions": {
"view": {
"url": "https://example.com/wp-json/cocart/preview/my-account/orders/789",
"name": "View"
}
}
}My Account - Get Single Order
Retrieve detailed information about a specific customer order
GET
/
my-account
/
orders
/
{id}
Error
A valid request URL is required to generate request examples{
"order_id": 789,
"order_number": "789",
"order_parent": 0,
"order_date": "December 15, 2024, 2:20 pm",
"order_status": "Completed",
"order_currency": "USD",
"billing_address": "John Doe, 123 Main St, Apt 4B, Anytown, CA, 12345, US",
"shipping_address": "John Doe, 123 Main St, Apt 4B, Anytown, CA, 12345, US",
"phone": "+1234567890",
"email": "john@example.com",
"ship_to_billing": false,
"items": [
{
"item_id": 1,
"product_id": 456,
"variation_id": 0,
"product_image": "https://example.com/wp-content/uploads/product.jpg",
"product_name": "Premium T-Shirt",
"product_title": "Premium T-Shirt",
"product_type": "simple",
"sku": "TSHIRT-001",
"quantity": "2",
"subtotal": "$39.98",
"purchase_note": "",
"refunded_qty": "0",
"meta": {},
"link": "https://example.com/wp-json/cocart/preview/products/456"
}
],
"totals": {
"subtotal": {
"label": "Subtotal",
"value": "$39.98"
},
"shipping": {
"label": "Shipping",
"value": "$5.00"
},
"total": {
"label": "Total",
"value": "$44.98"
}
},
"order_note": "Please leave at the door",
"order_notes": [
{
"date": "December 15, 2024, 2:25 pm",
"note": "Your order has been shipped"
}
],
"downloads": [],
"order_actions": {
"view": {
"url": "https://example.com/wp-json/cocart/preview/my-account/orders/789",
"name": "View"
}
}
}This endpoint is currently shown as a preview of what’s currently in development and is subject to change.
As WooCommerce sends customers an email of the order review, you could use this endpoint to allow customers to return and view their full order without authorization so long as the order ID and order billing email address match. This is useful for guest checkouts.
If the endpoint is accessed with authentication, the order ID must belong to the authenticated user. The billing email address is not required in this case.
Path Parameters
Unique identifier for the order
Query Parameters
The orders billing email address
Response
Order details retrieved successfully
Order ID
Order number
Parent order ID
Order date
Order status
Order currency
Formatted billing address as comma-separated string (br tags replaced with commas)
Formatted shipping address as comma-separated string (br tags replaced with commas)
Phone number
Email address
Whether shipping to billing address
List of order items (converted from object to array)
Show child attributes
Show child attributes
Order totals with renamed keys (cart_subtotal→subtotal, order_subtotal→total)
Show child attributes
Show child attributes
Customer order note
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I